API Documentation

Filter options:

    /// Journal search filter.
    public class JournalSearchFilter
    {
        // Date to.
        public DateTime? DateTo { get; set; }
        // Date from.
        public DateTime? DateFrom { get; set; }
        // JournalId from.
        public long? JournalId { get; set; }
        // Journal type.
        public string JournalType { get; set; }
        // Journal description.
        public string Description { get; set; }
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>
        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:

    /// Journal search filter.
    class JournalSearchFilter
    {
        // Date to.
        public $DateTo;
        // Date from.
        public $DateFrom;
        // JournalId from.
        public $JournalId;
        // Journal type.
        public $JournalType;
        // Journal description.
        public $Description;
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>
        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:

    /// Journal search filter.
    public class JournalSearchFilter
    {
        // Date to.
        public Date DateTo;
        // Date from.
        public Date DateFrom;
        // JournalId from.
        public Long JournalId;
        // Journal type.
        public String JournalType;
        // Journal description.
        public String Description;
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>
        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; }
    
    }

        /// Journal search result row.
        public class JournalSearch
        {
            // Journal id.
            public long JournalId { get; set; }
            // Journal type.
            public mMApiFkField JournalType { get; set; }
            // Journal date.
            public DateTime JournalDate { get; set; }
            // Description.
            public string Description { 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 search result row.
        class JournalSearch
        {
            // Journal id.
            public $JournalId;
            // Journal type.
            public $JournalType;
            // Journal date.
            public $JournalDate;
            // Description.
            public $Description;
        
        }

            /// 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 search result row.
        public class JournalSearch
        {
            // Journal id.
            public Long JournalId;
            // Journal type.
            public mMApiFkField JournalType;
            // Journal date.
            public Date JournalDate;
            // Description.
            public String Description;
        
        }

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