Even geduld a.u.b...

Exact Online REST API - Items

Endpoint

Items

Good to know

Use this endpoint to create, read, update and delete Items.
Add CustomDescriptionLanguage='[ NL | FR-BE | NL-BE | ... ]' to the header to retrieve language sensitive properties such as descriptions in a specific language.

Items are used in sales, purchase orders, shop orders, and more. You can organise Items into item groups, assortments, storage locations, and warehouses.
For more information about the Items functionality in Exact Online, see Working with items.


This endpoint is available for the following packages:


This entity supports webhooks.
Subscribe to the topic Items to get updates on the Items resource. You will also receive events on the Items resource.


This API allows to filter only on specific fields. Below you can see per field if it can be filtered on or not.
When you filter on a key field, there are two syntaxes possible which are both supported. In the example usage section you can see the two syntaxes which are supported.

Scope

Logistics items

URI

/api/v1/{division}/logistics/Items


GET POST PUT DELETE

Example usage

/api/v1/{division}/logistics/Items

/api/v1/{division}/logistics/Items

/api/v1/{division}/logistics/Items

/api/v1/{division}/logistics/Items

/api/v1/{division}/logistics/Items


Properties

Name Mandatory Value Value Type Webhook Filter Description
ID False Edm.Guid Mandatory filter A guid that is the unique identifier of the item
AverageCost False Edm.Double Supports webhook The current average cost price
Barcode False Edm.String Mandatory filter Barcode of the item (numeric string)
Class_01 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 1
Class_02 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 2
Class_03 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 3
Class_04 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 4
Class_05 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 5
Class_06 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 6
Class_07 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 7
Class_08 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 8
Class_09 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 9
Class_10 False Edm.String Supports webhook Mandatory filter Item class code referring to ItemClasses with ClassID 10
Code True Edm.String Supports webhook Mandatory filter Item code
CopyRemarks False Edm.Byte Supports webhook Copy sales remarks to sales lines
CostPriceCurrency False Edm.String Supports webhook The currency of the current and proposed cost price
CostPriceNew False Edm.Double Supports webhook Mandatory filter Proposed cost price
CostPriceStandard False Edm.Double Supports webhook The current standard cost price
Created False Edm.DateTime Mandatory filter Creation date
Creator False Edm.Guid User ID of creator
CreatorFullName False Edm.String Name of creator
CustomField False Edm.String Custom field endpoint. Provided only for the Exact Online Premium users.
Description True Edm.String Supports webhook Mandatory filter Description of the item
Division False Edm.Int32 Division code
EndDate False Edm.DateTime Supports webhook Mandatory filter Together with StartDate this determines if the item is active
ExtraDescription False Edm.String Supports webhook Mandatory filter Extra description text, slightly longer than the regular description (255 instead of 60)
FreeBoolField_01 False Edm.Boolean Supports webhook Mandatory filter Free boolean field 1
FreeBoolField_02 False Edm.Boolean Supports webhook Mandatory filter Free boolean field 2
FreeBoolField_03 False Edm.Boolean Supports webhook Mandatory filter Free boolean field 3
FreeBoolField_04 False Edm.Boolean Supports webhook Mandatory filter Free boolean field 4
FreeBoolField_05 False Edm.Boolean Supports webhook Mandatory filter Free boolean field 5
FreeDateField_01 False Edm.DateTime Supports webhook Mandatory filter Free date field 1
FreeDateField_02 False Edm.DateTime Supports webhook Mandatory filter Free date field 2
FreeDateField_03 False Edm.DateTime Supports webhook Mandatory filter Free date field 3
FreeDateField_04 False Edm.DateTime Supports webhook Mandatory filter Free date field 4
FreeDateField_05 False Edm.DateTime Supports webhook Mandatory filter Free date field 5
FreeNumberField_01 False Edm.Double Supports webhook Mandatory filter Free numeric field 1
FreeNumberField_02 False Edm.Double Supports webhook Mandatory filter Free numeric field 2
FreeNumberField_03 False Edm.Double Supports webhook Mandatory filter Free numeric field 3
FreeNumberField_04 False Edm.Double Supports webhook Mandatory filter Free numeric field 4
FreeNumberField_05 False Edm.Double Supports webhook Mandatory filter Free numeric field 5
FreeNumberField_06 False Edm.Double Supports webhook Mandatory filter Free numeric field 6
FreeNumberField_07 False Edm.Double Supports webhook Mandatory filter Free numeric field 7
FreeNumberField_08 False Edm.Double Supports webhook Mandatory filter Free numeric field 8
FreeTextField_01 False Edm.String Supports webhook Mandatory filter Free text field 1
FreeTextField_02 False Edm.String Supports webhook Mandatory filter Free text field 2
FreeTextField_03 False Edm.String Supports webhook Mandatory filter Free text field 3
FreeTextField_04 False Edm.String Supports webhook Mandatory filter Free text field 4
FreeTextField_05 False Edm.String Supports webhook Mandatory filter Free text field 5
FreeTextField_06 False Edm.String Supports webhook Mandatory filter Free text field 6
FreeTextField_07 False Edm.String Supports webhook Mandatory filter Free text field 7
FreeTextField_08 False Edm.String Supports webhook Mandatory filter Free text field 8
FreeTextField_09 False Edm.String Supports webhook Mandatory filter Free text field 9
FreeTextField_10 False Edm.String Supports webhook Mandatory filter Free text field 10
GLCosts False Edm.Guid Supports webhook Mandatory filter GL account the cost entries will be booked on. This overrules the GL account from the item group. If the license contains 'Intuit integration' this property overrides the value in Settings, not the item group.
GLCostsCode False Edm.String Code of GL account for costs
GLCostsDescription False Edm.String Description of GLCosts
GLRevenue False Edm.Guid Supports webhook Mandatory filter GL account the revenue will be booked on. This overrules the GL account from the item group. If the license contains 'Intuit integration' this property overrides the value in Settings, not the item group.
GLRevenueCode False Edm.String Code of GLRevenue
GLRevenueDescription False Edm.String Description of GLRevenue
GLStock False Edm.Guid Supports webhook Mandatory filter GL account the stock entries will be booked on. This overrules the GL account from the item group. If the license contains 'Intuit integration' this property overrides the value in Settings, not the item group.
GLStockCode False Edm.String Code of GL account for stock
GLStockDescription False Edm.String Description of GLStock
GrossWeight False Edm.Double Gross weight for international goods shipments
IsBatchItem False Edm.Byte Supports webhook Mandatory filter Indicates if batches are used for this item
IsBatchNumberItem False Edm.Byte This property is obsolete. Use property 'IsBatchItem' instead.
IsFractionAllowedItem False Edm.Boolean Supports webhook Mandatory filter Indicates if fractions (for example 0.35) are allowed for quantities of this item
IsMakeItem False Edm.Byte Supports webhook Mandatory filter Indicates that an Item is produced to Inventory, not purchased
IsNewContract False Edm.Byte Supports webhook Only used for packages (IsPackageItem=1). To indicate if this package is a new contract type package
IsOnDemandItem False Edm.Byte Supports webhook Is On demand Item
IsPackageItem False Edm.Boolean Supports webhook Indicates if the item is a package item. Can only be created in the hosting administration
IsPurchaseItem False Edm.Boolean Supports webhook Mandatory filter Indicates if the item can be purchased
IsRegistrationCodeItem False Edm.Byte Supports webhook Indicated if the item is used in voucher functionality
IsSalesItem False Edm.Boolean Supports webhook Mandatory filter Indicates if the item can be sold
IsSerialItem False Edm.Boolean Supports webhook Mandatory filter Indicates that serial numbers are used for this item
IsSerialNumberItem False Edm.Boolean This property is obsolete. Use property 'IsSerialItem' instead.
IsStockItem False Edm.Boolean Supports webhook Mandatory filter If you have the Trade or Manufacturing license and you check this property the item will be shown in the stock positions overview, stock counts and transaction lists. If you have the Invoice module and you check this property you will get a general journal entry based on the Stock and Costs G/L accounts of the item group. If you don’t want the general journal entry to be created you should change the Stock/Costs G/L account on the Item group page to the type Costs instead of Inventory.
IsSubcontractedItem False Edm.Boolean Supports webhook Mandatory filter Indicates if the item is provided by an outside supplier
IsTaxableItem False Edm.Byte Indicates if tax needs to be calculated for this item
IsTime False Edm.Byte Supports webhook Mandatory filter Indicates if the item is a time unit item (for example a labor hour item)
IsWebshopItem False Edm.Byte Supports webhook Mandatory filter Indicates if the item can be exported to a web shop
ItemGroup False Edm.Guid Supports webhook Mandatory filter GUID of Item group of the item
ItemGroupCode False Edm.String Mandatory filter Code of ItemGroup
ItemGroupDescription False Edm.String Description of ItemGroup
Modified False Edm.DateTime Mandatory filter Last modified date
Modifier False Edm.Guid User ID of modifier
ModifierFullName False Edm.String Name of modifier
NetWeight False Edm.Double Supports webhook Net weight for international goods shipments
NetWeightUnit False Edm.String Mandatory filter Net Weight unit for international goods shipment, only available in manufacturing packages
Notes False Edm.String Supports webhook Notes
PictureName False Edm.String Supports webhook File name of picture
PictureThumbnailUrl False Edm.String Url where thumbnail picture can be retrieved
PictureUrl False Edm.String Url where picture can be retrieved
SalesVatCode False Edm.String Supports webhook Mandatory filter Code of SalesVat
SalesVatCodeDescription False Edm.String Description of SalesVatCode
SearchCode False Edm.String Supports webhook Mandatory filter Search code of the item
SecurityLevel False Edm.Int32 Supports webhook Security level (0 - 100)
StandardSalesPrice False Edm.Double Standard sales price
StartDate False Edm.DateTime Supports webhook Mandatory filter Together with EndDate this determines if the item is active
StatisticalCode False Edm.String Statistical code
StatisticalNetWeight False Edm.Double Statistical net weight
StatisticalUnits False Edm.Double Statistical units
StatisticalValue False Edm.Double Statistical value
Stock False Edm.Double Quantity that is in stock
Unit False Edm.String Supports webhook Mandatory filter The standard unit of this item
UnitDescription False Edm.String Description of Unit
UnitType False Edm.String Type of unit: A=Area, L=Length, O=Other, T=Time, V=Volume, W=Weight

Returns