v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
VAT Rates

Get VAT Rate

Endpoint to retrieve a specific VatRate by ID.

get/business/v2/entities/tax-rate/{taxRateId}

Path parameters

taxRateIdstring required

The VatRate ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The returned resource is a single VatRate.

idstring

The VATRate ID.

codestring

The code of the VATRate.

namestring

The name of the VATRate

descriptionstring

A custom description of the VATRate.

percentagenumber double

The percentage value of the VATRate

enabledboolean

The VATRate is visible in the transaction detail.

integrationstring

The VATRate's corresponding integration.

creation_timestring

The date and time when the VATRate was created (sortable: yes).

last_update_timestring

The date and time when the VATRate was last updated (sortable: yes).

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "code": "code-vat-11",
  "name": "Tax 11",
  "description": "Number 11 of Tax code",
  "percentage": 15,
  "enabled": true,
  "integration": "something",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z"
}