The Tax Rate object
A Rutter Tax Rate represents a simple or compound tax contained with the business entity's accounting system.
Properties
idstringThe Rutter generated unique ID of the tax rate.
namestringnullableThe name of the tax rate.
codestringnullableThe tax code of the tax rate.
effective_tax_ratenumbernullabletotal_tax_ratenumbernullablecomponentsarraynullablecomponents attributesplatform_dataoptionalThe raw platform data corresponding to the Rutter object.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Labor on Job",
"code": "LABOR",
"effective_tax_rate": 2.75,
"total_tax_rate": 9.5,
"components": null
}
List Tax Rates
GET /accounting/tax_ratesRequest Parameters
access_tokenstringqueryThe access token of the connection.
cursorstringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor field in a previous request.
expandenumoptionalqueryUsed to request inclusion of optional objects.
force_fetchenumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limitintegeroptionalqueryThe limit on the number of entities returned.
updated_at_maxintegeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_minintegeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
tax_ratesarraytax_rates attributesnext_cursorstringnullable{
"tax_rates": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Labor on Job",
"code": "LABOR",
"effective_tax_rate": 2.75,
"total_tax_rate": 9.5,
"components": null
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Tax Rate
GET /accounting/tax_rates/:idRequest Parameters
idstringpathThe Rutter generated unique ID of the object.
access_tokenstringqueryThe access token of the connection.
force_fetchenumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
tax_rateTax Ratetax_rate attributes{
"tax_rate": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Labor on Job",
"code": "LABOR",
"effective_tax_rate": 2.75,
"total_tax_rate": 9.5,
"components": null
}
}