Items & Inventory Endpoints

Items & Inventory

---

Item

GET /Item — List Items

Returns multiple Item records. Requires authentication.

Parameter	Type	Description
activeinactive	string	Filter on active/inactive items — comma separated, first value true/false for active, second for inactive
advanced_search	string	Advanced search string
assetgroup_id	integer	Filter by Items belonging to a particular Asset group
assetgroups	string	Filter Items on asset groups, comma separated IDs
assettypes	string	Filter Items on asset types, comma separated IDs
autotask_service_items	boolean	Include only AutoTask service Items in the response
count	integer	Number of items to return in the response
dbc_company_id	string	Filter by Dynamics Business Central company ID
exactdivision	integer	Filter by Exact division ID
excluderecurring	boolean	Exclude recurring Items in the response
includeactive	boolean	Include active Items in the response
includeinactive	boolean	Include inactive Items in the response
include_custom_fields	string	Comma separated list of Custom Field IDs to include in the response
itemservice_id	integer	Filter by item service ID
itemservicerequestdetails_id	integer	Filter by item service request details ID
itemsupplierclientid	integer	Filter by Items belonging to a supplier client
itemsuppliercurrency	integer	Return Item price with the specified currency (otherwise return standard price)
kashflowtenantid	integer	Filter by Items belonging to a particular KashFlow tenant
order	string	Field name to order by (first)
order2	string	Field name to order by (second)
order3	string	Field name to order by (third)
order4	string	Field name to order by (fourth)
order5	string	Field name to order by (fifth)
orderdesc	boolean	Whether to order descending on first order field
orderdesc2	boolean	Whether to order descending on second order field
orderdesc3	boolean	Whether to order descending on third order field
orderdesc4	boolean	Whether to order descending on fourth order field
orderdesc5	boolean	Whether to order descending on fifth order field
page_no	integer	Page number when using pagination
page_size	integer	Page size when using pagination
pageinate	boolean	Whether to use pagination in the response
qbitemsonly	boolean	Include only QuickBooks Items in the response
qbocompanyid	string	Filter by Items QuickBooks Online company ID
recurringonly	boolean	Include only recurring Items in the response
sagebusinesscloudtenantid	integer	Filter by Sage Business Cloud tenant ID
search	string	Filter response based on the search string
search1	string	Additional search string
show_not_in_stock	boolean	Include Items not in stock in the response
stocklocation_id	integer	Filter by Items belonging to a particular stock location
supplier_id	integer	Filter by Items belonging to a particular supplier
xerotenantid	string	Filter by Items Xero tenant ID

---

POST /Item — Create/Update Items

Request body: array of Item objects.

---

GET /Item/{id} — Get One Item

Returns a single Item record. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	Item ID
dbc_company_id	string	Dynamics Business Central company ID
includedetails	boolean	Include extra objects in the response
kashflowtenantid	integer	KashFlow tenant ID
qbocompanyid	string	QuickBooks Online company ID
sagebusinesscloudtenantid	integer	Sage Business Cloud tenant ID
xerotenantid	string	Xero tenant ID

---

DELETE /Item/{id} — Delete Item

Parameter	Type	Description
id	integer (path, required)	Item ID

---

POST /Item/NewAccountsId — Assign New Accounts ID

Request body: array of Item objects.

---

Item Schema

Key fields on the Item object:

Field	Type	Description
id	integer	Unique item ID
name	string	Item name
use	string	Item use/category
status	integer	Active status
description	string	Item description
purchase_description	string	Description used on purchase orders
internalreference	string	Internal reference code
externalreference	string	External reference code
baseprice	double	Base selling price
costprice	double	Cost price
secondprice	double	Secondary price
recurringprice	double	Recurring billing price
recurringcost	double	Recurring cost
sleeveprice	double	Sleeve/wrapper price
margin	double	Margin percentage
markupperc	double	Markup percentage
taxcode	integer	Tax code ID
taxcode_name	string	Tax code name
assetgroup_id	integer	Asset group ID
assetgroup_name	string	Asset group name
assettype_id	integer	Asset type ID
assettype_name	string	Asset type name
supplier_id	integer	Default supplier ID
supplier_name	string	Default supplier name
supplier_part_code	string	Supplier part code
manufacturer_id	integer	Manufacturer ID
manufacturer_name	string	Manufacturer name
quantity_in_stock	double	Current quantity in stock
quantity_reserved	double	Quantity reserved
quantity_on_order	double	Quantity on order
minstockqty	double	Minimum stock quantity threshold
reorderqty	double	Reorder quantity
isrecurringitem	boolean	Whether this is a recurring item
ismeteritem	boolean	Whether this is a meter item
iscontractitem	boolean	Whether this is a contract item
dontinvoice	boolean	Whether to exclude from invoicing
dont_track_stock	boolean	Whether to skip stock tracking
promptforprice	boolean	Whether to prompt for price on use
nominalcode	string	Nominal/GL code for sales
purchasenominalcode	string	Nominal/GL code for purchases
taxable	boolean	Whether the item is taxable
customfields	array	Custom field values
item_suppliers	array	Supplier pricing records (ItemSupplier)
stocklocations	array	Stock location records
use_tiered_pricing	boolean	Whether tiered pricing is enabled
tiered_pricing	array	Tiered pricing tiers
datecreated	date-time	Date the item was created
lastmodified	date-time	Date the item was last modified
weight	double	Item weight
icon	string	Icon identifier
icon_download_url	string	URL to download item icon

