Commerce

Tax Rates
Get API Keys

The TaxRate object

A Rutter Tax Rate represents a simple or compound tax contained with the business entity's accounting system.

Properties

idstring

The Rutter generated unique ID of the tax rate.

platform_idstring

The platform specific ID of the tax rate.

codestringnullable

The tax code of the tax rate.

effective_tax_ratenumbernullable

Where there are multiple components of a tax, each component may be calculated on the original amount and added together. Alternatively, one tax may be calculated on the sub-total of the original amount plus another tax, which is referred to as compounding. When there is compounding, the effective tax rate is the rate that, if applied to the original amount, would result in the total amount of tax with compounding.

namestringnullable

The name of the tax rate.

total_tax_ratenumbernullable

The total tax rate

subsidiariesarrayoptional

An array of Subsidiaries linked to the tax rate. This feature is currently only supported on NetSuite.

Show subsidiaries attributes
componentsarraynullable

Tax rates can break into multiple sub taxes that are then combined in various ways. These sub taxes are called components.

Show components attributes
updated_atstringnullable

The ISO 8601 timestamp that the tax rate object was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example TaxRate Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "00000000-0000-0000-0000-000000000000",
  "code": "LABOR",
  "effective_tax_rate": 2.75,
  "name": "Labor on Job",
  "total_tax_rate": 9.5,
  "subsidiaries": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "components": null,
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Tax Rates

GET /accounting/tax_rates
Supported for: Dynamics 365NetSuiteQuickBooksXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    tax_ratesarray
    Show tax_rates attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "tax_rates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "00000000-0000-0000-0000-000000000000",
      "code": "LABOR",
      "effective_tax_rate": 2.75,
      "name": "Labor on Job",
      "total_tax_rate": 9.5,
      "subsidiaries": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "components": null,
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Tax Rate

GET /accounting/tax_rates/:id
Supported for: Dynamics 365NetSuiteXeroZoho Books

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    tax_rateobject
    Show tax_rate attributes
Example Response Body
{
  "tax_rate": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "00000000-0000-0000-0000-000000000000",
    "code": "LABOR",
    "effective_tax_rate": 2.75,
    "name": "Labor on Job",
    "total_tax_rate": 9.5,
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "components": null,
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
Next
Custom Fields