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

        /// Warehouse details.
        public class Warehouse
        {
            // Warehouse id.
            // Ignored on create request.
            public long WarehouseId { get; set; }
            // Warehouse code.
            public string Code { get; set; }
            // Warehouse name.
            public string Name { get; set; }
            // Warehouse location.
            public string Location { get; set; }
            // Type of inventory management:
            // <ul>
            //     <li>Nabavna – Purchase value,</li>
            //     <li>Prodajna – Sales value</li>
            // </ul>
            public string InventoryManagement { get; set; }
            // Enable selling price input in stocks:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no</li>
            // </ul>
            public string InventoryManagementByValue { get; set; }
            // InventoryManagement only by value:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no</li>
            // </ul>
            public string SellingPriceInput { get; set; }
            // Type of inventory bookkepping:
            // <ul>
            //     <li>Nabavna – Purchase value,</li>
            //     <li>Prodajna – Sales value</li>
            // </ul>
            public string InventoryBookkeping { get; set; }
            // Stocks account.
            public mMApiFkField StocksAccount { get; set; }
            // Account for price difference.
            public mMApiFkField PDAccount { get; set; }
            // Account for VAT standard rate.
            public mMApiFkField VATStandardAccount { get; set; }
            // Account for VAT reduced rate.
            public mMApiFkField VATReducedAccount { get; set; }
            // Account for VAT special reduced rate.
            public mMApiFkField VATSpecialReducedAccount { 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; }
        
        }

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

        /// Warehouse details.
        class Warehouse
        {
            // Warehouse id.
            // Ignored on create request.
            public $WarehouseId;
            // Warehouse code.
            public $Code;
            // Warehouse name.
            public $Name;
            // Warehouse location.
            public $Location;
            // Type of inventory management:
            // <ul>
            //     <li>Nabavna – Purchase value,</li>
            //     <li>Prodajna – Sales value</li>
            // </ul>
            public $InventoryManagement;
            // Enable selling price input in stocks:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no</li>
            // </ul>
            public $InventoryManagementByValue;
            // InventoryManagement only by value:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no</li>
            // </ul>
            public $SellingPriceInput;
            // Type of inventory bookkepping:
            // <ul>
            //     <li>Nabavna – Purchase value,</li>
            //     <li>Prodajna – Sales value</li>
            // </ul>
            public $InventoryBookkeping;
            // Stocks account.
            public $StocksAccount;
            // Account for price difference.
            public $PDAccount;
            // Account for VAT standard rate.
            public $VATStandardAccount;
            // Account for VAT reduced rate.
            public $VATReducedAccount;
            // Account for VAT special reduced rate.
            public $VATSpecialReducedAccount;
            // 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;
        
        }

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

        /// Warehouse details.
        public class Warehouse
        {
            // Warehouse id.
            // Ignored on create request.
            public Long WarehouseId;
            // Warehouse code.
            public String Code;
            // Warehouse name.
            public String Name;
            // Warehouse location.
            public String Location;
            // Type of inventory management:
            // <ul>
            //     <li>Nabavna – Purchase value,</li>
            //     <li>Prodajna – Sales value</li>
            // </ul>
            public String InventoryManagement;
            // Enable selling price input in stocks:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no</li>
            // </ul>
            public String InventoryManagementByValue;
            // InventoryManagement only by value:
            // <ul>
            //     <li>D - yes,</li>
            //     <li>N - no</li>
            // </ul>
            public String SellingPriceInput;
            // Type of inventory bookkepping:
            // <ul>
            //     <li>Nabavna – Purchase value,</li>
            //     <li>Prodajna – Sales value</li>
            // </ul>
            public String InventoryBookkeping;
            // Stocks account.
            public mMApiFkField StocksAccount;
            // Account for price difference.
            public mMApiFkField PDAccount;
            // Account for VAT standard rate.
            public mMApiFkField VATStandardAccount;
            // Account for VAT reduced rate.
            public mMApiFkField VATReducedAccount;
            // Account for VAT special reduced rate.
            public mMApiFkField VATSpecialReducedAccount;
            // 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;
        
        }

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