API Documentation

Filter options:

    public class StockEntrySearchFilter
    {
        // StockEntry Type.
        public string StockEntryType { get; set; }
        // StockEntry Subtype.
        public string StockEntrySubtype { get; set; }
        // StockEntry Status.
        public string Status { get; set; }
        // Analytic ID.
        public long? AnalyticId { get; set; }
        // Date from.
        public DateTime? DateFrom { get; set; }
        // Date to.
        public DateTime? DateTo { 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:

    class StockEntrySearchFilter
    {
        // StockEntry Type.
        public $StockEntryType;
        // StockEntry Subtype.
        public $StockEntrySubtype;
        // StockEntry Status.
        public $Status;
        // Analytic ID.
        public $AnalyticId;
        // Date from.
        public $DateFrom;
        // Date to.
        public $DateTo;
        // 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:

    public class StockEntrySearchFilter
    {
        // StockEntry Type.
        public String StockEntryType;
        // StockEntry Subtype.
        public String StockEntrySubtype;
        // StockEntry Status.
        public String Status;
        // Analytic ID.
        public Long AnalyticId;
        // Date from.
        public Date DateFrom;
        // Date to.
        public Date DateTo;
        // 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; }
    
    }

        /// Stock entry search result row.
        public class StockEntrySearch
        {
            // Stock entry id.
            public long? StockEntryId { get; set; }
            // Stock entry type:
            // <ul>
            //     <li>P - Receipt</li>
            //     <li>I - Issue</li>
            // </ul>
            // Mandatory field. Max length: 1
            public string StockEntryType { get; set; }
            // Stock entry subtype:
            // <ul>
            //     <li>S – Suplier/Clientt</li>
            //     <li>P – Production</li>
            //     <li>L - Storage</li>
            // </ul>
            // Mandatory field. Max length: 1
            public string StockEntrySubtype { get; set; }
            // Stock entry date.
            // Mandatory field.
            public DateTime? Date { get; set; }
            // Stock entry number.
            // Mandatory field.
            public long? Number { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Analytic.
            public mMApiFkField Analytic { get; set; }
            // Stock entry status:
            // <ul>
            //     <li>P – Confirmed,</li>
            //     <li>O – Draft</li>
            // </ul>
            // Mandatory field. Max length: 1
            public string Status { 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;
    
    }

        /// Stock entry search result row.
        class StockEntrySearch
        {
            // Stock entry id.
            public $StockEntryId;
            // Stock entry type:
            // <ul>
            //     <li>P - Receipt</li>
            //     <li>I - Issue</li>
            // </ul>
            // Mandatory field. Max length: 1
            public $StockEntryType;
            // Stock entry subtype:
            // <ul>
            //     <li>S – Suplier/Clientt</li>
            //     <li>P – Production</li>
            //     <li>L - Storage</li>
            // </ul>
            // Mandatory field. Max length: 1
            public $StockEntrySubtype;
            // Stock entry date.
            // Mandatory field.
            public $Date;
            // Stock entry number.
            // Mandatory field.
            public $Number;
            // Customer.
            public $Customer;
            // Analytic.
            public $Analytic;
            // Stock entry status:
            // <ul>
            //     <li>P – Confirmed,</li>
            //     <li>O – Draft</li>
            // </ul>
            // Mandatory field. Max length: 1
            public $Status;
        
        }

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

        /// Stock entry search result row.
        public class StockEntrySearch
        {
            // Stock entry id.
            public Long StockEntryId;
            // Stock entry type:
            // <ul>
            //     <li>P - Receipt</li>
            //     <li>I - Issue</li>
            // </ul>
            // Mandatory field. Max length: 1
            public String StockEntryType;
            // Stock entry subtype:
            // <ul>
            //     <li>S – Suplier/Clientt</li>
            //     <li>P – Production</li>
            //     <li>L - Storage</li>
            // </ul>
            // Mandatory field. Max length: 1
            public String StockEntrySubtype;
            // Stock entry date.
            // Mandatory field.
            public Date Date;
            // Stock entry number.
            // Mandatory field.
            public Long Number;
            // Customer.
            public mMApiFkField Customer;
            // Analytic.
            public mMApiFkField Analytic;
            // Stock entry status:
            // <ul>
            //     <li>P – Confirmed,</li>
            //     <li>O – Draft</li>
            // </ul>
            // Mandatory field. Max length: 1
            public String Status;
        
        }

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