Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Tax Type

🔒 List Tax Type Entries

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

Retrieves a list of tax type entries.

get/api/v1/taxType

Query parameters

key'id' | 'name' | 'description' | 'isStandard' | 'createdAt' | 'updatedAt'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'

The following filter key values are available:\n\nname (string): Tax type name \n\ndescription (string): Tax type description \n\nisStandard (bool): Is standard tax type true / false\n\ncreatedAt (string): format: date-time : Created at, example: 2022-09-13T12:41:18+02:00 \n\nupdatedAt (string): format: date-time : Updated at, example: 2022-09-13T12:41:18+02:00

[
  {
    "key": "id"
  }
]
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'name' | 'description' | 'isStandard' | 'createdAt' | 'updatedAt'
dir'asc' | 'desc'

Response

Successful operation

Example response

{
  "data": [
    {
      "id": "1",
      "name": "custom_tax_type",
      "description": "Custom tax type for testing",
      "isStandard": false,
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z"
    }
  ]
}