Tax Rates
TheTaxRate object is used to represent a tax rate.The TaxRate object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
remote_dataRemoteData[]Optional
descriptionStringOptional
The tax rate's description.
total_tax_rateNumberOptional
The tax rate's total tax rate.
effective_tax_rateNumberOptional
The tax rate's effective tax rate.
remote_was_deletedBooleanRequired
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","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
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","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"description": "Sales Tax","total_tax_rate": 15,"effective_tax_rate": 15,"remote_was_deleted": true}]}
Field support by platform
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringeffective_tax_rateNumberremote_dataRemoteData[]remote_idStringtotal_tax_rateNumber
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]remote_idStringtotal_tax_rateNumber
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]remote_idStringtotal_tax_rateNumber
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringeffective_tax_rateNumberremote_dataRemoteData[]total_tax_rateNumber
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringeffective_tax_rateNumberremote_dataRemoteData[]remote_idStringtotal_tax_rateNumberHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/tax-rates/{id}
Returns a TaxRate object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
idStringRequired
include_remote_dataBooleanOptional
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","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"description": "Sales Tax","total_tax_rate": 15,"effective_tax_rate": 15,"remote_was_deleted": true}
Field support by platform
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringeffective_tax_rateNumberremote_dataRemoteData[]remote_idStringtotal_tax_rateNumberQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]remote_idStringtotal_tax_rateNumberSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]remote_idStringtotal_tax_rateNumberXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringeffective_tax_rateNumberremote_dataRemoteData[]total_tax_rateNumberZoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringeffective_tax_rateNumberremote_dataRemoteData[]remote_idStringtotal_tax_rateNumberHint: Use the /linked-accounts endpoint to pull platform support information.