Inventory

The Inventory Object

From the Inventory endpoint, you can retrieve a list of all products and services for a specified business.

FieldTypeDescription
id stringIdentifier for the inventory item, unique to the business in the accounting service provider.
name
sortable, filterable
stringName of the inventory item in the accounting service provider.
code
sortable, filterable
stringFriendly reference for an inventory item.
quantityOnHandPerLocationarrayQuantity on hand per location. Not applicable if quantityOnHand is provided.
itemStatus
sortable, filterable
string Current statues of an inventory item. Can be:
active
archived
unknown
isBillItem
sortable, filterable
boolean Indicates whether a business can use this item for bills.
billItem objectInventory details that are only for bills.
isInvoiceItem
sortable, filterable
booleanIndicates whether a business can use this item for invoices.
invoiceItem objectInventory details that are only for invoices.
subsidiaryRefsReference TypesThe 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

FieldTypeDescription
locationRefReference TypesReference to the location the inventory is located at
quantityintegerThe quantity of the inventory at the referenced location.

Bill Item

FieldTypeDescription
descriptionstringShort description of the product or service that has been bought from the vendor.
unitPricedecimalUnit price of the product or service.
accountRefReference TypesReference to the account to which the line item is linked to.
taxRateRefReference TypesReference to the tax rate to which the line item is linked to.

Invoice Item

FieldTypeDescription
descriptionstringShort description of the product or service that has been sold to the customer.
unitPricedecimalUnit price of the product or service.
accountRefReference TypesReference to the account to which the line item is linked to.
taxRateRefReference TypesReference 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 inventoryRef can be used alone with the id as a value instead of nesting it within.

When pushing to Xero, use code as a value.