APapaleo
CityTax

Get a specific city tax.

Get a specific city tax.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.

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

Path parameters

idstring required

The ID of the city tax.

Query parameters

languagesstring[]

'all' or comma separated list of two-letter language codes (ISO Alpha-2)

Response

Success.

idstring required

The ID of this city tax

codestring required

The code for the city tax

nameobject required

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

descriptionobject required

The description of the city tax, as displayed to guests.

propertyIdstring required

The ID of the property for which the city tax was 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

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.

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

Specifies which VAT applies.

priorityinteger required

Order in which city taxes should be applied. Lower numbers are applied first

includeCityTaxInRateAmountboolean required

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

Example response

{
  "id": "MUC-TAX",
  "code": "TAX",
  "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,
  "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
      }
    }
  ],
  "pricingRules": [
    {
      "value": 0,
      "maxPrice": 10
    },
    {
      "value": 0.5,
      "maxPrice": 25
    },
    {
      "value": 1,
      "maxPrice": 50
    }
  ],
  "vatType": "Without",
  "priority": 1,
  "includeCityTaxInRateAmount": true,
  "ignoredFor": [
    {
      "distributionChannel": {
        "channelCode": "ChannelManager",
        "sources": [
          "bookingcom"
        ]
      }
    }
  ]
}

Changes

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