API Documentation

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

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

        /// DocumentNumbering details.
        public class DocumentNumbering
        {
            // DocumentNumbering id.
            // Ignored on create request.
            public long DocumentNumberingId { get; set; }
            // Document numbering codes.<br/>
            // <ul>
            //     <li>IR – Issued invoice</li>
            //     <li>PD – Proforma invoice</li>
            //     <li>PR – Received invoice</li>
            // </ul>
            //
            public string Document { get; set; }
            // Code.
            public string Code { get; set; }
            // Name.
            public string Name { get; set; }
            // Default:
            // <ul>
            //     <li>D - Yes</li>
            //     <li>N - No</li>
            // </ul>
            //
            public string Default { get; set; }
            // Reference number used on invoices.
            public string ReferenceNumber { get; set; }
            // Usage:
            // <ul>
            //     <li>D - Yes</li>
            //     <li>N - No</li>
            // </ul>
            //
            public string Usage { 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;
    
    }

        /// DocumentNumbering details.
        class DocumentNumbering
        {
            // DocumentNumbering id.
            // Ignored on create request.
            public $DocumentNumberingId;
            // Document numbering codes.<br/>
            // <ul>
            //     <li>IR – Issued invoice</li>
            //     <li>PD – Proforma invoice</li>
            //     <li>PR – Received invoice</li>
            // </ul>
            //
            public $Document;
            // Code.
            public $Code;
            // Name.
            public $Name;
            // Default:
            // <ul>
            //     <li>D - Yes</li>
            //     <li>N - No</li>
            // </ul>
            //
            public $Default;
            // Reference number used on invoices.
            public $ReferenceNumber;
            // Usage:
            // <ul>
            //     <li>D - Yes</li>
            //     <li>N - No</li>
            // </ul>
            //
            public $Usage;
            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;
    
    }

        /// DocumentNumbering details.
        public class DocumentNumbering
        {
            // DocumentNumbering id.
            // Ignored on create request.
            public Long DocumentNumberingId;
            // Document numbering codes.<br/>
            // <ul>
            //     <li>IR – Issued invoice</li>
            //     <li>PD – Proforma invoice</li>
            //     <li>PR – Received invoice</li>
            // </ul>
            //
            public String Document;
            // Code.
            public String Code;
            // Name.
            public String Name;
            // Default:
            // <ul>
            //     <li>D - Yes</li>
            //     <li>N - No</li>
            // </ul>
            //
            public String Default;
            // Reference number used on invoices.
            public String ReferenceNumber;
            // Usage:
            // <ul>
            //     <li>D - Yes</li>
            //     <li>N - No</li>
            // </ul>
            //
            public String Usage;
            public Date RecordDtModified;
            // Row version is used for concurrency check.
            // Ignored on create request.
            public String RowVersion;
        
        }