TaxRates

The Tax rate object represents tax data in the invoicing system.

You can find out more about tax rates in our Help documentation: Setting up and Managing Tax Rates in Invoicing.

Following diagram shows tax rates in our data hierarchy:

SubsidiaryLine ItemLine ItemLine ItemTax RateTax Rate

Attributes

archived_at string
Response

Timestamp when this tax rate was archived, or null if active.
id integer
Parameter `filter`

The unique identifier of this tax rate.
name string
Response Request Parameter `filter` Parameter `sort`

The display name of this tax rate.
organization organization
Response

The organization this tax rate belongs to.
primary_component_name string
Response Request Parameter `filter`

The label for the primary tax component (e.g. VAT or GST).
primary_component_value number
Response Request Parameter `filter`

The percentage value of the primary tax component.
secondary_component_name string
Response Request Parameter `filter`

The label for the optional secondary tax component (e.g. PST in Canada).
secondary_component_value number
Response Request Parameter `filter`

The percentage value of the optional secondary tax component.
status integer
Parameter `filter` Enum

The status of this tax rate, used for filtering (active or archived).

Enum Values (2 values)

  • 1
  • 2
subsidiary subsidiary
Response

The subsidiary this tax rate is associated with.
subsidiary_id integer
Request

ID of the subsidiary this tax rate is associated with.
subsidiary_name object
Parameter `sort`

The name of the subsidiary this tax rate is associated with.

Operations

GET /api/v2/tax_rates
Get tax rates
POST /api/v2/tax_rates
Create a tax rate
GET /api/v2/tax_rates/{id}
Gets a tax rate
PATCH /api/v2/tax_rates/{id}
Update a tax rate
PATCH /api/v2/tax_rates/{id}/archive
Archives a tax rate
PATCH /api/v2/tax_rates/{id}/restore
Restores an archived tax rate