Tax Configurations

GET /accounting/tax-configurations

Group: Accounting › Tax Configurations · Operation ID: taxConfigurations

Returns a list of tax configurations, each with its header fields only. For a configuration's tax codes and GL accounts, use GET accounting/tax-configurations/:id.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
taxRegime — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, entityId, status, taxRegime, lastModifiedDate
Selectable: id, entityId, status, taxRegime, lastModifiedDate

Response

200 Success

Under data, an array of taxConfigurationsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the tax configuration.
`entityId`	string	no	The legal entity this configuration belongs to. An entity has at most one tax configuration. See id on GET base/entities.
`status`	string	no	The status of the tax configuration. The tax codes of an inactive configuration are not offered on documents. Possible values: 'Active', 'Inactive'.
`taxRegime`	string	no	The tax system that determines which tax components are valid. Possible values: 'EU_VAT', 'India_GST', 'Canada_GST', 'Ghana_VAT', 'SingleRate_GST'.
`lastModifiedDate`	string (date-time)	no	The date and time the tax configuration record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error