Taxrate data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
description | string | No | |
rate | number | No | % |
is_active | boolean | No | |
organization_id | string | No | |
metadata | AccountingMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
effective_rate | number | No | Net effective rate in %, where it differs from the nominal rate |
total_rate | number | No | Sum of all components, in % |
components | AccountingTaxrateComponent[] | No | Component parts of a compound or multi-component tax |
components[].name | string | No | Name of the tax component, e.g. GST or PST |
components[].rate | number | No | Rate of this component, in % |
components[].is_compound | boolean | No | True when this component is charged on top of the other components |
type | enum | No | Whether the rate applies to sales, purchases, or both Values: SALES, PURCHASE, BOTH, OTHER |
is_compound | boolean | No | True when the rate stacks on top of other taxes |
country | string | No | Jurisdiction country |
region | string | No | Jurisdiction state / province |
Are we missing anything? Let us know