Tax Rates
The TaxRate object is used to represent a tax rate.
The TaxRate object
Properties

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.

companyString
Optional
The company the tax rate belongs to.

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

idString
Required

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

field_mappingsObject
Optional

modified_atString
Required
This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]
Optional

The TaxRate object
JSON
{
"description": "Sales Tax",
"total_tax_rate": 15,
"effective_tax_rate": 15,
"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
"remote_was_deleted": true,
"id": "b82302de-852e-4e60-b050-edf9da3b7c02",
"remote_id": "039111",
Show advanced fields
}

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

company_idString
Optional
If provided, will only return tax rates for this company.

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.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

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, only objects synced by Merge after this date time will be returned.

modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.

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": [
{
"description": "Sales Tax",
"total_tax_rate": 15,
"effective_tax_rate": 15,
"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
"remote_was_deleted": true,
"id": "b82302de-852e-4e60-b050-edf9da3b7c02",
"remote_id": "039111",
Show advanced fields
}
]
}
Field support by platform
FreshBooks
FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_tax_rateNumber
Moneybird
Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_tax_rateNumber
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

remote_dataRemoteData[]
pathstring
dataobject

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_dataRemoteData[]
pathstring
dataobject

remote_idString

total_tax_rateNumber
Xero
Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_dataRemoteData[]
pathstring
dataobject

total_tax_rateNumber
Zoho Books
Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

descriptionString

effective_tax_rateNumber

remote_dataRemoteData[]
pathstring
dataobject

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

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"description": "Sales Tax",
"total_tax_rate": 15,
"effective_tax_rate": 15,
"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
"remote_was_deleted": true,
"id": "b82302de-852e-4e60-b050-edf9da3b7c02",
"remote_id": "039111",
Show advanced fields
}
Field support by platform
FreshBooks
FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_tax_rateNumber
Moneybird
Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

total_tax_rateNumber
QuickBooks Online
QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

remote_dataRemoteData[]
pathstring
dataobject

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_dataRemoteData[]
pathstring
dataobject

remote_idString

total_tax_rateNumber
Xero
Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

effective_tax_rateNumber

remote_dataRemoteData[]
pathstring
dataobject

total_tax_rateNumber
Zoho Books
Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

descriptionString

effective_tax_rateNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

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