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

idstringRequired

The Rutter generated unique ID of the tax rate.

platform_idstringRequired

The platform specific ID of the tax rate.

codestringnullableRequired

The tax code of the tax rate.

effective_tax_ratenumbernullableRequired

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.

namestringnullableRequired

The name of the tax rate.

total_tax_ratenumbernullableRequired

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
additional_fieldsobject

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

Show additional_fields attributes
componentsarraynullableRequired

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

Show components attributes
updated_atstringnullableRequired

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

last_synced_atstringRequired

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

platform_dataobject

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.

    cursorstringquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    last_synced_at_minintegerquery

    Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

    limitintegerquery

    The limit on the number of entities returned.

    sortstringquery

    The 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_maxintegerquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegerquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    tax_ratesarrayRequired
    Show tax_rates attributes
    next_cursorstringnullable
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop

Fetch a Tax Rate

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

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    tax_rateobjectRequired
    Show tax_rate attributes
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop

Have questions?

Contact support for personalized guidance.

Contact support