Tax Rates

The TaxRate object is used to represent a tax rate.

The TaxRate object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

descriptionString
Optional
The tax rate's description.

total_tax_rateNumber
Optional
The tax rate's total tax rate.

effective_tax_rateNumber
Optional
The tax rate's effective tax rate.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The TaxRate object
JSON
{
"id": "b82302de-852e-4e60-b050-edf9da3b7c02",
"remote_id": "039111",
"description": "Sales Tax",
"total_tax_rate": 15,
"effective_tax_rate": 15,
"remote_was_deleted": true
}

GET

/tax-rates

Returns a list of TaxRate objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "b82302de-852e-4e60-b050-edf9da3b7c02",
"remote_id": "039111",
"description": "Sales Tax",
"total_tax_rate": 15,
"effective_tax_rate": 15,
"remote_was_deleted": true
}
]
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_idString

total_tax_rateNumber

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_idString

total_tax_rateNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

remote_idString

total_tax_rateNumber

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

total_tax_rateNumber

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_idString

total_tax_rateNumber
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/tax-rates/{id}

Returns a TaxRate object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "b82302de-852e-4e60-b050-edf9da3b7c02",
"remote_id": "039111",
"description": "Sales Tax",
"total_tax_rate": 15,
"effective_tax_rate": 15,
"remote_was_deleted": true
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_idString

total_tax_rateNumber

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_idString

total_tax_rateNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

remote_idString

total_tax_rateNumber

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

total_tax_rateNumber

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_idString

total_tax_rateNumber
Hint: Use the /linked-accounts endpoint to pull platform support information.