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
stringRequiredThe Rutter generated unique ID of the tax rate.
platform_id
stringRequiredThe platform specific ID of the tax rate.
code
stringnullableRequiredThe tax code of the tax rate.
effective_tax_rate
numbernullableRequiredWhere 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
stringnullableRequiredThe name of the tax rate.
total_tax_rate
numbernullableRequiredThe total tax rate. This is the sum of the components of a tax rate, not including compounding.
subsidiaries
arrayAn array of Subsidiaries linked to the tax rate. This feature is currently only supported on NetSuite.
subsidiaries
attributesadditional_fields
objectadditional_fields
attributescomponents
arraynullableRequiredTax rates can break into multiple sub taxes that are then combined in various ways. These sub taxes are called components.
components
attributesupdated_at
stringnullableRequiredThe ISO 8601 timestamp that the tax rate object was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the tax rates was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Tax Rates
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
sort
stringqueryThe field and direction to sort by (ASC
or DESC
), e.g. last_synced_at ASC
. Currently supports the fields: updated_at
, last_synced_at
. If a field is provided but ASC
or DESC
is not, defaults to ASC
. If this field is omitted, defaults, to updated_at DESC
.
updated_at_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
tax_rates
arrayRequiredtax_rates
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
Fetch a Tax Rate
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
tax_rate
objectRequiredtax_rate
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
Have questions?
Contact support for personalized guidance.