Update an Item

The Items Data Model is designed to simplify the management and retrieval of item-related information across various accounting platforms.

Only supported for Zoho Books, Quickbooks, Xero

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The ID of the company in the accounting platform

data

object[]

required

The data of the items endpoint

run_async

boolean | null

Run the request asynchronously

Response

200 - application/json

data

object

List of items

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

data.rootfi_company_id

number

required

The ID of the company in the accounting platform

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.rootfi_id

number

required

The unique ID we assign for that data's information

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.bill_item

object

Item details of this item getting purchased

data.code

string | null

Reference code of the item

data.data_hash

string | null

The hash of the data

data.description

string | null

Description of the item

data.invoice_item

object

Item details of this item getting sold

data.is_bill_item

boolean | null

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

data.is_invoice_item

boolean | null

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

data.name

string | null

Name of the item

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.quantity_on_hand

integer | null

Quantity on hand

data.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.status

enum<string>

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

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.type

enum<string>

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

Available options:

INVENTORY,

NON_INVENTORY,

SERVICE,

UNKNOWN

data.updated_at

string | null

The date the item was last updated

sync_id

string | null

The sync id of the request

General

Server Side SDKs

Core API

Unified API

Update an Item

Authorizations

Body

Response