Inventory

Creates a new inventory/product item.

post/api/Inventory

Request body

Namestring

Name of the inventory item. Required. Max 200 characters. Must be unique within the account.

SKUstring

Stock Keeping Unit code. Max 100 characters. When provided, must be unique within the account.

Descriptionstring

Detailed description of the item. Plain UTF8 text. Max 1000 characters.

SalePricenumber double

The default sale price of the item, in the account currency. Must be zero or greater.

SaleTaxIDFKinteger

The default tax rate ID applied when selling this item. Must be the TaxID of a tax belonging to the account.

isHiddenboolean

Set to true to hide this item from the item pickers on invoices and estimates ("Hide from Invoicing"). Defaults to false.

CostPricenumber double

The default cost/purchase price of the item, in the account currency. Must be zero or greater.

PurchaseTaxIDFKinteger

The default tax rate ID applied when purchasing this item. Must be the TaxID of a tax belonging to the account.

isHiddenOnBillboolean

Set to true to hide this item from the item pickers on bills ("Hide from Bills"). Defaults to false.

Response

Returns the created inventory item.

InventoryItemIDinteger

Unique identifier for the inventory/product item.

Namestring

Name of the inventory item.

Descriptionstring

Detailed description of the item.

SKUstring

Stock Keeping Unit code.

CostPricenumber double

The cost/purchase price of the item.

SalePricenumber double

The default sale price of the item.

SaleTaxIDFKinteger

The default tax rate ID applied when selling this item.

PurchaseTaxIDFKinteger

The default tax rate ID applied when purchasing this item (used on bills).

isHiddenboolean

Whether this item is hidden from the item pickers on invoices and estimates ("Hide from Invoicing").

isHiddenOnBillboolean

Whether this item is hidden from the item pickers on bills ("Hide from Bills").

DateCreatedstring date-time

Date the item was created.

DateUpdatedstring date-time

Date the item was last updated.

Changes

Changed in 1 of the 3 revisions of this API.1