item resource type
Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.
Represents an item in Dynamics 365 Business Central.
Note
For information about enabling APIs for Dynamics NAV see Enabling the APIs for Dynamics 365 Business Central.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET item | item | Gets a item object. |
| DELETE item | none | Deletes a item object. |
| POST item | item | Creates a item object. |
| PATCH item | item | Updates a item object. |
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| itemCategory | itemCategory | Gets the itemcategory of the item. |
| unitOfMeasure | unitOfMeasure | Gets the unitofmeasure of the item. |
| picture | picture | Gets the picture of the item. |
| defaultDimensions | defaultDimensions | Gets the defaultdimensions of the item. |
| itemVariants | itemVariants | Gets the itemvariants of the item. |
Properties
| Property | Type | Description |
|---|---|---|
| id | GUID | The unique ID of the item. Non-editable. |
| number | string | Specifies the number of the item. |
| displayName | string | Specifies the item's name. This name will appear on all sales documents for the item. |
| type | NAV.itemType | Specifies the type of the item. It can be "Inventory", "Service" or "Non-Inventory". |
| itemCategoryId | GUID | The ID of the item category in the item. |
| itemCategoryCode | string | The code of the item category in the item. |
| blocked | boolean | Specifies that entries cannot be posted to the item. True indicates account is blocked and posting is not allowed. |
| gtin | string | This is the Global Trade Item Number. |
| inventory | decimal | Specifies how many units, such as pieces, boxes, or cans, of the item are in inventory. Read-Only. |
| unitPrice | decimal | Specifies the price for one unit of the item in the specified item. |
| priceIncludesTax | boolean | Specifies that the unitPrice includes tax. Set to true, if unitPrice includes tax. |
| unitCost | decimal | The unit cost of each individual item in the item. |
| taxGroupId | GUID | Specifies the ID of the Tax Group for the item. |
| taxGroupCode | string | A Tax Group represents a group of inventory items or resources that are subject to identical tax terms. |
| baseUnitOfMeasureId | GUID | Specifies the ID of the unit of measure. |
| baseUnitOfMeasureCode | string | The item's base unit of measure code. |
| lastModifiedDateTime | datetime | The last datetime the item was modified. Read-Only. |
JSON representation
Here is a JSON representation of the item resource.
{
"id": "GUID",
"number": "string",
"displayName": "string",
"type": "NAV.itemType",
"itemCategoryId": "GUID",
"itemCategoryCode": "string",
"blocked": "boolean",
"gtin": "string",
"inventory": "decimal",
"unitPrice": "decimal",
"priceIncludesTax": "boolean",
"unitCost": "decimal",
"taxGroupId": "GUID",
"taxGroupCode": "string",
"baseUnitOfMeasureId": "GUID",
"baseUnitOfMeasureCode": "string",
"lastModifiedDateTime": "datetime"
}