List Taxes | Coperniq API

Lists tax rates configured for your company. Use these IDs when assigning taxes to quotes, invoices, and other financial documents. The company is implied by the API key; companyId is not returned on each item.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

include_archivedbooleanOptionalDefaults to false

Whether to include archived (inactive) records in the response. By default only active records are returned.

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

Response

List of company taxes (paginated)

idinteger

Tax identifier (use as taxId on quotes and invoices where supported)

namestring

Display name of the tax

ratestring

Tax rate as a percentage decimal string (e.g. “7.2500” for 7.25%)

isArchivedboolean

Whether this tax is archived and hidden from default listings

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

502

Bad Gateway Error

1	const url = 'https://api.coperniq.io/v1/taxes';
2	const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}

1	[
2	{
3	"id": 1,
4	"name": "string",
5	"rate": "string",
6	"isArchived": true,
7	"createdAt": "2024-01-15T09:30:00Z",
8	"updatedAt": "2024-01-15T09:30:00Z"
9	}
10	]