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

Order -> GetOrdersSyncCandidates

Returns orders for sync.

Request

Relative request path: api/orgs/{organisationId}/orders/synccandidates

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
RecordDtModifiedFromRecordDtModifiedFrom - if set return only records last changed after given date time.
RecordDtModifiedToRecordDtModifiedTo - if set return only records last changed before given date time.

Filter options:

    /// Sync search filter.
    public class SyncSearchFilter
    {
        // RecordDtModifiedFrom - if set return only records last changed after given date time.
        public DateTime? RecordDtModifiedFrom { get; set; }
        // RecordDtModifiedTo - if set return only records last changed before given date time.
        public DateTime? RecordDtModifiedTo { get; set; }
    
    }

Request parameters:

  • long organisationId - organisation id

Filter options:

    /// Sync search filter.
    class SyncSearchFilter
    {
        // RecordDtModifiedFrom - if set return only records last changed after given date time.
        public $RecordDtModifiedFrom;
        // RecordDtModifiedTo - if set return only records last changed before given date time.
        public $RecordDtModifiedTo;
    
    }

Request parameters:

  • Int64 organisationId - organisation id

Filter options:

    /// Sync search filter.
    public class SyncSearchFilter
    {
        // RecordDtModifiedFrom - if set return only records last changed after given date time.
        public Date RecordDtModifiedFrom;
        // RecordDtModifiedTo - if set return only records last changed before given date time.
        public Date RecordDtModifiedTo;
    
    }

Request parameters:

  • Long organisationId - organisation id

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
RowsReturned rows. List of SyncCandidate.
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.SyncQueryResult`1'.

    public class SyncQueryResult<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; }
    
    }

        public class SyncCandidate
        {
            public long ID { get; set; }
            public DateTime RecordDtModified { get; set; }
            // Ignored on create request.
            public string RowVersion { get; set; }
        
        }

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

    class SyncQueryResult
    {
        // 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;
    
    }

        class SyncCandidate
        {
            public $ID;
            public $RecordDtModified;
            // Ignored on create request.
            public $RowVersion;
        
        }

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

    public class SyncQueryResultT
    {
        // 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;
    
    }

        public class SyncCandidate
        {
            public Long ID;
            public Date RecordDtModified;
            // 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