Tax Rates

The TaxRate Object

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

Platform Differences

Netsuite:

  • For the GET /tax_rates endpoint, Rutter fetches and returns both Tax Codes and Tax Groups.

Properties

idstring

The Rutter generated unique ID of the tax rate.

platform_idstring

The platform specific ID of the tax rate.

statusenum

The status of the tax rate.

One ofactiveinactive, or unknown.
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. This is the sum of the components of a tax rate, not including compounding.

subsidiariesarray

An array of Subsidiaries linked to the tax rate. Supported for NetSuite.

Show subsidiaries attributes
componentsarray

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

Show components attributes
additional_fieldsobjectOptional

Additional fields required only for a narrow set of use cases.

Show additional_fields attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the tax rate object was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

The ISO 8601 timestamp when the tax rates was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/tax_rates
GET
/accounting/tax_rates/:id

List Tax Rates

GEThttps://production.rutterapi.com/versioned/accounting/tax_rates

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Used to specify criteria to filter out the objects returned. Supports all filterable fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    sortstringqueryOptional

    Used to sort the returned objects, e.g. last_synced_at ASC. Supports all filterable fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at and last_synced_at fields are supported. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    tax_ratesarray
    Show tax_rates attributes
    next_cursorstringnullableOptional
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"tax_rates": [
3
{
4
"id": "00000000-0000-0000-0000-000000000000",
5
"platform_id": "00000000-0000-0000-0000-000000000000",
6
"status": "active",
7
"code": "LABOR",
8
"effective_tax_rate": 2.75,
9
"name": "Labor on Job",
10
"total_tax_rate": 9.5,
11
"subsidiaries": [
12
{
13
"id": "00000000-0000-0000-0000-000000000000"
14
},
15
{
16
"id": "00000000-0000-0000-0000-000000000000"
17
}
18
],
19
"components": [
20
{
21
"is_compound": false,
22
"is_purchases_tax": true,
23
"is_sales_tax": false,
24
"name": "Component 1",
25
"rate": 10.5
26
}
27
],
28
"created_at": "2023-01-02T02:34:56.000Z",
29
"updated_at": "2023-01-02T02:34:56.000Z",
30
"last_synced_at": "2023-01-02T02:34:56.000Z",
31
"platform_data": {
32
"id": 123,
33
"data": "Varies by platform"
34
}
35
}
36
],
37
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
38
"connection": {
39
"id": "00000000-0000-0000-0000-000000000000",
40
"orgId": "00000000-0000-0000-0000-000000000000",
41
"platform": "NETSUITE"
42
}
43
}

Fetch a Tax Rate

GEThttps://production.rutterapi.com/versioned/accounting/tax_rates/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    tax_rateobject
    Show tax_rate attributes
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"tax_rate": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "00000000-0000-0000-0000-000000000000",
5
"status": "active",
6
"code": "LABOR",
7
"effective_tax_rate": 2.75,
8
"name": "Labor on Job",
9
"total_tax_rate": 9.5,
10
"subsidiaries": [
11
{
12
"id": "00000000-0000-0000-0000-000000000000"
13
},
14
{
15
"id": "00000000-0000-0000-0000-000000000000"
16
}
17
],
18
"components": [
19
{
20
"is_compound": false,
21
"is_purchases_tax": true,
22
"is_sales_tax": false,
23
"name": "Component 1",
24
"rate": 10.5
25
}
26
],
27
"created_at": "2023-01-02T02:34:56.000Z",
28
"updated_at": "2023-01-02T02:34:56.000Z",
29
"last_synced_at": "2023-01-02T02:34:56.000Z",
30
"platform_data": {
31
"id": 123,
32
"data": "Varies by platform"
33
}
34
},
35
"connection": {
36
"id": "00000000-0000-0000-0000-000000000000",
37
"orgId": "00000000-0000-0000-0000-000000000000",
38
"platform": "NETSUITE"
39
}
40
}

Have questions?

Contact support for personalized guidance.

Contact support