Create Tax Rate

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/tax_rates \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Tax Rate",
      "code": "1234567890",
      "effective_tax_rate": 10,
      "total_tax_rate": 10,
      "tax_type": "VAT",
      "components": [
        {
          "name": "Rootfi Test Tax Rate Component",
          "is_compound": false,
          "rate": 10,
          "tax_agency": "igst"
        }
      ]
    }
  ]
}'

{
  "data": {
    "rootfi_id": 25177,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-24T11:12:02.641Z",
    "rootfi_updated_at": "2024-01-24T11:12:02.000Z",
    "rootfi_company_id": 1109,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "total_tax_rate": null,
    "name": "Victoria Wilson",
    "code": "6609425",
    "updated_at": "2023-12-21T10:14:26.353Z",
    "components": [
      {
        "name": "Victoria Wilson",
        "rate": null,
        "tax_agency": null,
        "is_compound": false
      }
    ],
    "effective_tax_rate": null,
    "tax_type": "VAT"
  }
}

POST

accounting

tax_rates

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/tax_rates \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Tax Rate",
      "code": "1234567890",
      "effective_tax_rate": 10,
      "total_tax_rate": 10,
      "tax_type": "VAT",
      "components": [
        {
          "name": "Rootfi Test Tax Rate Component",
          "is_compound": false,
          "rate": 10,
          "tax_agency": "igst"
        }
      ]
    }
  ]
}'

{
  "data": {
    "rootfi_id": 25177,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-24T11:12:02.641Z",
    "rootfi_updated_at": "2024-01-24T11:12:02.000Z",
    "rootfi_company_id": 1109,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "total_tax_rate": null,
    "name": "Victoria Wilson",
    "code": "6609425",
    "updated_at": "2023-12-21T10:14:26.353Z",
    "components": [
      {
        "name": "Victoria Wilson",
        "rate": null,
        "tax_agency": null,
        "is_compound": false
      }
    ],
    "effective_tax_rate": null,
    "tax_type": "VAT"
  }
}

A Tax Rate is the percentage at which an individual or corporation is taxed. [he Tax Rates Data Model] is designed to provide a unified representation of tax rates across various accounting platforms.

Additional Required Fields

To successfully create an tax rate, certain fields must be included in the raw_data object of the request body. The required fields are as follows:

Integration	Field	Description
MEKARI_JURNAL	buy_tax_account_id	The ID of the account that will be used to record the tax amount when a purchase is made.
MEKARI_JURNAL	sell_tax_account_id	The ID of the account that will be used to record the tax amount when a sale is made.

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/tax_rates \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "name": "Rootfi Test Tax Rate",
      "code": "1234567890",
      "effective_tax_rate": 10,
      "total_tax_rate": 10,
      "tax_type": "VAT",
      "components": [
        {
          "name": "Rootfi Test Tax Rate Component",
          "is_compound": false,
          "rate": 10,
          "tax_agency": "igst"
        }
      ]
    }
  ]
}'

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The ID of the company in the accounting platform

data

accountingTaxRateFields · object[]

required

The data of the tax rates endpoint

Show child attributes

data.name

string | null

Display name

data.code

string | null

Simple ID for the tax rate

data.tax_type

string | null

The type of tax as mentioned in the accounting platform

data.effective_tax_rate

number<double> | null

The total tax rate after accounting for the compounding effects of the all tax components

data.total_tax_rate

number<double> | null

The sum of all the tax rate components

data.components

accountingTaxRateComponent · object[] | null

The list of tax rate components

Show child attributes

data.components.name

string | null

Display name

data.components.rate

number<double> | null

The total tax rate after accounting for the compounding effects of the all tax components

data.components.tax_agency

string | null

The tax agency of the tax rate component

data.components.is_compound

boolean | null

Whether the tax rate component is compound

data.updated_at

string | null

The last time the tax rate was updated

run_async

boolean | null

Run the request asynchronously

Response

data

accountingTaxRateObject · object

The list of tax rates

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

Display name

data.code

string | null

Simple ID for the tax rate

data.tax_type

string | null

The type of tax as mentioned in the accounting platform

data.effective_tax_rate

number<double> | null

The total tax rate after accounting for the compounding effects of the all tax components

data.total_tax_rate

number<double> | null

The sum of all the tax rate components

data.components

accountingTaxRateComponent · object[] | null

The list of tax rate components

Show child attributes

data.components.name

string | null

Display name

data.components.rate

number<double> | null

The total tax rate after accounting for the compounding effects of the all tax components

data.components.tax_agency

string | null

The tax agency of the tax rate component

data.components.is_compound

boolean | null

Whether the tax rate component is compound

data.updated_at

string | null

The last time the tax rate was updated

sync_id

string | null

The sync id of the request

Get Tax Rates Create Tax Rates

⌘I

General

Server Side SDKs

Core API

Unified API

Create Tax Rate

Additional Required Fields

Authorizations

Body

Response

General

Server Side SDKs

Core API

Unified API

​Additional Required Fields

Authorizations

Body

Response

Additional Required Fields