API Documentation

Filter options:

    public class StockEntrySearchFilter
    {
        // 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:

    class StockEntrySearchFilter
    {
        // 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:

    public class StockEntrySearchFilter
    {
        // 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; }
    
    }

        /// Stock entry search result row.
        public class StockEntrySearch
        {
            // Stock entry id.
            public long? StockEntryId { get; set; }
            // Stock entry type.
            // Mandatory field. Max length: 1
            public string StockEntryType { get; set; }
            // Stock entry subtype.
            // Mandatory field. Max length: 1
            public string StockEntrySubtype { get; set; }
            // Stock entry date.
            // Mandatory field.
            public DateTime? Date { get; set; }
            // Stock entry number.
            // Mandatory field.
            public long? Number { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Analytic.
            public mMApiFkField Analytic { get; set; }
            // Stock entry status:
            // <ul>
            //     <li>P – Confirmed,</li>
            //     <li>O – Draft</li>
            // </ul>
            // Mandatory field. Max length: 1
            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;
    
    }

        /// Stock entry search result row.
        class StockEntrySearch
        {
            // Stock entry id.
            public $StockEntryId;
            // Stock entry type.
            // Mandatory field. Max length: 1
            public $StockEntryType;
            // Stock entry subtype.
            // Mandatory field. Max length: 1
            public $StockEntrySubtype;
            // Stock entry date.
            // Mandatory field.
            public $Date;
            // Stock entry number.
            // Mandatory field.
            public $Number;
            // Customer.
            public $Customer;
            // Analytic.
            public $Analytic;
            // Stock entry status:
            // <ul>
            //     <li>P – Confirmed,</li>
            //     <li>O – Draft</li>
            // </ul>
            // Mandatory field. Max length: 1
            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;
    
    }

        /// Stock entry search result row.
        public class StockEntrySearch
        {
            // Stock entry id.
            public Long StockEntryId;
            // Stock entry type.
            // Mandatory field. Max length: 1
            public String StockEntryType;
            // Stock entry subtype.
            // Mandatory field. Max length: 1
            public String StockEntrySubtype;
            // Stock entry date.
            // Mandatory field.
            public Date Date;
            // Stock entry number.
            // Mandatory field.
            public Long Number;
            // Customer.
            public mMApiFkField Customer;
            // Analytic.
            public mMApiFkField Analytic;
            // Stock entry status:
            // <ul>
            //     <li>P – Confirmed,</li>
            //     <li>O – Draft</li>
            // </ul>
            // Mandatory field. Max length: 1
            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;
            
            }

{
  "Rows": [
    {
      "StockEntryId": 1,
      "StockEntryType": "sample string 1",
      "StockEntrySubtype": "sample string 2",
      "Date": "2019-12-10T03:32:21.0420864+01:00",
      "Number": 1,
      "Customer": {
        "ID": 1,
        "Name": "sample string 1",
        "ResourceUrl": "sample string 2"
      },
      "Analytic": {
        "ID": 1,
        "Name": "sample string 1",
        "ResourceUrl": "sample string 2"
      },
      "Status": "sample string 3"
    },
    {
      "StockEntryId": 1,
      "StockEntryType": "sample string 1",
      "StockEntrySubtype": "sample string 2",
      "Date": "2019-12-10T03:32:21.0420864+01:00",
      "Number": 1,
      "Customer": {
        "ID": 1,
        "Name": "sample string 1",
        "ResourceUrl": "sample string 2"
      },
      "Analytic": {
        "ID": 1,
        "Name": "sample string 1",
        "ResourceUrl": "sample string 2"
      },
      "Status": "sample string 3"
    },
    {
      "StockEntryId": 1,
      "StockEntryType": "sample string 1",
      "StockEntrySubtype": "sample string 2",
      "Date": "2019-12-10T03:32:21.0420864+01:00",
      "Number": 1,
      "Customer": {
        "ID": 1,
        "Name": "sample string 1",
        "ResourceUrl": "sample string 2"
      },
      "Analytic": {
        "ID": 1,
        "Name": "sample string 1",
        "ResourceUrl": "sample string 2"
      },
      "Status": "sample string 3"
    }
  ],
  "TotalRows": 1,
  "CurrentPageNumber": 2,
  "PageSize": 3
}

<SearchResultOfStockEntrySearch36grAcr4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAOP.API.Models">
  <CurrentPageNumber>2</CurrentPageNumber>
  <PageSize>3</PageSize>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/SAOP.API.Models.Stock">
    <d2p1:StockEntrySearch>
      <d2p1:Analytic xmlns:d4p1="http://schemas.datacontract.org/2004/07/SAOP.API.Common">
        <d4p1:ID>1</d4p1:ID>
      </d2p1:Analytic>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/SAOP.API.Common">
        <d4p1:ID>1</d4p1:ID>
      </d2p1:Customer>
      <d2p1:Date>2019-12-10T03:32:21.0420864+01:00</d2p1:Date>
      <d2p1:Number>1</d2p1:Number>
      <d2p1:Status>sample string 3</d2p1:Status>
      <d2p1:StockEntryId>1</d2p1:StockEntryId>
      <d2p1:StockEntrySubtype>sample string 2</d2p1:StockEntrySubtype>
      <d2p1:StockEntryType>sample string 1</d2p1:StockEntryType>
    </d2p1:StockEntrySearch>
    <d2p1:StockEntrySearch>
      <d2p1:Analytic xmlns:d4p1="http://schemas.datacontract.org/2004/07/SAOP.API.Common">
        <d4p1:ID>1</d4p1:ID>
      </d2p1:Analytic>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/SAOP.API.Common">
        <d4p1:ID>1</d4p1:ID>
      </d2p1:Customer>
      <d2p1:Date>2019-12-10T03:32:21.0420864+01:00</d2p1:Date>
      <d2p1:Number>1</d2p1:Number>
      <d2p1:Status>sample string 3</d2p1:Status>
      <d2p1:StockEntryId>1</d2p1:StockEntryId>
      <d2p1:StockEntrySubtype>sample string 2</d2p1:StockEntrySubtype>
      <d2p1:StockEntryType>sample string 1</d2p1:StockEntryType>
    </d2p1:StockEntrySearch>
    <d2p1:StockEntrySearch>
      <d2p1:Analytic xmlns:d4p1="http://schemas.datacontract.org/2004/07/SAOP.API.Common">
        <d4p1:ID>1</d4p1:ID>
      </d2p1:Analytic>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/SAOP.API.Common">
        <d4p1:ID>1</d4p1:ID>
      </d2p1:Customer>
      <d2p1:Date>2019-12-10T03:32:21.0420864+01:00</d2p1:Date>
      <d2p1:Number>1</d2p1:Number>
      <d2p1:Status>sample string 3</d2p1:Status>
      <d2p1:StockEntryId>1</d2p1:StockEntryId>
      <d2p1:StockEntrySubtype>sample string 2</d2p1:StockEntrySubtype>
      <d2p1:StockEntryType>sample string 1</d2p1:StockEntryType>
    </d2p1:StockEntrySearch>
  </Rows>
  <TotalRows>1</TotalRows>
</SearchResultOfStockEntrySearch36grAcr4>