APapaleo
CityTax

Create a city tax.

<br>You must have at least one of these scopes: 'settings.manage, setup.manage'.

post/settings/v1/city-tax

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/settings/v1/city-tax
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.manage, setup.manage, 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

nameobject required

The name of the city tax, as displayed to guests on invoice, offer, etc.

Typical names are city tax or tourist tax.

descriptionobject required

The description of the city tax, as displayed to guests. Add information on when it applies, and how it is calculated.

propertyIdstring required

The ID of the property for which the city tax is created

type'PercentOfGross' | 'PercentOfNet' | 'PerRoomPerNight' | 'PerPersonPerNight' | 'PerPersonPerNightBasedOnNetPrice' | 'PerPersonPerNightBasedOnGrossPrice' required

The base on which the city tax is calculated.

taxHandlingType'BeforeTax' | 'AfterTax' required

How to treat the calculated city tax: as before tax or after tax

valuenumber double required

Depending on the type, the percent or multiplier used to calculate city tax

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

If the city tax is subject to VAT, specify which VAT applies. If not, specify 'Without'.

codestring nullable

The code for the city tax

priorityinteger nullable

Order in which city taxes should be applied. Lower numbers are applied first. If not provided tax receives priority of existing tax priority + 1, or 1 if no other city tax for this property exists.

includeCityTaxInRateAmountboolean nullable

Whether city tax is included in the rate, or added on top of it. Default is false

limitinteger nullable

If set, limits the calculation of the city tax to the specified number of time slices, starting from the beginning.

If not set, the city tax will be calculated for the whole stay.

Example request

{
  "name": {
    "en": "City tax",
    "de": "City-Tax"
  },
  "description": {
    "en": "2 Euro per person and night. Business travellers and close family members of citizens do not have to pay city tax.",
    "de": "2 Euro pro Person und Nacht. Geschäftsreisende und nahe Familienmitglieder von Anwohnern müssen keine City-Tax bezahlen."
  },
  "propertyId": "MUC",
  "type": "PerPersonPerNight",
  "taxHandlingType": "BeforeTax",
  "value": 2,
  "vatType": "Normal",
  "code": "TAX",
  "priority": 1,
  "includeCityTaxInRateAmount": false,
  "subcategories": [
    {
      "name": {
        "en": "Children under 12 don't have to pay city tax",
        "de": "Kinder unter 12 Jahren zahlen keine City-Tax"
      },
      "value": 0,
      "age": {
        "min": 0,
        "max": 12
      }
    }
  ],
  "ignoredFor": [
    {
      "distributionChannel": {
        "channelCode": "ChannelManager",
        "sources": [
          "bookingcom"
        ]
      }
    }
  ]
}

Response

City tax successfully created.

idstring required

The city tax ID

Example response

{
  "id": "MUC-FLE"
}

Changes

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