items resource type (v1.0)

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

Represents an item in Business Central.

Note


For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET itemitemsGets an item object.
POST itemitemsCreates an item object.
PATCH itemitemsUpdates an item object.
DELETE itemnoneDeletes an item object.
NavigationReturn TypeDescription
PicturepictureGets the picture of item.
DefaultDimensiondefaultDimensionGets the defaultDimension of item.
ItemCategoryitemCategoryGets the item catgory of item.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the item. Non-editable.
numberstringThe item number.
displayNamestringSpecifies a description of the item.
typestringThe inventory type for the item; Inventory, Service, and Non-Inventory. This is a required property.
blockedbooleanSpecifies that transactions with the item cannot be posted, for example, because the item is in quarantine. Set to true, if item is blocked.
baseUnitOfMeasureIdGUIDSpecifies the ID of the unit of measure.
baseUnitOfMeasureNAV.UnitOfMeasureSpecifies the unit in which the item is held in inventory.
gtinnumericThis is the Global Trade Item Number.
itemCategoryNAV.ItemCategorySpecifies the category that the item belongs to.
inventorydecimalSpecifies how many units, such as pieces, boxes, or cans, of the item are in inventory. Read-Only.
unitPricedecimalSpecifies the price for one unit of the item in the specified currency.
priceIncludesTaxbooleanSpecifies that the unitPrice includes tax. Set to true, if unitPrice includes tax.
unitCostdecimalSpecifies the cost per unit of the item.
taxGroupIdGUIDSpecifies the ID of the Tax Group for the item.
taxGroupCodenumericA Tax Group represents a group of inventory items or resources that are subject to identical tax terms.
lastModifiedDateTimedatetimeThe last datetime the item was modified. Read-Only.

Relationships

A Tax Group(taxGroupCode) must exist in the Tax Group table.

JSON representation

Here is a JSON representation of the resource.

{
      "id": "GUID",
      "number": "string",
      "displayName": "string",
      "type": "string",
      "blocked": "boolean",
      "baseUnitOfMeasureId": "GUID",
      "baseUnitOfMeasure": "NAV.UnitOfMeasure",
      "gtin": "numeric",
      "itemCategory": "NAV.ItemCategory",
      "inventory": "decimal",
      "unitPrice": "decimal",
      "priceIncludesTax": "boolean",
      "unitCost": "decimal",
      "taxGroupId": "GUID",
      "taxGroupCode": "string",
      "lastModifiedDateTime": "datetime"
}

Error Codes
Item
Get Item
Post Item
Patch Item
Delete Item