Skip to main content
The Items Data Model represents products or services that can be sold or purchased. This unified model simplifies handling item-related information across various accounting platforms.
  • Unified item properties: Essential item details such as name, description, status, and type are standardized across different accounting 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

Item Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this item
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_idintegerCompany identifier this item belongs to within Commenda
platform_idstringUnique identifier for this item in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
namestringThe name of the item
descriptionstringThe description of the item
statusenumThe status of the item
typeenumThe type of the item
codestringThe reference code of the item
quantity_on_handintegerThe quantity on hand for the item
is_bill_itembooleanWhether there are details (bill_item) of this item getting purchased
bill_itemobjectItem details of this item getting purchased
is_invoice_itembooleanWhether there are details (invoice_item) of this item getting sold
invoice_itemobjectItem details of this item getting sold
updated_atstringThe date and time the item was last updated

Status Enum Values

ValueDescription
draftItem is in draft status and not yet published
activeItem is active and available for use
archivedItem has been archived
unknownStatus cannot be determined from the platform

Type Enum Values

ValueDescription
inventoryItem is tracked as inventory
non_inventoryItem is not tracked as inventory
serviceItem represents a service
digitalItem is a digital product/download
unknownType cannot be determined from the platform

Item Detail

The Item Details Data Model is a nested object providing additional information about individual items for purchase (bill_item) or sale (invoice_item).

Item Detail Attributes

PropertyTypeDescription
account_idstringThe account ID of the item
tax_idstringThe tax ID of the item
descriptionstringThe description of the item
unit_pricedoubleThe unit price of the item

Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for this item
namestringThe name of the item
descriptionstringThe description of the item
statusenumThe status of the item
typeenumThe type of the item
codestringThe reference code of the item
quantity_on_handintegerThe quantity on hand for the item
is_bill_itembooleanWhether there are details (bill_item) of this item getting purchased
bill_itemobjectItem details of this item getting purchased
is_invoice_itembooleanWhether there are details (invoice_item) of this item getting sold
invoice_itemobjectItem details of this item getting sold
updated_atstringThe date and time the item was last updated
{
  "rootfi_id": 32302,
  "rootfi_created_at": "2024-01-24T11:12:00.315Z",
  "rootfi_updated_at": "2024-01-24T11:12:00.000Z",
  "rootfi_company_id": 1109,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "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"
}