The Inventory object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Inventory endpoint, you can retrieve a list of all products and services for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the inventory item, unique for the business in the accounting service. |
| name sortable, filterable | string | Name of the inventory item. |
| code sortable, filterable | string | Reference code of the inventory item. |
| type sortable, filterable | string | Type of the inventory item. |
| quantityOnHand | array | Quantity of the inventory item on hand at each location. Quantity on hand. |
| status sortable, filterable | string | Current status of the inventory item. |
| isBillItem sortable, filterable | boolean | Specifies whether the inventory item can be associated with a bill (when it was purchased). |
| billItem | object | Inventory item details associated with a bill (when the item was purchased). |
| isInvoiceItem sortable, filterable | boolean | Specifies whether the inventory item can be associated with an invoice (when it was sold). |
| invoiceItem | object | Inventory item details associated with an invoice (when the item was sold). |
| sourceModifiedDate sortable, filterable | string See Date | Date the record was last changed in the accounting service provider. |
Xero Limitations
Due to a limitation in Xero's API, all items from Xero are mapped as
unknown.
QuickBooks Online Limitations
Due to a limitation in QBO's APO, non-inventory items can not be pushed to QuickBooks Online.
Quantity On Hand
| Field | Type | Description |
|---|---|---|
| locationRef | Reference Types | Reference to the location the inventory is located at |
| quantity sortable, filterable | integer | The quantity of the inventory at the referenced location. |
| accountRef | Reference Types | Reference to the Inventory account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. |
Bill Item
| Field | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| unitPrice sortable, filterable | decimal | Line item unit amount. |
| accountRef | Reference Types | Reference to the account the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
Invoice Item
| Field | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| unitPrice sortable, filterable | decimal | Line item unit amount. |
| accountRef | Reference Types | Reference to the account the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
The Inventory Reference Object
Data types that reference an inventory, for example, invoice and bills, use an inventoryRef that includes the id and name of the linked inventory.
Using Inventory Reference in Push
For convenience, when pushing data
inventoryRefcan be used alone with theidas a value instead of nesting it within.When pushing to Xero, use
codeas a value.