APapaleo
TaxDefinition

Get all tax definitions.

Get a list of tax definitions, optionally filtered by property.<br>You must have this scope: 'admin'.

get/taxes/v0-nsfw/tax-definitions

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/taxes/v0-nsfw/tax-definitions
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: admin

Query parameters

propertyIdsstring[]

Filter by the specified property ids

Response

Success.

countinteger required

Total count of items

Example response

{
  "taxDefinitions": [
    {
      "id": "MUC-ALCOHOL",
      "code": "ALCOHOL",
      "propertyId": "MUC",
      "name": "Alcohol tax",
      "description": "Tax on alcoholic beverages",
      "classification": "ConsumptionTax",
      "vatType": "Reduced",
      "vatHandlingType": "Included"
    }
  ],
  "count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.