Items
Details of a product or service that is bought or sold
Explore the Items endpoints in Swagger.
View the coverage for items in the Data Coverage Explorer.
Overview
Items allow your customers to save and track details of the products and services that they buy and sell.
Data model
Item
Details of a product or service that a customer buys from a supplier or sells to another company or individual.
Field | Type | Description |
---|---|---|
id | string | Identifier for the item that is unique to a company in the accounting platform. |
name | string | Name of the item in the accounting platform. |
code | string | Friendly reference for the item. |
modifiedDate | string | Date when the record was last updated in the Codat system. |
sourceModifiedDate | string | Date when the record was last updated in the accounting platform. |
itemStatus | string | Current state of the item, either:
|
type | string | Type of the item:
|
isBillItem | boolean | Whether you can use this item for bills. |
billItem | object, string | Item details that are only for bills. |
isInvoiceItem | boolean | Whether you can use this item for invoices. |
invoiceItem | object, string | Item details that are only for invoices. |
Note 1 Due to a limitation in Xero's API, all items from Xero are mapped as Unknown
.
Bill item
Details of the product or service when it is bought from a supplier.
Field | Type | Description |
---|---|---|
description | string | Short description of the product or service that has been bought by the customer. |
unitPrice | decimal | Unit price of the product or service. |
accountRef | reference type | Reference of the account to which the item is linked. |
taxRateRef | reference type | Reference of the tax rate to which the item is linked. |
Invoice item
Details of the product or service when it is sold to a customer.
Field | Type | Description |
---|---|---|
description | string | Short description of the product or service that is provided by the customer. |
unitPrice | decimal | Unit price of the product or service. |
accountRef | reference type | Reference of the account to which the item is linked. |
taxRateRef | reference type | Reference of the tax rate to which the item is linked. |
Item reference
Data types that reference an item, for example bills and invoices, use an itemRef that includes the id and name of the linked item.
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the item in the accounting platform. |
name | string | Name of the item in the accounting platform. |
Example data
[
{
"id": "1",
"name": "Anvil10000Lb",
"code": "158",
"sourceModifiedDate": "2018-10-01T08:42:41.491Z",
"modifiedDate": "2018-10-01T08:42:41.491Z",
"itemStatus": "Active",
"type": "Unknown",
"isBillItem": true,
"billItem": {
"description": "10,000 Lb anvil bought",
"unitPrice": 45,
"accountRef": {
"id": "367f8daa-1464-4152-bf4e-21548696f916",
"name": "Purchases"
},
"taxRateRef": {
"id": "6c88aff3-7cb9-4980-a3d3-443e72e02498",
"name": "ACME Sales Tax (10%)",
"effectiveTaxRate":0
}
},
"isInvoiceItem": true,
"invoiceItem": {
"description": "10,000 Lb anvil sold",
"unitPrice": 50,
"accountRef": {
"id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3",
"name": "Sales"
},
"taxRateRef": {
"id": "6c88aff3-7cb9-4980-a3d3-443e72e02498",
"name": "ACME Sales Tax (10%)",
"effectiveTaxRate": 0
}
}
},
{
"id": "2",
"name": "ACMEDynamite",
"code": "142",
"sourceModifiedDate": "2018-10-01T08:42:41.491Z",
"modifiedDate": "2018-10-01T08:42:41.491Z",
"itemStatus": "Active",
"isBillItem": true,
"billItem": {
"description": "Acme dynamite bought",
"unitPrice": 7,
"accountRef": {
"id": "367f8daa-1464-4152-bf4e-21548696f916",
"name": "Purchases"
},
"taxRateRef": {
"id": "6c88aff3-7cb9-4980-a3d3-443e72e02498",
"name": "ACME Sales Tax (10%)",
"effectiveTaxRate": 0
}
},
"isInvoiceItem": true,
"invoiceItem": {
"description": "Acme dynamite sold",
"unitPrice": 10.5,
"accountRef": {
"id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3",
"name": "Sales"
},
"taxRateRef": {
"id": "6c88aff3-7cb9-4980-a3d3-443e72e02498",
"name": "ACME Sales Tax (10%)",
"effectiveTaxRate": 0
}
}
}
]
Updated 2 months ago