Update an Item

curl --request PUT \
  --url https://api.rootfi.dev/v3/accounting/items \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 123,
  "data": [
    {
      "platform_id": "a979d4e1-9795-ee11-be36-6045bdc629b7",
      "name": "Brian Vega",
      "description": null,
      "updated_at": "2023-12-08T00:00:00.000Z",
      "status": "ACTIVE",
      "bill_item": {
        "tax_id": "123456",
        "account_id": "123456",
        "unit_price": 123.45,
        "description": "Test Item"
      },
      "code": "9837",
      "invoice_item": {
        "tax_id": "123456",
        "account_id": "123456",
        "unit_price": 123.45,
        "description": "Test Item"
      },
      "is_bill_item": true,
      "is_invoice_item": true,
      "type": "INVENTORY",
      "quantity_on_hand": 10
    }
  ]
}
'

{
  "data": {
    "rootfi_id": 32302,
    "rootfi_deleted_at": null,
    "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": "Brian Vega",
    "description": null,
    "updated_at": "2023-12-08T00:00:00.000Z",
    "status": "ACTIVE",
    "bill_item": {
      "tax_id": "123456",
      "account_id": "123456",
      "unit_price": 123.45,
      "description": "Test Item"
    },
    "code": "9837",
    "invoice_item": {
      "tax_id": "123456",
      "account_id": "123456",
      "unit_price": 123.45,
      "description": "Test Item"
    },
    "is_bill_item": true,
    "is_invoice_item": true,
    "type": "INVENTORY",
    "quantity_on_hand": 10
  }
}

PUT

accounting

items

Update an Item

curl --request PUT \
  --url https://api.rootfi.dev/v3/accounting/items \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 123,
  "data": [
    {
      "platform_id": "a979d4e1-9795-ee11-be36-6045bdc629b7",
      "name": "Brian Vega",
      "description": null,
      "updated_at": "2023-12-08T00:00:00.000Z",
      "status": "ACTIVE",
      "bill_item": {
        "tax_id": "123456",
        "account_id": "123456",
        "unit_price": 123.45,
        "description": "Test Item"
      },
      "code": "9837",
      "invoice_item": {
        "tax_id": "123456",
        "account_id": "123456",
        "unit_price": 123.45,
        "description": "Test Item"
      },
      "is_bill_item": true,
      "is_invoice_item": true,
      "type": "INVENTORY",
      "quantity_on_hand": 10
    }
  ]
}
'

{
  "data": {
    "rootfi_id": 32302,
    "rootfi_deleted_at": null,
    "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": "Brian Vega",
    "description": null,
    "updated_at": "2023-12-08T00:00:00.000Z",
    "status": "ACTIVE",
    "bill_item": {
      "tax_id": "123456",
      "account_id": "123456",
      "unit_price": 123.45,
      "description": "Test Item"
    },
    "code": "9837",
    "invoice_item": {
      "tax_id": "123456",
      "account_id": "123456",
      "unit_price": 123.45,
      "description": "Test Item"
    },
    "is_bill_item": true,
    "is_invoice_item": true,
    "type": "INVENTORY",
    "quantity_on_hand": 10
  }
}

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

accountingUpdateItemFields · object[]

required

The data of the items endpoint

Show child attributes

data.platform_id

string

required

The platform ID of the item

Example:

"a979d4e1-9795-ee11-be36-6045bdc629b7"

data.name

string | null

Name of the item

data.description

string | null

Description of the item

data.status

enum<string> | null

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

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.type

enum<string> | null

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

Available options:

INVENTORY,

NON_INVENTORY,

SERVICE,

UNKNOWN

data.code

string | null

Reference code of the item

data.quantity_on_hand

integer | null

Quantity on hand

data.is_bill_item

boolean | null

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

data.bill_item

accountingItemDetail · object

Item details of this item getting purchased

Show child attributes

data.bill_item.tax_id

string | null

Tax id of the item

data.bill_item.account_id

string | null

data.bill_item.unit_price

number<double> | null

Unit price of the item

data.bill_item.description

string | null

Description of the item

data.is_invoice_item

boolean | null

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

data.invoice_item

accountingItemDetail · object

Item details of this item getting sold

Show child attributes

data.invoice_item.tax_id

string | null

Tax id of the item

data.invoice_item.account_id

string | null

data.invoice_item.unit_price

number<double> | null

Unit price of the item

data.invoice_item.description

string | null

Description of the item

data.updated_at

string | null

The date the item was last updated

run_async

boolean | null

Run the request asynchronously

Response

data

accountingItemObject · object

List of items

Show child attributes

data.rootfi_id

number<double>

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string<date-time>

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.rootfi_updated_at

string<date-time>

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.rootfi_company_id

number<double>

required

The ID of the company in the accounting platform

Example:

1089

data.platform_id

string

required

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

Example:

"123456"

data.rootfi_deleted_at

string<date-time> | null

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

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object

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

data.data_hash

string | null

The hash of the data

data.name

string | null

Name of the item

data.description

string | null

Description of the item

data.status

enum<string> | null

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

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.type

enum<string> | null

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

Available options:

INVENTORY,

NON_INVENTORY,

SERVICE,

UNKNOWN

data.code

string | null

Reference code of the item

data.quantity_on_hand

integer | null

Quantity on hand

data.is_bill_item

boolean | null

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

data.bill_item

accountingItemDetail · object

Item details of this item getting purchased

Show child attributes

data.bill_item.tax_id

string | null

Tax id of the item

data.bill_item.account_id

string | null

data.bill_item.unit_price

number<double> | null

Unit price of the item

data.bill_item.description

string | null

Description of the item

data.is_invoice_item

boolean | null

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

data.invoice_item

accountingItemDetail · object

Item details of this item getting sold

Show child attributes

data.invoice_item.tax_id

string | null

Tax id of the item

data.invoice_item.account_id

string | null

data.invoice_item.unit_price

number<double> | null

Unit price of the item

data.invoice_item.description

string | null

Description of the item

data.updated_at

string | null

The date the item was last updated

sync_id

string | null

The sync id of the request

Create Items Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Update an Item

Authorizations

Body

Response