{
  "platform_id": "3770712000001345066",
  "name": "Toy",
  "description": "Toy Story",
  "status": "ACTIVE",
  "type": "INVENTORY",
  "code": "T-40",
  "quantity_on_hand": 44,
  "is_bill_item": true,
  "bill_item": {
    "account_id": "3770712000001313073",
    "tax_id": "3770712000001313073",
    "description": "Bill Item Description",
    "unit_price": 1320
  },
  "is_invoice_item": true,
  "invoice_item": {
    "account_id": "3770712000000000394",
    "tax_id": "3770712000000000394",
    "description": "Invoice Item Description",
    "unit_price": 1500
  },
  "updated_at": "2023-09-22T00:00:00.000Z"
}
  • Unified item properties: The model unifies essential item details such as name, description, status, and type, making it easier to work with item data from different platforms.
  • Item detail flexibility: The model supports separate details for items being purchased (bill_item) and items being sold (invoice_item), enabling accurate tracking of item-related transactions.
  • Associated accounts and tax rates: Each item can be linked to specific purchase and sales accounts, as well as purchase and sales tax rates, for seamless integration with other accounting data models.

Attributes

platform_id
string
required

The accounting platforms ID for this item

name
string

Name of the item

description
string

Description of the item

status
enum

Status of the item. Values are: ACTIVE, ARCHIVED, UNKNOWN

type
enum

Type of the item. Values are: INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN.

code
string

Reference code of the item

quantity_on_hand
float

Quantity on hand

is_bill_item
boolean

Check if there are details (bill_item) of this item getting purchased

bill_item
Item Detail

Item details of this item getting purchased

is_invoice_item
boolean

Check if there are details (invoice_item) of this item getting sold

invoice_item
Item Detail

Item details of this item getting sold

updated_at
date

The date on which the information was updated on the accounting platform

Properties Supported

PropertyTypeDescription
platform_idstringThe accounting platforms ID for this item
namestringName of the item
descriptionstringDescription of the item
statusenumStatus of the item. Values are: ACTIVE, ARCHIVED, UNKNOWN
typeenumType of the item. Values are: INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN
codestringReference code of the item
quantity_on_handfloatQuantity on hand
is_bill_itembooleanCheck if there are details (bill_item) of this item getting purchased
bill_itemItem DetailItem details of this item getting purchased
is_invoice_itembooleanCheck if there are details (invoice_item) of this item getting sold
invoice_itemItem DetailItem details of this item getting sold
purchase_accountAccountThe account which is associated with the (bill) item that are being purchased
sales_accountAccountThe account which is associated with the (invoice) item that are being sold
sales_taxTax RateThe tax which is associated with the (invoice) item that are being sold
purchase_taxTax RateThe tax which is associated with the (bill) item that are being purchased
updated_atdateThe date on which the information was updated on the accounting platform

Item Detail

The Item Details Data Model is a complementary model providing additional information about individual items.

  • Associated account and tax: The model links items to their respective accounts and tax rates using account_id and tax_id, enabling seamless integration with other accounting data models.
  • Detailed item description: The description property allows for a more in-depth understanding of each item’s nature and purpose.
  • Unit price tracking: The unit_price property records the cost of a single unit of the item, making it easy to calculate the total cost of transactions involving the item.

Properties Supported

PropertyTypeDescription
account_idstringThe platform ID of the account associated with this item
tax_idstringThe platform ID of the tax associated with this item
descriptionstringA description of the item
unit_pricefloatThe unit price of the item