API Documentation

Request parameters:

• long organisationId - organisation id
• string code - item code

Request parameters:

• Int64 organisationId - organisation id
• String code - item code

Request parameters:

• Long organisationId - organisation id
• String code - item code

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

    /// Item details.
    public class Item
    {
        // Item id.
        // Ignored on create request.
        public long ItemId { get; set; }
        // Item name.
        public string Name { get; set; }
        // Item code.
        public string Code { get; set; }
        // EAN code.
        public string EANCode { get; set; }
        // Item description.
        public string Description { get; set; }
        // <br />Item type:
        // <ul>
        //     <li>B – Goods,</li>
        //     <li>M – Material,</li>
        //     <li>P - Semifinished product,</li>
        //     <li>I – Product,</li>
        //     <li>S – Services,</li>
        //     <li>A - Advance payment,</li>
        //     <li>AS - Pre payments for services</li>
        // </ul>
        public string ItemType { get; set; }
        // Defines whether are stocks managed only by quantity.
        // <ul>
        //     <li>N - stocks are managed by quantity and value</li>
        //     <li>D - stocks are managed only by quantity</li>
        // </ul>
        // <br />
        // Default value: N.
        public string StocksManagedOnlyByQuantity { get; set; }
        // Defines whether consumption tax for an item is calculated or not
        // <ul>
        //     <li>N – consumption tax is not calculated</li>
        //     <li>D - consumption tax is calculated</li>
        // </ul>
        // <br />
        // Default value: N.
        public string CalculationOfConsumptionTax { get; set; }
        // Item unit of measurement.
        public string UnitOfMeasurement { get; set; }
        // Mass per unit.
        public Decimal MassPerUnit { get; set; }
        // Item product group.
        public mMApiFkField ProductGroup { get; set; }
        // Item VAT rate.
        public mMApiFkField VatRate { get; set; }
        // Item selling price.
        public Decimal Price { get; set; }
        // Margin percent.
        public Decimal RebatePercent { get; set; }
        // Usage:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public string Usage { get; set; }
        // Selling price currency.
        public mMApiFkField Currency { get; set; }
        // SerialNumbers:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public string SerialNumbers { get; set; }
        // BatchNumbers:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public string BatchNumbers { get; set; }
        // Domestic market revenue account.
        public mMApiFkField RevenueAccountDomestic { get; set; }
        // Revenue account for EU markets.
        public mMApiFkField RevenueAccountEU { get; set; }
        // Revenue account outside EU markets.
        public mMApiFkField RevenueAccountOutsideEU { get; set; }
        // Stock account.
        public mMApiFkField StocksAccount { get; set; }
        // Article relief by composite when issuing from warehouse:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public string ReliefByCompositeFromWarehouse { get; set; }
        // Article relief by composite from issued invoice:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public string ReliefByCompositeFromIssuedInvoice { get; set; }
        // Composite rows.
        public List<ItemComposite> Composite { get; set; }
        // Packaging quantity for deposit return.
        public int PackagingDepositReturnQuantity { 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; }
        
        }
        /// Returns items title, code, price and unit of measurement for the given item
        public class ItemComposite
        {
            // Item id.
            public mMApiFkField Item { get; set; }
            // Quantity.
            public Decimal Quantity { 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.Item.Item'.

    /// Item details.
    class Item
    {
        // Item id.
        // Ignored on create request.
        public $ItemId;
        // Item name.
        public $Name;
        // Item code.
        public $Code;
        // EAN code.
        public $EANCode;
        // Item description.
        public $Description;
        // <br />Item type:
        // <ul>
        //     <li>B – Goods,</li>
        //     <li>M – Material,</li>
        //     <li>P - Semifinished product,</li>
        //     <li>I – Product,</li>
        //     <li>S – Services,</li>
        //     <li>A - Advance payment,</li>
        //     <li>AS - Pre payments for services</li>
        // </ul>
        public $ItemType;
        // Defines whether are stocks managed only by quantity.
        // <ul>
        //     <li>N - stocks are managed by quantity and value</li>
        //     <li>D - stocks are managed only by quantity</li>
        // </ul>
        // <br />
        // Default value: N.
        public $StocksManagedOnlyByQuantity;
        // Defines whether consumption tax for an item is calculated or not
        // <ul>
        //     <li>N – consumption tax is not calculated</li>
        //     <li>D - consumption tax is calculated</li>
        // </ul>
        // <br />
        // Default value: N.
        public $CalculationOfConsumptionTax;
        // Item unit of measurement.
        public $UnitOfMeasurement;
        // Mass per unit.
        public $MassPerUnit;
        // Item product group.
        public $ProductGroup;
        // Item VAT rate.
        public $VatRate;
        // Item selling price.
        public $Price;
        // Margin percent.
        public $RebatePercent;
        // Usage:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public $Usage;
        // Selling price currency.
        public $Currency;
        // SerialNumbers:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public $SerialNumbers;
        // BatchNumbers:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public $BatchNumbers;
        // Domestic market revenue account.
        public $RevenueAccountDomestic;
        // Revenue account for EU markets.
        public $RevenueAccountEU;
        // Revenue account outside EU markets.
        public $RevenueAccountOutsideEU;
        // Stock account.
        public $StocksAccount;
        // Article relief by composite when issuing from warehouse:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public $ReliefByCompositeFromWarehouse;
        // Article relief by composite from issued invoice:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public $ReliefByCompositeFromIssuedInvoice;
        // Composite rows.
        public $Composite;
        // Packaging quantity for deposit return.
        public $PackagingDepositReturnQuantity;
        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;
        
        }
        /// Returns items title, code, price and unit of measurement for the given item
        class ItemComposite
        {
            // Item id.
            public $Item;
            // Quantity.
            public $Quantity;
        
        }

            /// 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.Item.Item'.

    /// Item details.
    public class Item
    {
        // Item id.
        // Ignored on create request.
        public Long ItemId;
        // Item name.
        public String Name;
        // Item code.
        public String Code;
        // EAN code.
        public String EANCode;
        // Item description.
        public String Description;
        // <br />Item type:
        // <ul>
        //     <li>B – Goods,</li>
        //     <li>M – Material,</li>
        //     <li>P - Semifinished product,</li>
        //     <li>I – Product,</li>
        //     <li>S – Services,</li>
        //     <li>A - Advance payment,</li>
        //     <li>AS - Pre payments for services</li>
        // </ul>
        public String ItemType;
        // Defines whether are stocks managed only by quantity.
        // <ul>
        //     <li>N - stocks are managed by quantity and value</li>
        //     <li>D - stocks are managed only by quantity</li>
        // </ul>
        // <br />
        // Default value: N.
        public String StocksManagedOnlyByQuantity;
        // Defines whether consumption tax for an item is calculated or not
        // <ul>
        //     <li>N – consumption tax is not calculated</li>
        //     <li>D - consumption tax is calculated</li>
        // </ul>
        // <br />
        // Default value: N.
        public String CalculationOfConsumptionTax;
        // Item unit of measurement.
        public String UnitOfMeasurement;
        // Mass per unit.
        public Double MassPerUnit;
        // Item product group.
        public mMApiFkField ProductGroup;
        // Item VAT rate.
        public mMApiFkField VatRate;
        // Item selling price.
        public Double Price;
        // Margin percent.
        public Double RebatePercent;
        // Usage:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public String Usage;
        // Selling price currency.
        public mMApiFkField Currency;
        // SerialNumbers:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public String SerialNumbers;
        // BatchNumbers:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public String BatchNumbers;
        // Domestic market revenue account.
        public mMApiFkField RevenueAccountDomestic;
        // Revenue account for EU markets.
        public mMApiFkField RevenueAccountEU;
        // Revenue account outside EU markets.
        public mMApiFkField RevenueAccountOutsideEU;
        // Stock account.
        public mMApiFkField StocksAccount;
        // Article relief by composite when issuing from warehouse:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public String ReliefByCompositeFromWarehouse;
        // Article relief by composite from issued invoice:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no.</li>
        // </ul>
        public String ReliefByCompositeFromIssuedInvoice;
        // Composite rows.
        public List<ItemComposite> Composite;
        // Packaging quantity for deposit return.
        public Integer PackagingDepositReturnQuantity;
        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;
        
        }
        /// Returns items title, code, price and unit of measurement for the given item
        public class ItemComposite
        {
            // Item id.
            public mMApiFkField Item;
            // Quantity.
            public Double Quantity;
        
        }

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