Documentation Index
Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
Use this file to discover all available pages before exploring further.
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
| Property | Type | Description |
|---|
| rootfi_id | integer | Unique identifier assigned by Commenda for this item |
| rootfi_created_at | string | Timestamp when this record was created in Commenda’s system (ISO 8601) |
| rootfi_updated_at | string | Timestamp when this record was last updated in Commenda’s system (ISO 8601) |
| rootfi_company_id | integer | Company identifier this item belongs to within Commenda |
| platform_id | string | Unique identifier for this item in the source accounting platform |
| name | string | The name of the item |
| description | string | The description of the item |
| status | enum | The status of the item |
| type | enum | The type of the item |
| code | string | The reference code of the item |
| quantity_on_hand | integer | The quantity on hand for the item |
| is_bill_item | boolean | Whether there are details (bill_item) of this item getting purchased |
| bill_item | object | Item details of this item getting purchased |
| is_invoice_item | boolean | Whether there are details (invoice_item) of this item getting sold |
| invoice_item | object | Item details of this item getting sold |
| updated_at | string | The date and time the item was last updated |
Status Enum Values
| Value | Description |
|---|
DRAFT | Item is in draft status and not yet published |
ACTIVE | Item is active and available for use |
ARCHIVED | Item has been archived |
UNKNOWN | Status cannot be determined from the platform |
Type Enum Values
| Value | Description |
|---|
INVENTORY | Item is tracked as inventory |
NON_INVENTORY | Item is not tracked as inventory |
SERVICE | Item represents a service |
DIGITAL | Item is a digital product/download |
UNKNOWN | Type 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
| Property | Type | Description |
|---|
| account_id | string | The account ID of the item |
| tax_id | string | The tax ID of the item |
| description | string | The description of the item |
| unit_price | double | The unit price of the item |
Properties Supported
| Property | Type | Description |
|---|
| platform_id | string | The Platform’s ID for this item |
| name | string | The name of the item |
| description | string | The description of the item |
| status | enum | The status of the item |
| type | enum | The type of the item |
| code | string | The reference code of the item |
| quantity_on_hand | integer | The quantity on hand for the item |
| is_bill_item | boolean | Whether there are details (bill_item) of this item getting purchased |
| bill_item | object | Item details of this item getting purchased |
| is_invoice_item | boolean | Whether there are details (invoice_item) of this item getting sold |
| invoice_item | object | Item details of this item getting sold |
| updated_at | string | The 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",
"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"
}
