Tax Rates
The
TaxRate object is used to represent a tax rate.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
companyUUIDOptional
The subsidiary that the tax rate belongs to (in the case of multi-entity systems).
codeStringOptional
The tax code associated with this tax rate or group of tax rates from the third-party platform.
nameStringOptional
The tax rate’s name.
descriptionStringOptional
The tax rate's description.
statusEnumOptional
The tax rate’s status -
ACTIVE if an active tax rate, ARCHIVED if not active. Possible values include: ACTIVE, ARCHIVED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.countryStringOptional
The country the tax rate is associated with.
total_tax_rateNumberOptional
The tax’s total tax rate - sum of the tax components (not compounded).
effective_tax_rateNumberOptional
The tax rate’s effective tax rate - total amount of tax with compounding.
tax_componentsTaxComponent[]Required
The related tax components of the tax rate.
The TaxComponent object
The
TaxComponent object is used to represent any sub-taxes that make up the TaxRate.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The tax rate’s name.
rateStringOptional
The tax component’s rate.
is_compoundBooleanOptional
Returns True if the tax component is compound, False if not.
component_typeEnumOptional
Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax. Possible values include:
SALES, PURCHASE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanRequired
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.
remote_was_deletedBooleanRequired
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_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/tax-rates
Betahttps://api.merge.dev/api/accounting/v1/tax-rates
US
EU
APAC
Returns a list of TaxRate objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return tax rates for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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.
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).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
effective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumber
Moneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumber
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
tax_componentsTaxComponent[]remote_idstringnamestringratestringcomponent_typestringcodeStringcompanyUUIDcountryStringdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumber
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
tax_componentsTaxComponent[]remote_idstringnamestringratestringcomponent_typestringcodeStringdescriptionStringeffective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumber
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumber
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
codeStringcompanyUUIDdescriptionStringeffective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumber
Wave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
codeStringdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumber
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
tax_componentsTaxComponent[]namestringratestringis_compoundbooleancodeStringdescriptionStringeffective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumber
Zoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdescriptionStringeffective_tax_rateNumberremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumberGET
/tax-rates/{id}
Betahttps://api.merge.dev/api/accounting/v1/tax-rates/{id}
US
EU
APAC
Returns a TaxRate object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
effective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumberMoneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumberNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
tax_componentsTaxComponent[]remote_idstringnamestringratestringcomponent_typestringcodeStringcompanyUUIDcountryStringdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumberQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
tax_componentsTaxComponent[]remote_idstringnamestringratestringcomponent_typestringcodeStringdescriptionStringeffective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumberSage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumberSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
codeStringcompanyUUIDdescriptionStringeffective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumberWave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
codeStringdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumberXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
tax_componentsTaxComponent[]namestringratestringis_compoundbooleancodeStringdescriptionStringeffective_tax_rateNumbernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_tax_rateNumberZoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdescriptionStringeffective_tax_rateNumberremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_tax_rateNumber