API Documentation

Filter options:

    /// Item search filter.
    public class ItemSearchFilter
    {
        // Search string.
        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:

    /// Item search filter.
    class ItemSearchFilter
    {
        // Search string.
        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:

    /// Item search filter.
    public class ItemSearchFilter
    {
        // Search string.
        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; }
    
    }

        /// Item search result item.
        public class ItemSearch
        {
            // Item id.
            public long ItemId { get; set; }
            // Item title.
            public string Title { get; set; }
            // Item code.
            public string Code { get; set; }
            // Item unit of measurement.
            public string UnitOfMeasurement { get; set; }
            // Mass per unit.
            public Decimal MassPerUnit { get; set; }
            // Item type.
            public string ItemType { get; set; }
            // Item VAT rate.
            public mMApiFkField VatRate { get; set; }
            // Item selling price.
            public Decimal Price { get; set; }
            // Selling price currency.
            public mMApiFkField Currency { get; set; }
            // Domestic market revenue account.
            public mMApiFkField RevenueAccountDomestic { get; set; }
            // Revenue account for EU markets.
            public mMApiFkField RevenueAccountOutsideEU { get; set; }
            // Revenue account outside EU markets.
            public mMApiFkField RevenueAccountEU { get; set; }
            // Stock account.
            public mMApiFkField StocksAccount { get; set; }
            // Item product group.
            public mMApiFkField ProductGroup { 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;
    
    }

        /// Item search result item.
        class ItemSearch
        {
            // Item id.
            public $ItemId;
            // Item title.
            public $Title;
            // Item code.
            public $Code;
            // Item unit of measurement.
            public $UnitOfMeasurement;
            // Mass per unit.
            public $MassPerUnit;
            // Item type.
            public $ItemType;
            // Item VAT rate.
            public $VatRate;
            // Item selling price.
            public $Price;
            // Selling price currency.
            public $Currency;
            // Domestic market revenue account.
            public $RevenueAccountDomestic;
            // Revenue account for EU markets.
            public $RevenueAccountOutsideEU;
            // Revenue account outside EU markets.
            public $RevenueAccountEU;
            // Stock account.
            public $StocksAccount;
            // Item product group.
            public $ProductGroup;
        
        }

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

        /// Item search result item.
        public class ItemSearch
        {
            // Item id.
            public Long ItemId;
            // Item title.
            public String Title;
            // Item code.
            public String Code;
            // Item unit of measurement.
            public String UnitOfMeasurement;
            // Mass per unit.
            public Double MassPerUnit;
            // Item type.
            public String ItemType;
            // Item VAT rate.
            public mMApiFkField VatRate;
            // Item selling price.
            public Double Price;
            // Selling price currency.
            public mMApiFkField Currency;
            // Domestic market revenue account.
            public mMApiFkField RevenueAccountDomestic;
            // Revenue account for EU markets.
            public mMApiFkField RevenueAccountOutsideEU;
            // Revenue account outside EU markets.
            public mMApiFkField RevenueAccountEU;
            // Stock account.
            public mMApiFkField StocksAccount;
            // Item product group.
            public mMApiFkField ProductGroup;
        
        }

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