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
sortable, filterable

string

Name of the inventory item in the accounting service provider.

code
sortable, filterable

string

Friendly reference for an inventory item.

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

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.

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.

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.

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 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.

Example Data

{
  "data":
  [
    {
      "id": "1",
      "name": "Product Services",
      "code": "100",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z",
      "itemStatus": "active",
      "isBillItem": true,
      "billItem":
      {
        "description": "Item description",
        "unitPrice": 100.5,
        "accountRef":
        {
          "id": "145",
          "name": "Software Expenses"
        },
        "taxRateRef":
        {
          "id": "1",
          "name": "HST",
          "effectiveTaxRate": 13
        }
      },
      "isInvoiceItem": true,
      "invoiceItem":
      {
        "description": "Item description",
        "unitPrice": 100.5,
        "accountRef":
        {
          "id": "200",
          "name": "COnsulting Income"
        },
        "taxRateRef":
        {
          "id": "1",
          "name": "HST",
          "effectiveTaxRate": 13
        }
      }
    }
  ]
}

Did this page help you?