Skip to main content

Manage Taxes

Hotel
Utility
REST API
Hospitality
Try Now

What is it?

Use this set of APIs to retrieve tax information for a specified hotel in SynXis.

Why use it?

The API can be used to:

  • Validate Taxes loaded in the SynXis CR match a secondary system
  • Export and import to a different system

How to use

Retrieve a list of Taxes specified for a specified hotel

[GET] /admin/hotels/13098/taxes
{
    "taxes": [{
        "code": "City1-10",
        "name": "City Tax 1-10 Nights",
        "description": "City Tax 1-10 Nights",
        "level": "HotelTax",
        "applyToFreeNights": false,
        "inclusive": true,
        "taxType": "VAT_GST_Tax",
        "chargeType": "Flat",
        "chargeFrequency": "PerStay",
        "validity": {
            "startDate": "2008-02-27T00:00:00",
            "endDate": "2027-09-29T00:00:00"
        },
        "amount": {
            "unitType": "Amount",
            "value": 20.0
        }
    }, {
        "code": "City11",
        "name": "City Tax 11+",
        "description": "City Tax 11+",
        "level": "HotelTax",
        "applyToFreeNights": false,
        "inclusive": true,
        "taxType": "CityTax",
        "chargeType": "Flat",
        "chargeFrequency": "PerNight",
        "validity": {
            "startDate": "2018-03-06T00:00:00",
            "endDate": "2027-09-29T00:00:00"
        },
        "amount": {
            "unitType": "Percent",
            "value": 4.50
        }
    }],
    "pagination": {
        "total": 2,
        "start": 0,
        "size": 2
    }
}


Retrieve Tax information for a specified tax code

[GET] /admin/hotels/13098/taxes/City11
{
    "code": "City11",
    "name": "City Tax 11",
    "description": "City Tax 11",
    "level": "HotelTax",
    "applyToFreeNights": false,
    "inclusive": true,
    "taxType": "CityTax",
    "chargeType": "Flat",
    "chargeFrequency": "PerNight",
    "validity": {
        "startDate": "2018-03-06T00:00:00",
        "endDate": "2027-09-29T00:00:00"
    },
    "amount": {
        "unitType": "Percent",
        "value": 4.50
    }
}