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

Account -> GetAccounts

Returns all accounts for given organisation.

Request

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

  • 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 Account.
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; }
    
    }

        /// Account details.
        public class Account
        {
            // Account id.
            // Ignored on create request.
            public long AccountId { get; set; }
            // Account code.
            public string Code { get; set; }
            // Account name.
            public string Name { get; set; }
            // Other language account name.
            public string NameInOtherLanguage { get; set; }
            // English account name.
            public string NameInEnglish { get; set; }
            // Account description.
            public string Description { get; set; }
            // Posting side:
            // <ul>
            //     <li>V – debit and credit,</li>
            //     <li>B – only debit,</li>
            //     <li>D – only credit,</li>
            //     <li>N – Posting is not allowed.</li>
            // </ul>

            public string AllowedPosting { get; set; }
            // Account posting:
            // <ul>
            //     <li>N –  No account,</li>
            //     <li>B – debit</li>
            //     <li>D – credit</li>
            // </ul>
            //

            public string InvoiceAccounting { get; set; }
            // Analytics entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public string AnalyticsEntry { get; set; }
            // Employee entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public string EmployeeEntry { get; set; }
            // Customer entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public string CustomerEntry { get; set; }
            // Unrecognized account in terms of tax:
            // <ul>
            //     <li>N – No,</li>
            //     <li>D – Yes.</li>
            // </ul>
            //

            public string NonTaxable { get; set; }
            // Application:
            // <ul>
            //     <li>N – No,</li>
            //     <li>D – Yes.</li>
            // </ul>
            //

            public string Application { get; set; }
            // Account validity from year.
            public int ValidFromYear { get; set; }
            // Account validity to year.
            public int ValidToYear { 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;
    
    }

        /// Account details.
        class Account
        {
            // Account id.
            // Ignored on create request.
            public $AccountId;
            // Account code.
            public $Code;
            // Account name.
            public $Name;
            // Other language account name.
            public $NameInOtherLanguage;
            // English account name.
            public $NameInEnglish;
            // Account description.
            public $Description;
            // Posting side:
            // <ul>
            //     <li>V – debit and credit,</li>
            //     <li>B – only debit,</li>
            //     <li>D – only credit,</li>
            //     <li>N – Posting is not allowed.</li>
            // </ul>

            public $AllowedPosting;
            // Account posting:
            // <ul>
            //     <li>N –  No account,</li>
            //     <li>B – debit</li>
            //     <li>D – credit</li>
            // </ul>
            //

            public $InvoiceAccounting;
            // Analytics entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public $AnalyticsEntry;
            // Employee entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public $EmployeeEntry;
            // Customer entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public $CustomerEntry;
            // Unrecognized account in terms of tax:
            // <ul>
            //     <li>N – No,</li>
            //     <li>D – Yes.</li>
            // </ul>
            //

            public $NonTaxable;
            // Application:
            // <ul>
            //     <li>N – No,</li>
            //     <li>D – Yes.</li>
            // </ul>
            //

            public $Application;
            // Account validity from year.
            public $ValidFromYear;
            // Account validity to year.
            public $ValidToYear;
            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;
    
    }

        /// Account details.
        public class Account
        {
            // Account id.
            // Ignored on create request.
            public Long AccountId;
            // Account code.
            public String Code;
            // Account name.
            public String Name;
            // Other language account name.
            public String NameInOtherLanguage;
            // English account name.
            public String NameInEnglish;
            // Account description.
            public String Description;
            // Posting side:
            // <ul>
            //     <li>V – debit and credit,</li>
            //     <li>B – only debit,</li>
            //     <li>D – only credit,</li>
            //     <li>N – Posting is not allowed.</li>
            // </ul>

            public String AllowedPosting;
            // Account posting:
            // <ul>
            //     <li>N –  No account,</li>
            //     <li>B – debit</li>
            //     <li>D – credit</li>
            // </ul>
            //

            public String InvoiceAccounting;
            // Analytics entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public String AnalyticsEntry;
            // Employee entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public String EmployeeEntry;
            // Customer entry:
            // <ul>
            //     <li>V – Input allowed,</li>
            //     <li>N – Input not allowed,</li>
            //     <li>D – Mandatory input.</li>
            // </ul>
            //

            public String CustomerEntry;
            // Unrecognized account in terms of tax:
            // <ul>
            //     <li>N – No,</li>
            //     <li>D – Yes.</li>
            // </ul>
            //

            public String NonTaxable;
            // Application:
            // <ul>
            //     <li>N – No,</li>
            //     <li>D – Yes.</li>
            // </ul>
            //

            public String Application;
            // Account validity from year.
            public Integer ValidFromYear;
            // Account validity to year.
            public Integer ValidToYear;
            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