Tax Code GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/accounting-service/tax-code/{ID-SET}

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

This message allows you to retrieve tax codes by ID(s). If you don't specify an ID it will retrieve all available tax codes.

Detailed field description:

Field Name Field Description
id The ID of the tax code
code The code of the tax code
description A description of the tax code
rate The rate for that tax code

Example 1

This example shows some of the tax codes created by default for a UK Brightpearl account

Request URI

/tax-code

Response

{
	"response": [
		{
			"id": 1,
			"code": "T0",
			"description": "Zero rated"
		},
		{
			"id": 2,
			"code": "T1",
			"description": "Standard rate : 20% VAT",
			"rate": 20
		},
		{
			"id": 3,
			"code": "T2",
			"description": "Tax exempt"
		}
	]
}

Example 2

This is an example of retrieving tax codes by specifying an Id set.

Request URI

/tax-code/1,3,7-9

Response

{
	"response": [
		{
			"id": 1,
			"code": "T0",
			"description": "Zero rated"
		},
		{
			"id": 3,
			"code": "T2",
			"description": "Tax exempt"
		},
		{
			"id": 7,
			"code": "T8",
			"description": "EU Standard purchases"
		},
		{
			"id": 8,
			"code": "T20",
			"description": "VAT (20%)",
			"rate": 20
		},
		{
			"id": 9,
			"code": "T50",
			"description": "newTaxCode",
			"rate": 47.4568
		}
	]
}