ItemSummary
Name | Description | Type | Additional information |
---|---|---|---|
Id | The Unique Id/key for the resource. | integer |
None. |
Code | The code for this item. | string |
None. |
Description | The description for this item. | string |
None. |
Type | The type of this item. Supported types are 'I' = Inventory item, 'C' = Combo item. | string |
None. |
IsActive | Indicates if the item is active. | boolean |
None. |
IsInventoried | Indicates if the item is inventoried. | boolean |
None. |
AssetAccountId | The associated asset account id. | integer |
None. |
IsSold | Indicates if the item is sold. | boolean |
None. |
SaleIncomeAccountId | The associated sale income account id. | integer |
None. |
SaleTaxCodeId | The associated sale tax code id. | integer |
None. |
SaleCoSAccountId | The associated cost of sale account id. | integer |
None. |
IsBought | Indicates if the item is bought. | boolean |
None. |
PurchaseExpenseAccountId | The associated purchase expense account id. | integer |
None. |
PurchaseTaxCodeId | The associated purchase tax code id. | integer |
None. |
MinimumStockLevel | The minimumm stock level allowed. | decimal number |
None. |
StockOnHand | The current stock on hand. This data is returned only and cannot be added or updated when issuing a POST or PUT. | decimal number |
None. |
CurrentValue | The current value of the item. This data is returned only and cannot be added or updated when issuing a POST or PUT. | decimal number |
None. |
PrimarySupplierContactId | The primary supplier's contact id (if any). | integer |
None. |
PrimarySupplierItemCode | The primary supplier's item code. | string |
None. |
DefaultReOrderQuantity | The default re-order quantity when the minimum stock level is reached. | decimal number |
None. |
LastUpdatedId | The unique id generated after an update that is required to be passed in when next updating this resource to ensure consistency. | string |
None. |
IsVisible | Indicates if this item is visible. | boolean |
None. |
IsVirtual | Indicate if this is a virtual item. | boolean |
None. |
VType | Indicates the 'virtual type' of the item. | string |
None. |
SellingPrice | The selling price of the item. | decimal number |
None. |
IsSellingPriceIncTax | Indicates if the selling price includes tax. | boolean |
None. |
CreatedDateUtc | The date and time that the item was created in UTC. | date |
None. |
LastModifiedDateUtc | The date and time that the item was modified in UTC. | date |
None. |
LastModifiedBy | The user id that last modified this item. | integer |
None. |
BuyingPrice | The buying price of this item. | decimal number |
None. |
IsBuyingPriceIncTax | Indicates if the buying price includes tax. | boolean |
None. |
IsVoucher | Indicates if the item represens a voucher. | boolean |
None. |
ValidFrom | If this item is a voucher (IsVoucher = true), this indicates the date and time that the voucher item is valid from. | date |
None. |
ValidTo | If this item is a voucher (IsVoucher = true), this indicates the date and time that the voucher item is valid to. | date |
None. |
OnOrder | The number of items currently on order. | decimal number |
None. |
Committed | The number of items currently committed. | decimal number |
None. |
_links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |