APapaleo
TaxDefinition

Get a specific tax definition.

Get a specific tax definition by its id.<br>You must have this scope: 'admin'.

get/taxes/v0-nsfw/tax-definitions/{id}

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/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: admin

Path parameters

idstring required

The id of the tax definition.

Response

Success.

idstring required

The id of the tax definition.

codestring required

The code of the tax definition.

propertyIdstring required

The id of the property this tax definition belongs to.

nameobject required

The name of the tax definition, as displayed to guests on folio, invoice, etc.

descriptionobject required

The description of the tax definition.

classification'LocalTax' | 'ConsumptionTax' required

The classification of the tax definition.

vatType'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed' required

The VAT type that applies to this tax definition. Set to 'Without' if no VAT applies.

vatHandlingType'Excluded' | 'Included' required

Whether VAT is included in or excluded from calculated tax amount.

Example response

{
  "id": "MUC-ALCOHOL",
  "code": "ALCOHOL",
  "propertyId": "MUC",
  "name": {
    "en": "Alcohol tax"
  },
  "description": {
    "en": "Alcohol tax description"
  },
  "classification": "ConsumptionTax",
  "vatType": "Reduced",
  "vatHandlingType": "Included",
  "applicability": {
    "appliedTo": {
      "services": [
        {
          "serviceType": "FoodAndBeverages",
          "subAccountIds": [
            "ALCOHOL"
          ]
        }
      ]
    }
  },
  "calculationRules": [
    {
      "validityPeriod": {
        "from": "2025-06-01",
        "to": "2025-08-31"
      },
      "stayDayIndexRange": {
        "from": 0,
        "to": 10
      },
      "priority": 10,
      "calculationKind": "Percent",
      "calculationBase": "Gross",
      "calculation": {
        "type": "PerService",
        "perService": {
          "value": 7.5
        }
      }
    }
  ]
}

Changes

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