Common ModelsTax Rates

/tax-rates/{id}

Beta

Returns a TaxRate object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
companystring or nullformat: "uuid"

The subsidiary that the tax rate belongs to (in the case of multi-entity systems).

codestring or null<=100 characters

The tax code associated with this tax rate or group of tax rates from the third-party platform.

namestring or null<=100 characters

The tax rate’s name.

descriptionstring or null
The tax rate's description.
statusenum or null
The tax rate’s status - `ACTIVE` if an active tax rate, `ARCHIVED` if not active. * `ACTIVE` - ACTIVE * `ARCHIVED` - ARCHIVED
Allowed values:
countrystring or null<=100 characters
The country the tax rate is associated with.
total_tax_ratedouble or null

The tax’s total tax rate - sum of the tax components (not compounded).

effective_tax_ratedouble or null

The tax rate’s effective tax rate - total amount of tax with compounding.

tax_componentslist of objects
The related tax components of the tax rate.
remote_was_deletedbooleanRead-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.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only