YOyoco
Taxes

Fetch a tax

Changed on

Fetch a tax

Required scope: business/catalogue:read

Deprecated alias: business/products:read (still accepted, will be removed in a future release)

get/v1/taxes/{tax_id}

Request

  • Base URL
    https://api.yoco.com
  • Auth
    HTTP bearer

Path parameters

tax_idstring required

The unique identifier of the tax.

Response

Successful Response

idstring required

The unique identifier of the tax.

namestring required

A human-readable name for the tax.

type'additive' | 'inclusive' required

TaxType can be either additive or inclusive and affects how tax is calculated.

For additive tax, the tax is calculated on top of the price. For example, an item which costs R100.00 with a 15% additive tax has a total cost to the buyer of R115.00 (R100.00 * 1.15). The tax amount is therefore R115.00 - R100.00 = R15.00.

For inclusive tax, the tax is included in the price. For example, an item which costs R115.00 with a 15% inclusive tax has a total cost to the buyer of R115.00. The tax amount is R15.00 (R115.00 * 15/115) whilst the taxable amount is R100 (R115.00 - R15.00).

percentagestring required

The tax rate. For example, 15.00 corresponds to a tax rate of 15%.

is_defaultboolean required

Whether this is the business's default tax. An item with no taxes of its own is charged the default tax. The merchant chooses the default tax in the Yoco app.

created_atstring date-time required

The tax creation date and time in ISO 8601 format.

updated_atstring date-time required

The date and time the tax was last modified in ISO 8601 format.

Example response

{
  "created_at": "2024-11-19T15:27:02+00:00",
  "id": "1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852",
  "is_default": true,
  "name": "VAT",
  "percentage": "15.00",
  "type": "inclusive",
  "updated_at": "2024-11-19T16:27:23+00:00"
}

Changes