API Documentation

Filter options:

    /// Issued invoice search filter.
    public class IssuedInvoiceSearchFilter
    {
        // Customer id.
        public long? CustomerID { get; set; }
        // Customer Name.
        public string CustomerName { get; set; }
        // Analytics id.
        public long? AnalyticsID { get; set; }
        // Currency id.
        public long? CurrencyId { get; set; }
        // Invoice type. Mandatory filter value.
        public string InvoiceType { get; set; }
        // Invoice number.
        public string InvoiceNumber { get; set; }
        // Year.
        public int? Year { get; set; }
        // Date issued from.
        public DateTime? DateIssuedFrom { get; set; }
        // Date issued to.
        public DateTime? DateIssuedTo { get; set; }
        // Date due from.
        public DateTime? DateDueFrom { get; set; }
        // Date due to.
        public DateTime? DateDueTo { get; set; }
        // Date transaction from.
        public DateTime? DateTransactionFrom { get; set; }
        // Date transaction to.
        public DateTime? DateTransactionTo { get; set; }
        // Status.
        public string Status { get; set; }
        // Payment Status.
        public string PaymentStatus { 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:

    /// Issued invoice search filter.
    class IssuedInvoiceSearchFilter
    {
        // Customer id.
        public $CustomerID;
        // Customer Name.
        public $CustomerName;
        // Analytics id.
        public $AnalyticsID;
        // Currency id.
        public $CurrencyId;
        // Invoice type. Mandatory filter value.
        public $InvoiceType;
        // Invoice number.
        public $InvoiceNumber;
        // Year.
        public $Year;
        // Date issued from.
        public $DateIssuedFrom;
        // Date issued to.
        public $DateIssuedTo;
        // Date due from.
        public $DateDueFrom;
        // Date due to.
        public $DateDueTo;
        // Date transaction from.
        public $DateTransactionFrom;
        // Date transaction to.
        public $DateTransactionTo;
        // Status.
        public $Status;
        // Payment Status.
        public $PaymentStatus;
        // 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:

    /// Issued invoice search filter.
    public class IssuedInvoiceSearchFilter
    {
        // Customer id.
        public Long CustomerID;
        // Customer Name.
        public String CustomerName;
        // Analytics id.
        public Long AnalyticsID;
        // Currency id.
        public Long CurrencyId;
        // Invoice type. Mandatory filter value.
        public String InvoiceType;
        // Invoice number.
        public String InvoiceNumber;
        // Year.
        public Integer Year;
        // Date issued from.
        public Date DateIssuedFrom;
        // Date issued to.
        public Date DateIssuedTo;
        // Date due from.
        public Date DateDueFrom;
        // Date due to.
        public Date DateDueTo;
        // Date transaction from.
        public Date DateTransactionFrom;
        // Date transaction to.
        public Date DateTransactionTo;
        // Status.
        public String Status;
        // Payment Status.
        public String PaymentStatus;
        // 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; }
    
    }

        /// Issued invoice search result item.
        public class IssuedInvoiceSearch
        {
            // Issued invoice id.
            public long IssuedInvoiceId { get; set; }
            // Invoice type.
            public string InvoiceType { get; set; }
            // Year.
            public int? Year { get; set; }
            // Invoice number.
            public long? InvoiceNumber { get; set; }
            // Numbering.
            public string Numbering { get; set; }
            // Document numbering.
            public mMApiFkField DocumentNumbering { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Date issued.
            public DateTime? DateIssued { get; set; }
            // Date of transaction.
            public DateTime? DateTransaction { get; set; }
            // Date due.
            public DateTime? DateDue { get; set; }
            // Currency.
            public mMApiFkField Currency { get; set; }
            // Analytics.
            public mMApiFkField Analytics { get; set; }
            // Status.
            public string Status { get; set; }
            // Payment status:
            // <ul>
            //     <li>Placan – Paid</li>
            //     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
            //     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
            //     <li>NeplacanZapadel – Unpaid, Overdue</li>
            //     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
            //     <li>Osnutek – Draft</li>
            //     <li>Avans – Advance payment</li>
            // </ul>
            public string PaymentStatus { get; set; }
            // Invoice value.
            public Decimal InvoiceValue { get; set; }
            // Paid value.
            public Decimal PaidValue { 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;
    
    }

        /// Issued invoice search result item.
        class IssuedInvoiceSearch
        {
            // Issued invoice id.
            public $IssuedInvoiceId;
            // Invoice type.
            public $InvoiceType;
            // Year.
            public $Year;
            // Invoice number.
            public $InvoiceNumber;
            // Numbering.
            public $Numbering;
            // Document numbering.
            public $DocumentNumbering;
            // Customer.
            public $Customer;
            // Date issued.
            public $DateIssued;
            // Date of transaction.
            public $DateTransaction;
            // Date due.
            public $DateDue;
            // Currency.
            public $Currency;
            // Analytics.
            public $Analytics;
            // Status.
            public $Status;
            // Payment status:
            // <ul>
            //     <li>Placan – Paid</li>
            //     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
            //     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
            //     <li>NeplacanZapadel – Unpaid, Overdue</li>
            //     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
            //     <li>Osnutek – Draft</li>
            //     <li>Avans – Advance payment</li>
            // </ul>
            public $PaymentStatus;
            // Invoice value.
            public $InvoiceValue;
            // Paid value.
            public $PaidValue;
            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;
    
    }

        /// Issued invoice search result item.
        public class IssuedInvoiceSearch
        {
            // Issued invoice id.
            public Long IssuedInvoiceId;
            // Invoice type.
            public String InvoiceType;
            // Year.
            public Integer Year;
            // Invoice number.
            public Long InvoiceNumber;
            // Numbering.
            public String Numbering;
            // Document numbering.
            public mMApiFkField DocumentNumbering;
            // Customer.
            public mMApiFkField Customer;
            // Date issued.
            public Date DateIssued;
            // Date of transaction.
            public Date DateTransaction;
            // Date due.
            public Date DateDue;
            // Currency.
            public mMApiFkField Currency;
            // Analytics.
            public mMApiFkField Analytics;
            // Status.
            public String Status;
            // Payment status:
            // <ul>
            //     <li>Placan – Paid</li>
            //     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
            //     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
            //     <li>NeplacanZapadel – Unpaid, Overdue</li>
            //     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
            //     <li>Osnutek – Draft</li>
            //     <li>Avans – Advance payment</li>
            // </ul>
            public String PaymentStatus;
            // Invoice value.
            public Double InvoiceValue;
            // Paid value.
            public Double PaidValue;
            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;
            
            }