Inventory
A thing that a company buys, sells, or re-sells, such as products and services.
Overview
From the Inventory endpoint, you can retrieve a list of all products and services for a specified business. See Inventory endpoint for more details
Data Model
Field | Type | Description |
|---|---|---|
id | string | Identifier for the inventory item, unique to the business in the accounting service provider. |
name | string | Name of the inventory item in the accounting service provider. |
code | string | Friendly reference for an inventory item. |
quantityOnHandPerLocation | array | Quantity on hand per location. Not applicable if quantityOnHand is provided. |
itemStatus | string | Current statues of an inventory item. Can be: |
isBillItem | boolean | Indicates whether a business can use this item for bills. |
billItem | object | Inventory details that are only for bills. |
isInvoiceItem | boolean | Indicates whether a business can use this item for invoices. |
invoiceItem | object | Inventory details that are only for invoices. |
subsidiaryRefs | The subsidiary the inventory item belongs to. | |
sourceModifiedDate | string | 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 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 to the account to which the line item is linked to. | |
taxRateRef | 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 to the account to which the line item is linked to. | |
taxRateRef | Reference to the tax rate to which the line item is linked to. |
Inventory Reference
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.
Example Data
{
"id": "1",
"name": "Product Services",
"code": "100",
"sourceModifiedDate": "2021-03-09T10:18:29.985Z",
"itemStatus": "unknown",
"isBillItem": true,
"billItem":
{
"description": "Item description",
"unitPrice": 100.5,
"accountRef":
{
"id": "145",
"name": "Depreciation Expense"
},
"taxRateRef":
{
"id": "1",
"name": "HST",
"effectiveTaxRate": 13
}
},
"isInvoiceItem": true,
"invoiceItem":
{
"description": "Item description",
"unitPrice": 100.5,
"accountRef":
{
"id": "145",
"name": "Depreciation Expense"
},
"taxRateRef":
{
"id": "1",
"name": "HST",
"effectiveTaxRate": 13
}
},
"subsidiaryRefs":
[
{
"id": "2",
"name": "Company Ltd"
}
],
"quantityOnHandPerLocation":
[
{
"locationRef":
{
"id": "9",
"name": "Boston"
},
"quantity": 2
}
]
}
Updated 4 months ago