---

ItemAccountsLink

Links Items to external accounting system records.

GET /ItemAccountsLink — List Item Accounts Links

Returns all ItemAccountsLink records.

POST /ItemAccountsLink — Create/Update Item Accounts Links

Request body: array of ItemAccountsLink objects.

GET /ItemAccountsLink/{id} — Get One Item Accounts Link

Parameter	Type	Description
id	integer (path, required)	ItemAccountsLink ID

DELETE /ItemAccountsLink/{id} — Delete Item Accounts Link

Parameter	Type	Description
id	integer (path, required)	ItemAccountsLink ID

POST /ItemAccountsLink/Migrate — Migrate Item Accounts Links

Request body: array of ItemAccountsLinkMigration objects.

ItemAccountsLinkMigration schema:

Field	Type	Description
id	integer	Record ID
backgroundTask	boolean	Whether to run as a background task

ItemAccountsLink schema:

Field	Type	Description
id	integer	Record ID
halo_id	integer	Halo internal ID
module_id	integer	Accounting module ID
accounts_id	string	External accounts system ID
tenant_id	string	Tenant ID in the accounting system
qbo_category_id	string	QuickBooks Online category ID
qbo_category_name	string	QuickBooks Online category name
asset_account	integer	Asset account code
asset_account_name	string	Asset account name
income_account	string	Income/revenue account code
income_account_name	string	Income account name
expense_account	string	Expense account code
expense_account_name	string	Expense account name
linked_item_id	integer	Linked item ID
linked_item_name	string	Linked item name
is_primary	boolean	Whether this is the primary accounts link
taxcode	integer	Sales tax code
taxcode_name	string	Sales tax code name
purchase_taxcode	integer	Purchase tax code
purchase_taxcode_name	string	Purchase tax code name
tenant_name	string	Tenant name in the accounting system

---

ItemGroup

Groups of items that can be added together to quotes and invoices.

GET /ItemGroup — List Item Groups

Returns all ItemGroup records.

POST /ItemGroup — Create/Update Item Groups

Request body: array of ItemGroup objects.

GET /ItemGroup/{id} — Get One Item Group

Returns a single ItemGroup. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	ItemGroup ID
groupQuantity	integer	Override quantity for group items
includedetails	boolean	Include extra objects in the response

DELETE /ItemGroup/{id} — Delete Item Group

Parameter	Type	Description
id	integer (path, required)	ItemGroup ID

ItemGroup schema:

Field	Type	Description
id	integer	Unique group ID
name	string	Group name
lines	array	QuotationDetail line items in this group
invoice_lines	array	InvoiceDetail line items in this group
hideitems	boolean	Whether to hide individual items in the group
add_all_group_items_quote	integer	Behavior for adding all group items to quotes
quantity_group_items_quote	integer	Default quantity behavior for group items
hide_grouped_items_price	integer	Whether to hide individual prices for grouped items
category	string	Group category
nominal_code	string	Nominal/GL code for the group
force_quantity_relationship	boolean	Whether to force quantity relationship between items
force_price_relationship	boolean	Whether to force price relationship between items
force_term_relationship	boolean	Whether to force term relationship between items
price_calculation_formula	string	Formula for calculating group price
type	integer	Group type
default_billingperiod	integer	Default billing period
allow_users	boolean	Whether to allow user-facing selection
note	string	Group note

---

ItemStock

Tracks physical stock records for items.

GET /ItemStock — List Item Stock Records

Returns multiple ItemStock records. Requires authentication.

Parameter	Type	Description
count	integer	Number of records to return
idonly	boolean	Return IDs only
item_id	integer	Filter by item ID
order	string	Field name to order by (first)
order2–order5	string	Additional order fields
orderdesc–orderdesc5	boolean	Descending order flags
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Whether to use pagination
stockbin_id	integer	Filter by stock bin ID
stocklocation_id	integer	Filter by stock location ID