API Documentation

  • Home
  • ChangeLog
  • Terms of use
  • Swagger UI
  • Account
  • Address
  • Analytic
  • BankAccount
  • Contact
  • Country
  • Currency
  • Customer
  • Dashboard
  • Document
  • DocumentNumbering
  • Employee
  • ExchangeRate
  • Inbox
  • IssuedInvoice
  • IssuedInvoicePosting
  • Item
  • Journal
  • JournalType
  • Order
  • Organisation
  • Outbox
  • PaymentMethod
  • PayrollSettings
  • PostalCode
  • ProductGroup
  • PurposeCode
  • ReceivedInvoice
  • ReportTemplate
  • Stock
  • StockEntry
  • User
  • VatAccountingType
  • VatRate
  • Warehouse

Analytic -> GetAnalytics

Returns all analytics for the given organization.

Request

Relative request path: api/orgs/{organisationId}/analytics

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
SearchStringSearch string - queries search for specified value across various predefined fields.
CurrentPageCurrent page index starting with 1 for first page.
PageSizePage size defines number of records returned per page.
SortFieldField name that is used for sorting/ordering result rows.
OrderSort order: A - ascending; D - descending

Filter options:

    /// Simple search filter.
    public class SimpleSearchFilter
    {
        // Search string - queries search for specified value across various predefined fields.
        public string SearchString { get; set; }
        // Current page index starting with 1 for first page.
        public int CurrentPage { get; set; }
        // Page size defines number of records returned per page.
        public int PageSize { get; set; }
        // Field name that is used for sorting/ordering result rows.
        public string SortField { get; set; }
        // Sort order: A - ascending; D - descending
        public string Order { get; set; }
    
    }

Request parameters:

  • long organisationId - organisation id

Filter options:

    /// Simple search filter.
    class SimpleSearchFilter
    {
        // Search string - queries search for specified value across various predefined fields.
        public $SearchString;
        // Current page index starting with 1 for first page.
        public $CurrentPage;
        // Page size defines number of records returned per page.
        public $PageSize;
        // Field name that is used for sorting/ordering result rows.
        public $SortField;
        // Sort order: A - ascending; D - descending
        public $Order;
    
    }

Request parameters:

  • Int64 organisationId - organisation id

Filter options:

    /// Simple search filter.
    public class SimpleSearchFilter
    {
        // Search string - queries search for specified value across various predefined fields.
        public String SearchString;
        // Current page index starting with 1 for first page.
        public Integer CurrentPage;
        // Page size defines number of records returned per page.
        public Integer PageSize;
        // Field name that is used for sorting/ordering result rows.
        public String SortField;
        // Sort order: A - ascending; D - descending
        public String Order;
    
    }

Request parameters:

  • Long organisationId - organisation id

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
RowsReturned rows. List of AnalyticSearch.
TotalRowsNumber of rows matching search condition.
CurrentPageNumberCurrent page number. Result rows are returned in pages.
PageSizeNumbers of rows returned per page.

This method returns result of type 'SAOP.API.Models.SearchResult`1'.

    /// SearchResult is default return type for all search api methods.
    public class SearchResult<T>
    {
        // Returned rows.
        public T Rows { get; set; }
        // Number of rows matching search condition.
        public long TotalRows { get; set; }
        // Current page number. Result rows are returned in pages.
        public long CurrentPageNumber { get; set; }
        // Numbers of rows returned per page.
        public long PageSize { get; set; }
    
    }

        /// Analytics search result.
        public class AnalyticSearch
        {
            // Analytic id.
            // Ignored on create request.
            public long AnalyticId { get; set; }
            // Analytic code.
            public string Code { get; set; }
            // Analytic name.
            public string Name { get; set; }
            // Usage end date.
            public DateTime? UsageEndDate { get; set; }
            // Parent analytic.
            public mMApiFkField ParentAnalytic { get; set; }
        
        }

            /// Link with id, name and url to related data.
            public class mMApiFkField
            {
                // Record id.
                public long? ID { get; set; }
                // Record name.
                public string Name { get; private set; }
                // Url to full record details.
                public string ResourceUrl { get; private set; }
            
            }

This method returns result of type 'SAOP.API.Models.SearchResult`1'.

    /// SearchResult is default return type for all search api methods.
    class SearchResult
    {
        // Returned rows.
        public $Rows;
        // Number of rows matching search condition.
        public $TotalRows;
        // Current page number. Result rows are returned in pages.
        public $CurrentPageNumber;
        // Numbers of rows returned per page.
        public $PageSize;
    
    }

        /// Analytics search result.
        class AnalyticSearch
        {
            // Analytic id.
            // Ignored on create request.
            public $AnalyticId;
            // Analytic code.
            public $Code;
            // Analytic name.
            public $Name;
            // Usage end date.
            public $UsageEndDate;
            // Parent analytic.
            public $ParentAnalytic;
        
        }

            /// Link with id, name and url to related data.
            class mMApiFkField
            {
                // Record id.
                public $ID;
                // Record name.
                public $Name;
                // Url to full record details.
                public $ResourceUrl;
            
            }

This method returns result of type 'SAOP.API.Models.SearchResult`1'.

    /// SearchResult is default return type for all search api methods.
    public class SearchResultT
    {
        // Returned rows.
        public T Rows;
        // Number of rows matching search condition.
        public Long TotalRows;
        // Current page number. Result rows are returned in pages.
        public Long CurrentPageNumber;
        // Numbers of rows returned per page.
        public Long PageSize;
    
    }

        /// Analytics search result.
        public class AnalyticSearch
        {
            // Analytic id.
            // Ignored on create request.
            public Long AnalyticId;
            // Analytic code.
            public String Code;
            // Analytic name.
            public String Name;
            // Usage end date.
            public Date UsageEndDate;
            // Parent analytic.
            public mMApiFkField ParentAnalytic;
        
        }

            /// Link with id, name and url to related data.
            public class mMApiFkField
            {
                // Record id.
                public Long ID;
                // Record name.
                public String Name;
                // Url to full record details.
                public String ResourceUrl;
            
            }

 
Authorization endpoint : https://moj.minimax.si/SI/AUT/OAuth20
Token endpoint           : https://moj.minimax.si/SI/AUT/OAuth20/Token
Return url                   : https://moj.minimax.si/SI/API/Help/TestClientDialogsAuth
 
URI parameters
=
Headers | Add custom header
: Delete
Body
Samples:
Status
Headers
            
        
Body