Get All Items - RootFi

Integrations Roadmap

Data Coverage Tool

General

Overview

Server Side SDKs

Typescript SDK

Core API

Companies
Invite Links
Sync
Passthrough
Real Time
Webhooks

Unified API

Accounting
- Accounts
- Bank Accounts
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
- Invoice Payments
- Items
  - Overview
  - Overview
  - GET
    Get All Items
  - POST
    Get Items
  - POST
    Create Item
  - POST
    Create Items
  - PUT
    Update an Item
- Journal Entries
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
Payments
Ecommerce
CRM

GET

accounting

items

curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/items \
  --header 'api_key: <api-key>'

{
  "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
    }
  ],
  "next": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "prev": "eyJyb290ZmaaqaWQiOjQ0MDA2MX0="
}

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.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

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

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

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

data.rootfi_company_id

number

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 | 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 | null

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>

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.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

object

Item details of this item getting purchased

data.is_invoice_item

boolean | null

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

data.invoice_item

object

Item details of this item getting sold

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

Overview Get Items

curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/items \
  --header 'api_key: <api-key>'

{
  "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
    }
  ],
  "next": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "prev": "eyJyb290ZmaaqaWQiOjQ0MDA2MX0="
}