API Documentation

Filter options:

    /// Outbox search filter.
    public class OutboxSearchFilter
    {
        // Outbox type.
        public string OutboxType { get; set; }
        // Outbox import status
        public Boolean OutboxImportStatus { get; set; }
        // Outbox date from.
        public DateTime? OutboxDateFrom { get; set; }
        // Outbox date to.
        public DateTime? OutboxDateTo { 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 -

Filter options:

    /// Outbox search filter.
    class OutboxSearchFilter
    {
        // Outbox type.
        public $OutboxType;
        // Outbox import status
        public $OutboxImportStatus;
        // Outbox date from.
        public $OutboxDateFrom;
        // Outbox date to.
        public $OutboxDateTo;
        // 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 -

Filter options:

    /// Outbox search filter.
    public class OutboxSearchFilter
    {
        // Outbox type.
        public String OutboxType;
        // Outbox import status
        public Boolean OutboxImportStatus;
        // Outbox date from.
        public Date OutboxDateFrom;
        // Outbox date to.
        public Date OutboxDateTo;
        // 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 -

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

        public class Outbox
        {
            // Ignored on create request.
            public long OutboxId { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Employee.
            public mMApiFkField Employee { get; set; }
            // Outbox date.
            // Ignored on create request.
            public DateTime OutboxDate { get; set; }
            // Outbox type:
            // <ul>
            //     <li>IR - Issued invoices</li>
            //     <li>DO - Delivery note</li>
            //     <li>OP - Payroll</li>
            // </ul>
            public string OutboxType { get; set; }
            // Description
            public string Description { get; set; }
            // Outbox attachments.
            public List<OutboxAttachment> Attachments { 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; }
            
            }
            public class OutboxAttachment
            {
                // Ignored on create request.
                public long OutboxAttachmentId { get; set; }
                // Outbox.
                public mMApiFkField Outbox { get; set; }
                // Attachment data.
                public string AttachmentData { get; set; }
                // Attachment entry date.
                // Ignored on create request.
                public DateTime AttachmentDate { get; set; }
                // Attachment name for file.
                public string AttachmentFileName { get; set; }
                // Attachment mime type.
                public string AttachmentMimeType { 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;
    
    }

        class Outbox
        {
            // Ignored on create request.
            public $OutboxId;
            // Customer.
            public $Customer;
            // Employee.
            public $Employee;
            // Outbox date.
            // Ignored on create request.
            public $OutboxDate;
            // Outbox type:
            // <ul>
            //     <li>IR - Issued invoices</li>
            //     <li>DO - Delivery note</li>
            //     <li>OP - Payroll</li>
            // </ul>
            public $OutboxType;
            // Description
            public $Description;
            // Outbox attachments.
            public $Attachments;
            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;
            
            }
            class OutboxAttachment
            {
                // Ignored on create request.
                public $OutboxAttachmentId;
                // Outbox.
                public $Outbox;
                // Attachment data.
                public $AttachmentData;
                // Attachment entry date.
                // Ignored on create request.
                public $AttachmentDate;
                // Attachment name for file.
                public $AttachmentFileName;
                // Attachment mime type.
                public $AttachmentMimeType;
                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;
    
    }

        public class Outbox
        {
            // Ignored on create request.
            public Long OutboxId;
            // Customer.
            public mMApiFkField Customer;
            // Employee.
            public mMApiFkField Employee;
            // Outbox date.
            // Ignored on create request.
            public Date OutboxDate;
            // Outbox type:
            // <ul>
            //     <li>IR - Issued invoices</li>
            //     <li>DO - Delivery note</li>
            //     <li>OP - Payroll</li>
            // </ul>
            public String OutboxType;
            // Description
            public String Description;
            // Outbox attachments.
            public List<OutboxAttachment> Attachments;
            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;
            
            }
            public class OutboxAttachment
            {
                // Ignored on create request.
                public Long OutboxAttachmentId;
                // Outbox.
                public mMApiFkField Outbox;
                // Attachment data.
                public String AttachmentData;
                // Attachment entry date.
                // Ignored on create request.
                public Date AttachmentDate;
                // Attachment name for file.
                public String AttachmentFileName;
                // Attachment mime type.
                public String AttachmentMimeType;
                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;
                
                }