The Inventory Object
From the Inventory endpoint, you can retrieve a list of all products and services for a specified business.
| Field | Type | Description |
|---|---|---|
| id | string | Identifier for the inventory item, unique to the business in the accounting service provider. |
| name sortable, filterable | string | Name of the inventory item in the accounting service provider. |
| code sortable, filterable | string | Friendly reference for an inventory item. |
| quantityOnHandPerLocation | array | Quantity on hand per location. Not applicable if quantityOnHand is provided. |
| itemStatus sortable, filterable | string | Current statues of an inventory item. Can be:activearchivedunknown |
| isBillItem sortable, filterable | boolean | Indicates whether a business can use this item for bills. |
| billItem | object | Inventory details that are only for bills. |
| isInvoiceItem sortable, filterable | boolean | Indicates whether a business can use this item for invoices. |
| invoiceItem | object | Inventory details that are only for invoices. |
| subsidiaryRefs | Reference Types | The subsidiary the inventory item belongs to. |
| 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 Per Location
| Field | Type | Description |
|---|---|---|
| locationRef | Reference Types | Reference to the location the inventory is located at |
| quantity | integer | The quantity of the inventory at the referenced location. |
Bill Item
| Field | Type | Description |
|---|---|---|
| description | string | Short description of the product or service that has been bought from the vendor. |
| unitPrice | decimal | Unit price of the product or service. |
| accountRef | Reference Types | Reference to the account to which the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate to which the line item is linked to. |
Invoice Item
| Field | Type | Description |
|---|---|---|
| description | string | Short description of the product or service that has been sold to the customer. |
| unitPrice | decimal | Unit price of the product or service. |
| accountRef | Reference Types | Reference to the account to which the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate to which 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.