Relative request path: | api/orgs/{organisationId}/items/{itemId} |
Property | Description |
---|---|
organisationId | organisation id |
itemId |
Request parameters:
Request parameters:
Request parameters:
Property | Description |
---|---|
ItemId | Item id. Mandatory. |
Name | Item name. Mandatory. Max length: 250. |
Code | Item code. Optional. Max length: 30. |
EANCode | EAN code. Optional. Max length: 30. |
Description | Item description. Optional. Max length: 8000. |
ItemType | Possible values: (B, M, P, I, S, A, AS). Item type:
|
StocksManagedOnlyByQuantity | Possible values: (D, N). Defines whether are stocks managed only by quantity.
Default value: N. Optional. Max length: 2. |
CalculationOfConsumptionTax | Possible values: (D, N). Defines whether consumption tax for an item is calculated or not
Default value: N. Optional. Max length: 1. |
UnitOfMeasurement | Item unit of measurement. Optional. Max length: 3. |
MassPerUnit | Mass per unit. Optional. |
ProductGroup | class ProductGroup. Item product group. Optional. |
VatRate | class VatRate. Item VAT rate. Mandatory. |
Price | Item selling price. Optional. |
RebatePercent | Margin percent. Optional. |
Usage | Possible values: (D, N). Usage:
|
Currency | class Currency. Selling price currency. Optional. |
SerialNumbers | Possible values: (D, N). SerialNumbers:
|
BatchNumbers | Possible values: (D, N). BatchNumbers:
|
RevenueAccountDomestic | class Account. Domestic market revenue account. Optional. |
RevenueAccountEU | class Account. Revenue account for EU markets. Optional. |
RevenueAccountOutsideEU | class Account. Revenue account outside EU markets. Optional. |
StocksAccount | class Account. Stock account. Optional. |
ReliefByCompositeFromWarehouse | Possible values: (D, N). Article relief by composite when issuing from warehouse:
|
ReliefByCompositeFromIssuedInvoice | Possible values: (D, N). Article relief by composite from issued invoice:
|
Composite | Composite rows. List of ItemComposite. |
RecordDtModified | Optional. |
RowVersion | Row version is used for concurrency check. |
This method returns result of type 'SAOP.API.Models.Item.Item'.
/// Item details.
public class Item
{
// Item id.
// Mandatory field. Ignored on create request.
public long ItemId { get; set; }
// Item name.
// Mandatory field. Max length: 250
public string Name { get; set; }
// Item code.
// Max length: 30
public string Code { get; set; }
// EAN code.
// Max length: 30
public string EANCode { get; set; }
// Item description.
// Max length: 8000
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>
// Mandatory field. Max length: 2
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.
// Max length: 2
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.
// Max length: 1
public string CalculationOfConsumptionTax { get; set; }
// Item unit of measurement.
// Max length: 3
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>
// Max length: 1
public string Usage { get; set; }
// Selling price currency.
public mMApiFkField Currency { get; set; }
// SerialNumbers:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public string SerialNumbers { get; set; }
// BatchNumbers:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
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>
// Max length: 1
public string ReliefByCompositeFromWarehouse { get; set; }
// Article relief by composite from issued invoice:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public string ReliefByCompositeFromIssuedInvoice { get; set; }
// Composite rows.
public List<ItemComposite> Composite { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Mandatory field. 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.
// Mandatory field. Ignored on create request.
public $ItemId;
// Item name.
// Mandatory field. Max length: 250
public $Name;
// Item code.
// Max length: 30
public $Code;
// EAN code.
// Max length: 30
public $EANCode;
// Item description.
// Max length: 8000
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>
// Mandatory field. Max length: 2
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.
// Max length: 2
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.
// Max length: 1
public $CalculationOfConsumptionTax;
// Item unit of measurement.
// Max length: 3
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>
// Max length: 1
public $Usage;
// Selling price currency.
public $Currency;
// SerialNumbers:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public $SerialNumbers;
// BatchNumbers:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
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>
// Max length: 1
public $ReliefByCompositeFromWarehouse;
// Article relief by composite from issued invoice:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public $ReliefByCompositeFromIssuedInvoice;
// Composite rows.
public $Composite;
public $RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. 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.
// Mandatory field. Ignored on create request.
public Long ItemId;
// Item name.
// Mandatory field. Max length: 250
public String Name;
// Item code.
// Max length: 30
public String Code;
// EAN code.
// Max length: 30
public String EANCode;
// Item description.
// Max length: 8000
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>
// Mandatory field. Max length: 2
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.
// Max length: 2
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.
// Max length: 1
public String CalculationOfConsumptionTax;
// Item unit of measurement.
// Max length: 3
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>
// Max length: 1
public String Usage;
// Selling price currency.
public mMApiFkField Currency;
// SerialNumbers:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public String SerialNumbers;
// BatchNumbers:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
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>
// Max length: 1
public String ReliefByCompositeFromWarehouse;
// Article relief by composite from issued invoice:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public String ReliefByCompositeFromIssuedInvoice;
// Composite rows.
public List<ItemComposite> Composite;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. 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;
}