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

ReportTemplate -> GetReportTemplates

Returns all report templates.

Request

Relative request path: api/orgs/{organisationId}/report-templates

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationId
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 -

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 -

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 -

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
RowsReturned rows. List of ReportTemplate.
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; }
    
    }

        /// Report template details.
        public class ReportTemplate
        {
            // Report template id.
            // Ignored on create request.
            public long ReportTemplateId { get; set; }
            // Report template name.
            public string Name { get; set; }
            // Report template display type:
            // <ul>
            //     <li>BB - Gross balance</li>
            //     <li>BK - Compensation</li>
            //     <li>DN - Work order</li>
            //     <li>DO - Delivery note</li>
            //     <li>DOP - Calculation sheet</li>
            //     <li>DP – credit note</li>
            //     <li>IN – Issued order</li>
            //     <li>IO – Open items report</li>
            //     <li>IR – Issued invoice</li>
            //     <li>OP - Payment reminder</li>
            //     <li>PL - Salaries, payslips</li>
            //     <li>PN – Received order confirmation</li>
            //     <li>PUPN – proforma invoice with order for payment</li>
            //     <li>UP - Issued invoice with order for payment</li>
            //     <li>ZO - Interest for delay.</li>
            // <ul>

            public string DisplayType { get; set; }
            // Default report template:
            // <ul>
            //     <li>D - Yes,</li>
            //     <li>N - No.</li>
            // <ul>

            public string Default { get; set; }
            public DateTime RecordDtModified { get; set; }
            // Row version is used for concurrency check.
            // Ignored on create request.
            public string RowVersion { get; 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;
    
    }

        /// Report template details.
        class ReportTemplate
        {
            // Report template id.
            // Ignored on create request.
            public $ReportTemplateId;
            // Report template name.
            public $Name;
            // Report template display type:
            // <ul>
            //     <li>BB - Gross balance</li>
            //     <li>BK - Compensation</li>
            //     <li>DN - Work order</li>
            //     <li>DO - Delivery note</li>
            //     <li>DOP - Calculation sheet</li>
            //     <li>DP – credit note</li>
            //     <li>IN – Issued order</li>
            //     <li>IO – Open items report</li>
            //     <li>IR – Issued invoice</li>
            //     <li>OP - Payment reminder</li>
            //     <li>PL - Salaries, payslips</li>
            //     <li>PN – Received order confirmation</li>
            //     <li>PUPN – proforma invoice with order for payment</li>
            //     <li>UP - Issued invoice with order for payment</li>
            //     <li>ZO - Interest for delay.</li>
            // <ul>

            public $DisplayType;
            // Default report template:
            // <ul>
            //     <li>D - Yes,</li>
            //     <li>N - No.</li>
            // <ul>

            public $Default;
            public $RecordDtModified;
            // Row version is used for concurrency check.
            // Ignored on create request.
            public $RowVersion;
        
        }

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;
    
    }

        /// Report template details.
        public class ReportTemplate
        {
            // Report template id.
            // Ignored on create request.
            public Long ReportTemplateId;
            // Report template name.
            public String Name;
            // Report template display type:
            // <ul>
            //     <li>BB - Gross balance</li>
            //     <li>BK - Compensation</li>
            //     <li>DN - Work order</li>
            //     <li>DO - Delivery note</li>
            //     <li>DOP - Calculation sheet</li>
            //     <li>DP – credit note</li>
            //     <li>IN – Issued order</li>
            //     <li>IO – Open items report</li>
            //     <li>IR – Issued invoice</li>
            //     <li>OP - Payment reminder</li>
            //     <li>PL - Salaries, payslips</li>
            //     <li>PN – Received order confirmation</li>
            //     <li>PUPN – proforma invoice with order for payment</li>
            //     <li>UP - Issued invoice with order for payment</li>
            //     <li>ZO - Interest for delay.</li>
            // <ul>

            public String DisplayType;
            // Default report template:
            // <ul>
            //     <li>D - Yes,</li>
            //     <li>N - No.</li>
            // <ul>

            public String Default;
            public Date RecordDtModified;
            // Row version is used for concurrency check.
            // Ignored on create request.
            public String RowVersion;
        
        }

 
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