API Documentation

Request parameters:

• long organisationId - Organisation id
• long orderId - Order id

Request parameters:

• Int64 organisationId - Organisation id
• Int64 orderId - Order id

Request parameters:

• Long organisationId - Organisation id
• Long orderId - Order id

This method returns result of type 'SAOP.API.Models.Order.Order'.

    /// Order details.
    public class Order
    {
        // Order id.
        public long? OrderId { get; set; }
        // Order type:
        // <ul>
        //     <li>I – issued order,</li>
        //     <li>P – recieved order.</li>
        // </ul>
        public string ReceivedIssued { get; set; }
        // Order year.
        public int Year { get; set; }
        // Order number.
        public int? Number { get; set; }
        // Order date.
        public DateTime? Date { get; set; }
        // Customer.
        public mMApiFkField Customer { get; set; }
        // Customer name.
        public string CustomerName { get; set; }
        // Customer address.
        public string CustomerAddress { get; set; }
        // Customer postal code.
        public string CustomerPostalCode { get; set; }
        // Customer city.
        public string CustomerCity { get; set; }
        // Customer country.
        public mMApiFkField CustomerCountry { get; set; }
        // Customer country name.
        public string CustomerCountryName { get; set; }
        // Recipient name.
        public string RecipientName { get; set; }
        // Recipient address.
        public string RecipientAddress { get; set; }
        // Recipient postal code.
        public string RecipientPostalCode { get; set; }
        // Recipient city.
        public string RecipientCity { get; set; }
        // Recipient country name. Prohibited use when RecipientCountry is set as home country.
        public string RecipientCountryName { get; set; }
        // Recipient country.
        public mMApiFkField RecipientCountry { get; set; }
        // Analytic.
        public mMApiFkField Analytic { get; set; }
        // Due date.
        public DateTime? DueDate { get; set; }
        // Reference.
        public string Reference { get; set; }
        // Currency.
        public mMApiFkField Currency { get; set; }
        // Notes.
        public string Notes { get; set; }
        // Order confirmation date.
        public DateTime? DateConfirmed { get; set; }
        // Order termination date.
        public DateTime? DateCompleted { get; set; }
        // Order Invalidation date.
        public DateTime? DateCanceled { get; set; }
        // Order status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z – Terminated,</li>
        //     <li>R - Invalidated</li>
        // </ul>
        public string Status { get; set; }
        // The description that appears on order print above.
        public string DescriptionAbove { get; set; }
        // The description that appears on order print below.
        public string DescriptionBelow { get; set; }
        // Report settings for orders:
        // <ul>
        //     <li>IN – for issued orders,</li>
        //     <li>PN – for received orders</li>
        // </ul>
        public mMApiFkField ReportTemplate { get; set; }
        // Order rows.
        public List<OrderRow> OrderRows { 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; }
        
        }
        /// Order row details.
        public class OrderRow
        {
            // Order row id.
            public long? OrderRowId { get; set; }
            // Order.
            public mMApiFkField Order { get; set; }
            // Item.
            public mMApiFkField Item { get; set; }
            //   Warehouse.<br/>
            // Input allowed if inventory discharge is enabled. (Company's settings).
            public mMApiFkField Warehouse { get; set; }
            // Item name.
            public string ItemName { get; set; }
            // Item code.
            public string ItemCode { get; set; }
            // Item description.
            public string Description { get; set; }
            // Quantity.
            public Decimal Quantity { get; set; }
            // Discount value in percent.
            public Decimal DiscountPercent { get; set; }
            // Price.
            public Decimal Price { get; set; }
            // Item unit of measurement.
            public string UnitOfMeasurement { 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.Order.Order'.

    /// Order details.
    class Order
    {
        // Order id.
        public $OrderId;
        // Order type:
        // <ul>
        //     <li>I – issued order,</li>
        //     <li>P – recieved order.</li>
        // </ul>
        public $ReceivedIssued;
        // Order year.
        public $Year;
        // Order number.
        public $Number;
        // Order date.
        public $Date;
        // Customer.
        public $Customer;
        // Customer name.
        public $CustomerName;
        // Customer address.
        public $CustomerAddress;
        // Customer postal code.
        public $CustomerPostalCode;
        // Customer city.
        public $CustomerCity;
        // Customer country.
        public $CustomerCountry;
        // Customer country name.
        public $CustomerCountryName;
        // Recipient name.
        public $RecipientName;
        // Recipient address.
        public $RecipientAddress;
        // Recipient postal code.
        public $RecipientPostalCode;
        // Recipient city.
        public $RecipientCity;
        // Recipient country name. Prohibited use when RecipientCountry is set as home country.
        public $RecipientCountryName;
        // Recipient country.
        public $RecipientCountry;
        // Analytic.
        public $Analytic;
        // Due date.
        public $DueDate;
        // Reference.
        public $Reference;
        // Currency.
        public $Currency;
        // Notes.
        public $Notes;
        // Order confirmation date.
        public $DateConfirmed;
        // Order termination date.
        public $DateCompleted;
        // Order Invalidation date.
        public $DateCanceled;
        // Order status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z – Terminated,</li>
        //     <li>R - Invalidated</li>
        // </ul>
        public $Status;
        // The description that appears on order print above.
        public $DescriptionAbove;
        // The description that appears on order print below.
        public $DescriptionBelow;
        // Report settings for orders:
        // <ul>
        //     <li>IN – for issued orders,</li>
        //     <li>PN – for received orders</li>
        // </ul>
        public $ReportTemplate;
        // Order rows.
        public $OrderRows;
        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;
        
        }
        /// Order row details.
        class OrderRow
        {
            // Order row id.
            public $OrderRowId;
            // Order.
            public $Order;
            // Item.
            public $Item;
            //   Warehouse.<br/>
            // Input allowed if inventory discharge is enabled. (Company's settings).
            public $Warehouse;
            // Item name.
            public $ItemName;
            // Item code.
            public $ItemCode;
            // Item description.
            public $Description;
            // Quantity.
            public $Quantity;
            // Discount value in percent.
            public $DiscountPercent;
            // Price.
            public $Price;
            // Item unit of measurement.
            public $UnitOfMeasurement;
            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.Order.Order'.

    /// Order details.
    public class Order
    {
        // Order id.
        public Long OrderId;
        // Order type:
        // <ul>
        //     <li>I – issued order,</li>
        //     <li>P – recieved order.</li>
        // </ul>
        public String ReceivedIssued;
        // Order year.
        public Integer Year;
        // Order number.
        public Integer Number;
        // Order date.
        public Date Date;
        // Customer.
        public mMApiFkField Customer;
        // Customer name.
        public String CustomerName;
        // Customer address.
        public String CustomerAddress;
        // Customer postal code.
        public String CustomerPostalCode;
        // Customer city.
        public String CustomerCity;
        // Customer country.
        public mMApiFkField CustomerCountry;
        // Customer country name.
        public String CustomerCountryName;
        // Recipient name.
        public String RecipientName;
        // Recipient address.
        public String RecipientAddress;
        // Recipient postal code.
        public String RecipientPostalCode;
        // Recipient city.
        public String RecipientCity;
        // Recipient country name. Prohibited use when RecipientCountry is set as home country.
        public String RecipientCountryName;
        // Recipient country.
        public mMApiFkField RecipientCountry;
        // Analytic.
        public mMApiFkField Analytic;
        // Due date.
        public Date DueDate;
        // Reference.
        public String Reference;
        // Currency.
        public mMApiFkField Currency;
        // Notes.
        public String Notes;
        // Order confirmation date.
        public Date DateConfirmed;
        // Order termination date.
        public Date DateCompleted;
        // Order Invalidation date.
        public Date DateCanceled;
        // Order status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z – Terminated,</li>
        //     <li>R - Invalidated</li>
        // </ul>
        public String Status;
        // The description that appears on order print above.
        public String DescriptionAbove;
        // The description that appears on order print below.
        public String DescriptionBelow;
        // Report settings for orders:
        // <ul>
        //     <li>IN – for issued orders,</li>
        //     <li>PN – for received orders</li>
        // </ul>
        public mMApiFkField ReportTemplate;
        // Order rows.
        public List<OrderRow> OrderRows;
        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;
        
        }
        /// Order row details.
        public class OrderRow
        {
            // Order row id.
            public Long OrderRowId;
            // Order.
            public mMApiFkField Order;
            // Item.
            public mMApiFkField Item;
            //   Warehouse.<br/>
            // Input allowed if inventory discharge is enabled. (Company's settings).
            public mMApiFkField Warehouse;
            // Item name.
            public String ItemName;
            // Item code.
            public String ItemCode;
            // Item description.
            public String Description;
            // Quantity.
            public Double Quantity;
            // Discount value in percent.
            public Double DiscountPercent;
            // Price.
            public Double Price;
            // Item unit of measurement.
            public String UnitOfMeasurement;
            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;
            
            }