API Documentation

Filter options:

    /// Order search filter.
    public class OrderSearchFilter
    {
        // Customer id.
        public long? CustomerID { get; set; }
        // Date from.
        public DateTime? DateFrom { get; set; }
        // Date to.
        public DateTime? DateTo { get; set; }
        // Date confirmed from.
        public DateTime? DateConfirmedFrom { get; set; }
        // Date confirmed to.
        public DateTime? DateConfirmedTo { get; set; }
        // Date completed from.
        public DateTime? DateCompletedFrom { get; set; }
        // Date completed to.
        public DateTime? DateCompletedTo { get; set; }
        // Date canceled from.
        public DateTime? DateCanceledFrom { get; set; }
        // Date canceled to.
        public DateTime? DateCanceledTo { get; set; }
        // Received/Issued.
        public string ReceivedIssued { get; set; }
        // Year.
        public int? Year { get; set; }
        // Number.
        public int? Number { get; set; }
        // Analytics id.
        public long? AnalyticsID { get; set; }
        // Reference.
        public string Reference { get; set; }
        // Status.
        public string Status { 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:

    /// Order search filter.
    class OrderSearchFilter
    {
        // Customer id.
        public $CustomerID;
        // Date from.
        public $DateFrom;
        // Date to.
        public $DateTo;
        // Date confirmed from.
        public $DateConfirmedFrom;
        // Date confirmed to.
        public $DateConfirmedTo;
        // Date completed from.
        public $DateCompletedFrom;
        // Date completed to.
        public $DateCompletedTo;
        // Date canceled from.
        public $DateCanceledFrom;
        // Date canceled to.
        public $DateCanceledTo;
        // Received/Issued.
        public $ReceivedIssued;
        // Year.
        public $Year;
        // Number.
        public $Number;
        // Analytics id.
        public $AnalyticsID;
        // Reference.
        public $Reference;
        // Status.
        public $Status;
        // 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:

    /// Order search filter.
    public class OrderSearchFilter
    {
        // Customer id.
        public Long CustomerID;
        // Date from.
        public Date DateFrom;
        // Date to.
        public Date DateTo;
        // Date confirmed from.
        public Date DateConfirmedFrom;
        // Date confirmed to.
        public Date DateConfirmedTo;
        // Date completed from.
        public Date DateCompletedFrom;
        // Date completed to.
        public Date DateCompletedTo;
        // Date canceled from.
        public Date DateCanceledFrom;
        // Date canceled to.
        public Date DateCanceledTo;
        // Received/Issued.
        public String ReceivedIssued;
        // Year.
        public Integer Year;
        // Number.
        public Integer Number;
        // Analytics id.
        public Long AnalyticsID;
        // Reference.
        public String Reference;
        // Status.
        public String Status;
        // 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; }
    
    }

        /// Order search result row.
        public class OrderSearch
        {
            // Order id.
            public long? OrderId { get; set; }
            // Received / issued.
            public string ReceivedIssued { get; set; }
            // Year.
            public int Year { get; set; }
            // Number.
            public int? Number { get; set; }
            // Date.
            public DateTime? Date { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Analytic.
            public mMApiFkField Analytic { get; set; }
            // Currency.
            public mMApiFkField Currency { get; set; }
            // Status.
            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;
    
    }

        /// Order search result row.
        class OrderSearch
        {
            // Order id.
            public $OrderId;
            // Received / issued.
            public $ReceivedIssued;
            // Year.
            public $Year;
            // Number.
            public $Number;
            // Date.
            public $Date;
            // Customer.
            public $Customer;
            // Analytic.
            public $Analytic;
            // Currency.
            public $Currency;
            // Status.
            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;
    
    }

        /// Order search result row.
        public class OrderSearch
        {
            // Order id.
            public Long OrderId;
            // Received / issued.
            public String ReceivedIssued;
            // Year.
            public Integer Year;
            // Number.
            public Integer Number;
            // Date.
            public Date Date;
            // Customer.
            public mMApiFkField Customer;
            // Analytic.
            public mMApiFkField Analytic;
            // Currency.
            public mMApiFkField Currency;
            // Status.
            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;
            
            }