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

        /// Customer search result data.
        public class CustomerSearch
        {
            // Customer id.
            // Mandatory field. Ignored on create request.
            public long CustomerId { get; set; }
            // Customer code.
            // Max length: 10
            public string Code { get; set; }
            // Customer title.
            public string Name { get; set; }
            // Customer address.
            public string Address { get; set; }
            // Postal code.
            public string PostalCode { get; set; }
            // City.
            public string City { get; set; }
            // Customer country.
            public mMApiFkField Country { get; set; }
            // Tax number.
            public string TaxNumber { get; set; }
            // Usage.
            public string Usage { get; set; }
        
        }

            /// Link with id, name and url to related data.
            public class mMApiFkField
            {
                // Record id.
                public long? ID { get; set; }
                // Record name.
                public string Name { get; private set; }
                // Url to full record details.
                public string ResourceUrl { get; private 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;
    
    }

        /// Customer search result data.
        class CustomerSearch
        {
            // Customer id.
            // Mandatory field. Ignored on create request.
            public $CustomerId;
            // Customer code.
            // Max length: 10
            public $Code;
            // Customer title.
            public $Name;
            // Customer address.
            public $Address;
            // Postal code.
            public $PostalCode;
            // City.
            public $City;
            // Customer country.
            public $Country;
            // Tax number.
            public $TaxNumber;
            // Usage.
            public $Usage;
        
        }

            /// Link with id, name and url to related data.
            class mMApiFkField
            {
                // Record id.
                public $ID;
                // Record name.
                public $Name;
                // Url to full record details.
                public $ResourceUrl;
            
            }

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

        /// Customer search result data.
        public class CustomerSearch
        {
            // Customer id.
            // Mandatory field. Ignored on create request.
            public Long CustomerId;
            // Customer code.
            // Max length: 10
            public String Code;
            // Customer title.
            public String Name;
            // Customer address.
            public String Address;
            // Postal code.
            public String PostalCode;
            // City.
            public String City;
            // Customer country.
            public mMApiFkField Country;
            // Tax number.
            public String TaxNumber;
            // Usage.
            public String Usage;
        
        }

            /// Link with id, name and url to related data.
            public class mMApiFkField
            {
                // Record id.
                public Long ID;
                // Record name.
                public String Name;
                // Url to full record details.
                public String ResourceUrl;
            
            }