The TaxRate object
A Rutter Tax Rate represents a simple or compound tax contained with the business entity's accounting system.
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
subsidiaries
arrayoptionalAn array of Subsidiaries linked to the tax rate. This feature is currently only supported on 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
attributesupdated_at
stringnullableThe ISO 8601 timestamp that the tax rate object was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"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_ratesRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
tax_rates
arraytax_rates
attributesnext_cursor
stringnullableoptional{
"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/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
tax_rate
objecttax_rate
attributes{
"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"
}
}
}