API Documentation

Filter options:

    /// Journal entry search filter.
    public class JournalEntrySearchFilter
    {
        // Journal type.
        public string JournalType { get; set; }
        // Journal description.
        public string Description { get; set; }
        // Analytic id.
        public long? AnalyticID { get; set; }
        // Customer id.
        public long? CustomerID { get; set; }
        // Employee id.
        public long? EmployeeId { get; set; }
        // Journal status
        public string Status { get; set; }
        // Currency
        public string Currency { get; set; }
        // Date to.
        public DateTime? DateTo { get; set; }
        // Date from.
        public DateTime? DateFrom { get; set; }
        // Account
        public string Account { 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:

    /// Journal entry search filter.
    class JournalEntrySearchFilter
    {
        // Journal type.
        public $JournalType;
        // Journal description.
        public $Description;
        // Analytic id.
        public $AnalyticID;
        // Customer id.
        public $CustomerID;
        // Employee id.
        public $EmployeeId;
        // Journal status
        public $Status;
        // Currency
        public $Currency;
        // Date to.
        public $DateTo;
        // Date from.
        public $DateFrom;
        // Account
        public $Account;
        // 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:

    /// Journal entry search filter.
    public class JournalEntrySearchFilter
    {
        // Journal type.
        public String JournalType;
        // Journal description.
        public String Description;
        // Analytic id.
        public Long AnalyticID;
        // Customer id.
        public Long CustomerID;
        // Employee id.
        public Long EmployeeId;
        // Journal status
        public String Status;
        // Currency
        public String Currency;
        // Date to.
        public Date DateTo;
        // Date from.
        public Date DateFrom;
        // Account
        public String Account;
        // 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; }
    
    }

        /// Journal entries details.
        public class JournalEntries
        {
            // Journal entry id.
            // Ignored on create request.
            public long? JournalEntryId { get; set; }
            // Journal.
            public mMApiFkField Journal { get; set; }
            // Journal type.
            public mMApiFkField JournalType { get; set; }
            // Journal date.
            public DateTime? JournalDate { get; set; }
            // Journal entry date.
            public DateTime? JournalEntryDate { get; set; }
            // Due date.
            public DateTime? DueDate { get; set; }
            // Transaction date.
            public DateTime? TransactionDate { get; set; }
            // Account.
            public mMApiFkField Account { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Analytic.
            public mMApiFkField Analytic { get; set; }
            // Employee.
            public mMApiFkField Employee { get; set; }
            // Currency.
            public mMApiFkField Currency { get; set; }
            // Entry description.
            public string Description { get; set; }
            // Payment reference.
            public string PaymentReference { get; set; }
            // Debit.
            public Decimal Debit { get; set; }
            // Credit.
            public Decimal Credit { get; set; }
            // Debit in domestic currency.
            public Decimal DebitInDomesticCurrency { get; set; }
            // Credit in domestic currency.
            public Decimal CreditInDomesticCurrency { 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;
    
    }

        /// Journal entries details.
        class JournalEntries
        {
            // Journal entry id.
            // Ignored on create request.
            public $JournalEntryId;
            // Journal.
            public $Journal;
            // Journal type.
            public $JournalType;
            // Journal date.
            public $JournalDate;
            // Journal entry date.
            public $JournalEntryDate;
            // Due date.
            public $DueDate;
            // Transaction date.
            public $TransactionDate;
            // Account.
            public $Account;
            // Customer.
            public $Customer;
            // Analytic.
            public $Analytic;
            // Employee.
            public $Employee;
            // Currency.
            public $Currency;
            // Entry description.
            public $Description;
            // Payment reference.
            public $PaymentReference;
            // Debit.
            public $Debit;
            // Credit.
            public $Credit;
            // Debit in domestic currency.
            public $DebitInDomesticCurrency;
            // Credit in domestic currency.
            public $CreditInDomesticCurrency;
            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;
    
    }

        /// Journal entries details.
        public class JournalEntries
        {
            // Journal entry id.
            // Ignored on create request.
            public Long JournalEntryId;
            // Journal.
            public mMApiFkField Journal;
            // Journal type.
            public mMApiFkField JournalType;
            // Journal date.
            public Date JournalDate;
            // Journal entry date.
            public Date JournalEntryDate;
            // Due date.
            public Date DueDate;
            // Transaction date.
            public Date TransactionDate;
            // Account.
            public mMApiFkField Account;
            // Customer.
            public mMApiFkField Customer;
            // Analytic.
            public mMApiFkField Analytic;
            // Employee.
            public mMApiFkField Employee;
            // Currency.
            public mMApiFkField Currency;
            // Entry description.
            public String Description;
            // Payment reference.
            public String PaymentReference;
            // Debit.
            public Double Debit;
            // Credit.
            public Double Credit;
            // Debit in domestic currency.
            public Double DebitInDomesticCurrency;
            // Credit in domestic currency.
            public Double CreditInDomesticCurrency;
            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;
            
            }