v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB

Tax Rates

Create Tax Rate

post/accounting/tax-rates

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Request body

idstring nullable

ID assigned to identify this tax rate.

display_idstring nullable

Display ID of the tax rate

namestring

Name assigned to identify this tax rate.

codestring nullable

Tax code assigned to identify this tax rate.

descriptionstring nullable

Description of tax rate

effective_tax_ratenumber nullable

Effective tax rate

countrystring nullable

Country code according to ISO 3166-1 alpha-2.

total_tax_ratenumber nullable

Not compounded sum of the components of a tax rate

tax_payable_account_idstring nullable

Unique identifier for the account for tax collected.

tax_remitted_account_idstring nullable

Unique identifier for the account for tax remitted.

typestring nullable

Tax type used to indicate the source of tax collected or paid

report_tax_typestring nullable

Report Tax type to aggregate tax collected or paid for reporting purposes

original_tax_rate_idstring nullable

ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.

status'active' | 'inactive' | 'archived' nullable

Tax rate status

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

row_versionstring nullable

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "1234",
  "display_id": "12345",
  "name": "GST on Purchases",
  "code": "ABN",
  "description": "Reduced rate GST Purchases",
  "effective_tax_rate": 10,
  "country": "US",
  "total_tax_rate": 10,
  "tax_payable_account_id": "123456",
  "tax_remitted_account_id": "123456",
  "components": [
    {
      "id": "10",
      "name": "GST",
      "rate": 10,
      "compound": true
    }
  ],
  "type": "NONE",
  "report_tax_type": "NONE",
  "original_tax_rate_id": "12345",
  "status": "active",
  "row_version": "1-12345",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ]
}

Response

TaxRate created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}