v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Item

Retrieves a Item resource.

get/items/{id}

Path parameters

idstring required

Resource identifier

Response

Item resource

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

namestring nullable

Name of the item

directorystring nullable

Item directory

typestring nullable

Specifies use of the item e.g. Inventory

quantitystring nullable

Number of items in inventory

skustring nullable

Stock keeping unit

salesTaxIncludedboolean nullable

Boolean on if price includes sales tax

purchaseTaxIncludedboolean nullable

Boolean on if price includes purchase tax

descriptionstring nullable

Description of item

activeboolean nullable

Boolean on if item is in use

createdstring date-time nullable

Date entry was created

modifiedstring date-time nullable

Date entry was last modified

AvailableForSalestring nullable

If the item is available for sale

AvailableForPurchasestring nullable

If the item is available for purchase

UnitpriceSaleinteger nullable

Price per unit sale

UnitpricePurchaseinteger nullable

Price per unit purchase

TaxtypeSalestring nullable

Tax type per sale

TaxtypePurchasestring nullable

Tax type per purchase

availableForSalestring nullable

availableForPurchasestring nullable

unitpriceSaleinteger nullable

unitpricePurchaseinteger nullable

taxtypeSalestring nullable

taxtypePurchasestring nullable

Example response

{
  "integration": "quickbooks"
}