Common ModelsTax Rates

The TaxRate object

Beta

The TaxRate object is used to represent a tax rate.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
companystring or nullOptionalformat: "uuid"
The subsidiary that the tax rate belongs to (in the case of multi-entity systems).
codestring or nullOptional<=100 characters
The tax code associated with this tax rate or group of tax rates from the third-party platform.
namestring or nullOptional<=100 characters
The tax rate’s name.
descriptionstring or nullOptional
The tax rate's description.
statusenum or nullOptional
The tax rate’s status - `ACTIVE` if an active tax rate, `ARCHIVED` if not active. * `ACTIVE` - ACTIVE * `ARCHIVED` - ARCHIVED
Allowed values:
countrystring or nullOptional<=100 characters
The country the tax rate is associated with.
total_tax_ratedouble or nullOptional
The tax’s total tax rate - sum of the tax components (not compounded).
effective_tax_ratedouble or nullOptional
The tax rate’s effective tax rate - total amount of tax with compounding.
tax_componentslist of objectsOptional
The related tax components of the tax rate.
remote_was_deletedbooleanOptionalRead-only
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only