Create Tax Rates

curl --request POST \
  --url https://api.rootfi.dev/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": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "3770712000001298001",
          "name": "Track Categories",
          "code": "GST",
          "effective_tax_rate": 12,
          "total_tax_rate": 12,
          "tax_type": "igst",
          "components": [
            {
              "name": "Track Categories",
              "rate": 12,
              "tax_agency": "igst",
              "is_compound": false
            }
          ],
          "updated_at": "2000-12-31T18:30:00.000Z",
          "raw_data": {
            "platform_id": "3770712000001298001",
            "name": "Track Categories",
            "code": "GST",
            "effective_tax_rate": 12,
            "total_tax_rate": 12,
            "tax_type": "igst",
            "components": [
              {
                "name": "Track Categories",
                "rate": 12,
                "tax_agency": "igst",
                "is_compound": false
              }
            ],
            "updated_at": "2000-12-31T18:30:00.000Z"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2000-12-31T18:30:00.000Z",
  "response_timestamp": "2021-06-01T00:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

POST

accounting

tax_rates

curl --request POST \
  --url https://api.rootfi.dev/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": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "3770712000001298001",
          "name": "Track Categories",
          "code": "GST",
          "effective_tax_rate": 12,
          "total_tax_rate": 12,
          "tax_type": "igst",
          "components": [
            {
              "name": "Track Categories",
              "rate": 12,
              "tax_agency": "igst",
              "is_compound": false
            }
          ],
          "updated_at": "2000-12-31T18:30:00.000Z",
          "raw_data": {
            "platform_id": "3770712000001298001",
            "name": "Track Categories",
            "code": "GST",
            "effective_tax_rate": 12,
            "total_tax_rate": 12,
            "tax_type": "igst",
            "components": [
              {
                "name": "Track Categories",
                "rate": 12,
                "tax_agency": "igst",
                "is_compound": false
              }
            ],
            "updated_at": "2000-12-31T18:30:00.000Z"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2000-12-31T18:30:00.000Z",
  "response_timestamp": "2021-06-01T00:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

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.

curl --request POST \
  --url https://api.rootfi.dev/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 company ID

Example:

1

data

accountingtypesTaxRatesWriteRequestFields · object[]

required

Show child attributes

data.name

string | null

Display name of the tax rate

data.code

string | null

Simple ID for the tax rate

data.effective_tax_rate

number<double> | null

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

data.total_tax_rate

number<double> | null

The sum of all the tax rate components

data.tax_type

string | null

The type of tax as mentioned in the accounting platform

data.components

accountingtypesTaxComponents · object[] | null

An array of all the tax components

Show child attributes

data.components.name

string | null

The name of the component

data.components.rate

number<double> | null

The tax rate of the component

data.components.is_compound

boolean | null

Whether the tax component is compounded or not

data.components.tax_agency

string | null

The tax agency of the component

data.raw_data

object

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

Response

200 - application/json

data

accountingtypesCreateTaxRatesResponseData · 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

accountingtypesTaxRateResponse · 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

accountingtypesTaxRatesWriteResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this tax rate

data.data.response.name

string | null

Display name of the tax rate

data.data.response.code

string | null

Simple ID for the tax rate

data.data.response.effective_tax_rate

number<double> | null

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

data.data.response.total_tax_rate

number<double> | null

The sum of all the tax rate components

data.data.response.tax_type

string | null

The type of tax as mentioned in the accounting platform

data.data.response.components

accountingtypesTaxComponents · object[] | null

An array of all the tax components

Show child attributes

data.data.response.components.name

string | null

The name of the component

data.data.response.components.rate

number<double> | null

The tax rate of the component

data.data.response.components.is_compound

boolean | null

Whether the tax component is compounded or not

data.data.response.components.tax_agency

string | null

The tax agency of the component

data.data.response.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.data.response.raw_data

object

The raw JSON response we receive from the accounting platform for this tax rate

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 Tax Rate Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Create Tax Rates

Authorizations

Body

Response