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

        /// Payment method result data.
        public class PaymentMethodSearch
        {
            // Payment method id.
            // Ignored on create request.
            public long PaymentMethodId { get; set; }
            // Payment method name.
            public string Name { get; set; }
            // Payment method code.
            public string Code { get; set; }
            // Payment type:
            // <ul>
            //     <li>T - bank</li>
            //     <li>G - cash</li>
            //     <li>B - cash register</li>
            //     <li>K - card</li>
            //     <li>O - other</li>
            // <ul>
            public string Type { get; set; }
            // Usage:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no.</li>
            // </ul>
            public string Usage { 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;
    
    }

        /// Payment method result data.
        class PaymentMethodSearch
        {
            // Payment method id.
            // Ignored on create request.
            public $PaymentMethodId;
            // Payment method name.
            public $Name;
            // Payment method code.
            public $Code;
            // Payment type:
            // <ul>
            //     <li>T - bank</li>
            //     <li>G - cash</li>
            //     <li>B - cash register</li>
            //     <li>K - card</li>
            //     <li>O - other</li>
            // <ul>
            public $Type;
            // Usage:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no.</li>
            // </ul>
            public $Usage;
        
        }

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

        /// Payment method result data.
        public class PaymentMethodSearch
        {
            // Payment method id.
            // Ignored on create request.
            public Long PaymentMethodId;
            // Payment method name.
            public String Name;
            // Payment method code.
            public String Code;
            // Payment type:
            // <ul>
            //     <li>T - bank</li>
            //     <li>G - cash</li>
            //     <li>B - cash register</li>
            //     <li>K - card</li>
            //     <li>O - other</li>
            // <ul>
            public String Type;
            // Usage:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no.</li>
            // </ul>
            public String Usage;
        
        }