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
id
stringThe Rutter generated unique ID of the tax rate.
platform_id
stringThe platform specific ID of the tax rate.
code
stringnullableThe tax code of the tax rate.
effective_tax_rate
numbernullableWhere 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.
name
stringnullableThe name of the tax rate.
total_tax_rate
numbernullableThe total tax rate. This is the sum of the components of a tax rate, not including compounding.
subsidiaries
arrayOptionalAn array of Subsidiaries linked to the tax rate. Supported for NetSuite.
subsidiaries
attributescomponents
arraynullableTax rates can break into multiple sub taxes that are then combined in various ways. These sub taxes are called components.
components
attributesadditional_fields
objectOptionalAdditional fields required only for a narrow set of use cases.
additional_fields
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the tax rate object was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the tax rate object was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the tax rates was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Tax Rates
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalUsed 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.
sort
stringqueryOptionalUsed 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
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
tax_rates
arraytax_rates
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "tax_rates": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "00000000-0000-0000-0000-000000000000",
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": null,
19 "created_at": "2023-01-02T02:34:56.000Z",
20 "updated_at": "2023-01-02T02:34:56.000Z",
21 "last_synced_at": "2023-01-02T02:34:56.000Z",
22 "platform_data": {
23 "id": 123,
24 "data": "Varies by platform"
25 }
26 }
27 ],
28 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
29 "connection": {
30 "id": "00000000-0000-0000-0000-000000000000",
31 "orgId": "00000000-0000-0000-0000-000000000000",
32 "platform": "NETSUITE"
33 }
34}
Fetch a Tax Rate
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
tax_rate
objecttax_rate
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "tax_rate": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "00000000-0000-0000-0000-000000000000",
5 "code": "LABOR",
6 "effective_tax_rate": 2.75,
7 "name": "Labor on Job",
8 "total_tax_rate": 9.5,
9 "subsidiaries": [
10 {
11 "id": "00000000-0000-0000-0000-000000000000"
12 },
13 {
14 "id": "00000000-0000-0000-0000-000000000000"
15 }
16 ],
17 "components": null,
18 "created_at": "2023-01-02T02:34:56.000Z",
19 "updated_at": "2023-01-02T02:34:56.000Z",
20 "last_synced_at": "2023-01-02T02:34:56.000Z",
21 "platform_data": {
22 "id": 123,
23 "data": "Varies by platform"
24 }
25 },
26 "connection": {
27 "id": "00000000-0000-0000-0000-000000000000",
28 "orgId": "00000000-0000-0000-0000-000000000000",
29 "platform": "NETSUITE"
30 }
31}
Have questions?
Contact support for personalized guidance.