APapaleo
TaxDefinition

Create a tax definition.

Create a new tax definition.<br>You must have this scope: 'admin'.

post/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

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

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. Immutable after creation.

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 request

{
  "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
        }
      }
    }
  ]
}

Response

Tax definition successfully created.

idstring required

The id of the created tax definition.

Changes

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