Create Items

curl --request POST \
  --url https://api.rootfi.dev/accounting/items \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Item",
      "description": "Rootfi Test Item",
      "type": "INVENTORY",
      "code": "1234567890",
      "quantity_on_hand": 0,
      "bill_item": {
        "account_id": "123456",
        "unit_price": 100
      },
      "invoice_item": {
        "account_id": "123456",
        "unit_price": 100
      }
    }
  ]
}'

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "<string>",
    "data": [
      {
        "job_id": "<string>",
        "status": "success",
        "response": {
          "platform_id": "<string>",
          "is_bill_item": true,
          "is_invoice_item": true,
          "updated_at": "<string>",
          "name": "<string>",
          "description": "<string>",
          "type": "INVENTORY",
          "code": "<string>",
          "quantity_on_hand": 123,
          "bill_item": {
            "account_id": "<string>",
            "unit_price": 123,
            "raw_data": {},
            "description": "<string>",
            "tax_id": "<string>"
          },
          "invoice_item": {
            "account_id": "<string>",
            "unit_price": 123,
            "raw_data": {},
            "description": "<string>",
            "tax_id": "<string>"
          },
          "status": "ACTIVE",
          "raw_data": {}
        },
        "error": {
          "code": "<string>",
          "message": "<string>",
          "platform_error": "<string>",
          "raw_data": {}
        }
      }
    ]
  },
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

POST

accounting

items

curl --request POST \
  --url https://api.rootfi.dev/accounting/items \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Item",
      "description": "Rootfi Test Item",
      "type": "INVENTORY",
      "code": "1234567890",
      "quantity_on_hand": 0,
      "bill_item": {
        "account_id": "123456",
        "unit_price": 100
      },
      "invoice_item": {
        "account_id": "123456",
        "unit_price": 100
      }
    }
  ]
}'

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "<string>",
    "data": [
      {
        "job_id": "<string>",
        "status": "success",
        "response": {
          "platform_id": "<string>",
          "is_bill_item": true,
          "is_invoice_item": true,
          "updated_at": "<string>",
          "name": "<string>",
          "description": "<string>",
          "type": "INVENTORY",
          "code": "<string>",
          "quantity_on_hand": 123,
          "bill_item": {
            "account_id": "<string>",
            "unit_price": 123,
            "raw_data": {},
            "description": "<string>",
            "tax_id": "<string>"
          },
          "invoice_item": {
            "account_id": "<string>",
            "unit_price": 123,
            "raw_data": {},
            "description": "<string>",
            "tax_id": "<string>"
          },
          "status": "ACTIVE",
          "raw_data": {}
        },
        "error": {
          "code": "<string>",
          "message": "<string>",
          "platform_error": "<string>",
          "raw_data": {}
        }
      }
    ]
  },
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

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

curl --request POST \
  --url https://api.rootfi.dev/accounting/items \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Item",
      "description": "Rootfi Test Item",
      "type": "INVENTORY",
      "code": "1234567890",
      "quantity_on_hand": 0,
      "bill_item": {
        "account_id": "123456",
        "unit_price": 100
      },
      "invoice_item": {
        "account_id": "123456",
        "unit_price": 100
      }
    }
  ]
}'

Authorizations

api_key

string

header

required

Body

application/json

Create items

company_id

integer

required

Example:

1

data

accountingtypesItemsWriteRequestFields · object[]

required

Show child attributes

data.name

string | null

Name of the item

data.description

string | null

Description of the item

data.type

enum<string> | null

Type of the item.

Available options:

INVENTORY,

NON_INVENTORY,

SERVICE,

UNKNOWN

data.code

string | null

Reference code of the item

data.quantity_on_hand

number<double> | null

Quantity on hand

data.bill_item

BillInvoiceItem · object

Item details of this item getting purchased

Show child attributes

data.bill_item.account_id

string

required

The ID of the account in the accounting platform

data.bill_item.unit_price

number<double>

required

The unit price of the item

data.bill_item.raw_data

object

The raw data of the item

data.bill_item.description

string | null

The description of the item

data.bill_item.tax_id

string | null

The ID of the tax in the accounting platform

data.invoice_item

BillInvoiceItem · object

Item details of this item getting sold

Show child attributes

data.invoice_item.account_id

string

required

The ID of the account in the accounting platform

data.invoice_item.unit_price

number<double>

required

The unit price of the item

data.invoice_item.raw_data

object

The raw data of the item

data.invoice_item.description

string | null

The description of the item

data.invoice_item.tax_id

string | null

The ID of the tax in the accounting platform

data.raw_data

object

A JSON containing fields that you can directly pass to the accounting platform.

Response

200 - application/json

data

accountingtypesCreateItemsResponseData · object

required

Show child attributes

data.status

enum<string>

required

The status of the job.

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.upload_job_id

string

required

The ID of the job.

data.data

accountingtypesItemsResponse · object[]

required

Show child attributes

data.data.job_id

string

required

The ID of the job.

data.data.status

enum<string>

required

The status of the job.

Available options:

success,

failed

data.data.response

accountingtypesItemsWriteResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this item

data.data.response.is_bill_item

boolean

required

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

data.data.response.is_invoice_item

boolean

required

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

data.data.response.updated_at

string

required

The date on which the information was updated on the accounting platform

data.data.response.name

string | null

Name of the item

data.data.response.description

string | null

Description of the item

data.data.response.type

enum<string> | null

Type of the item.

Available options:

INVENTORY,

NON_INVENTORY,

SERVICE,

UNKNOWN

data.data.response.code

string | null

Reference code of the item

data.data.response.quantity_on_hand

number<double> | null

Quantity on hand

data.data.response.bill_item

BillInvoiceItem · object

Item details of this item getting purchased

Show child attributes

data.data.response.bill_item.account_id

string

required

The ID of the account in the accounting platform

data.data.response.bill_item.unit_price

number<double>

required

The unit price of the item

data.data.response.bill_item.raw_data

object

The raw data of the item

data.data.response.bill_item.description

string | null

The description of the item

data.data.response.bill_item.tax_id

string | null

The ID of the tax in the accounting platform

data.data.response.invoice_item

BillInvoiceItem · object

Item details of this item getting sold

Show child attributes

data.data.response.invoice_item.account_id

string

required

The ID of the account in the accounting platform

data.data.response.invoice_item.unit_price

number<double>

required

The unit price of the item

data.data.response.invoice_item.raw_data

object

The raw data of the item

data.data.response.invoice_item.description

string | null

The description of the item

data.data.response.invoice_item.tax_id

string | null

The ID of the tax in the accounting platform

data.data.response.status

enum<string> | null

Status of the item.

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.data.response.raw_data

object

The raw JSON response we get from the accounting platform for that data

data.data.error

ErrorObject · object

The error message if the job failed.

Show child attributes

data.data.error.code

string

required

data.data.error.message

string

required

data.data.error.platform_error

string

required

data.data.error.raw_data

object

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

Create Item Update an Item

⌘I

General

Server Side SDKs

Core API

Unified API

Authorizations

Body

Response