Get All Items

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

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

string | null

The next page of objects to retrieve

string | null

The previous page of objects to retrieve

select

string | null

Comma separated fields to select. Supported values are raw_data, data_hash

rootfi_updated_at[gte]

string | null

Filter by rootfi_updated_at Greater than or Equal To.

rootfi_company_id[eq]

integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

include_deleted_records

string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

return_count

string | null

Return the count of the objects. Supported values are true and false

sort[rootfi_created_at]

enum<string>

Sort by rootfi_created_at

Available options:

ASC,

DESC

sort[rootfi_updated_at]

enum<string>

Sort by rootfi_updated_at

Available options:

ASC,

DESC

Response

200 - application/json

data

object[]

required

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

string | null

The next page of objects to retrieve

string | null

The prev page of objects to retrieve

General

Server Side SDKs

Core API

Unified API

Authorizations

Query Parameters

Response