For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The TaxRate object
          • GET/tax-rates
          • GET/tax-rates/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsTax Rates

The TaxRate object

Beta
The TaxRate Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "company": "string",
7  "code": "string",
8  "name": "string",
9  "description": "string",
10  "status": "ACTIVE",
11  "country": "string",
12  "total_tax_rate": 1,
13  "effective_tax_rate": 1,
14  "tax_components": [
15    {
16      "id": "string",
17      "remote_id": "string",
18      "created_at": "2023-01-01T00:00:00Z",
19      "modified_at": "2023-01-01T00:00:00Z",
20      "name": "string",
21      "rate": "string",
22      "is_compound": true,
23      "component_type": "SALES",
24      "remote_was_deleted": true
25    }
26  ],
27  "remote_was_deleted": true,
28  "field_mappings": {},
29  "remote_data": [
30    {
31      "path": "string",
32      "data": {}
33    }
34  ]
35}
Was this page helpful?
Previous

/sales-orders/bulk/{batch_id}

Next

/tax-rates

Built with

The TaxRate object is used to represent a tax rate.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
companystring or nullOptionalformat: "uuid"

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

codestring or nullOptional<=100 characters

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

namestring or nullOptional<=100 characters

The tax rate’s name.

descriptionstring or nullOptional
The tax rate's description.
statusenum or nullOptional

The tax rate’s status - ACTIVE if an active tax rate, ARCHIVED if not active.

  • ACTIVE - ACTIVE
  • ARCHIVED - ARCHIVED
Allowed values:
countrystring or nullOptional<=100 characters
The country the tax rate is associated with.
total_tax_ratedouble or nullOptional

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

effective_tax_ratedouble or nullOptional

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

tax_componentslist of objectsOptional
The related tax components of the tax rate.
remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only