What is it?
With the Manage Taxes API, you can use the endpoints to manage a hotel's taxes in the following ways:
- Create, update, and delete taxes in SynXis CR from a secondary system.
- Validate whether taxes loaded in the SynXis CR match a secondary system.
- Export taxes to a different system.
- Import taxes from a different system.
- Create and update seasons for a specified tax.
- Delete all seasons for a specified tax.
- Retrieve seasons for a specified tax.
- Retrieve seasons for all taxes for a specified hotel.
Before You Begin
- You must authenticate before you can use this API. For full instructions, see Authentication for the REST APIs.
- At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.
How to use
This section covers the endpoints for this API and examples of how to use them.
GET taxes for a hotel
This endpoint enables you to retrieve a list of taxes for a hotel that you specify.
[GET] /v1/api/admin/hotels/{id}/taxes
Path Parameters
The following table describes the path parameters that you must include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
id | The ID of the hotel for which you want to get tax information. | integer | Yes |
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
taxType | Available list of OpenTravel Alliance (OTA) standards for interfaces. | string | No |
pageStart | The starting record to return in the response. Example: 0 | integer | No |
pageSize | The number of records to return in the response. Use 0 to return all. Example: 25 | integer | No |
multiSeason | Use true to return all ACTIVE Taxes configured with multiSeason. Example: true | boolean | No |
Response in JSON
{
"links": [
{
"href": "string",
"rel": "self"
}
],
"taxes": [
{
"links": [
{
"href": "string",
"rel": "self"
}
],
"id": "14523",
"code": "CITY10",
"name": "City Tax 1-10 nights",
"description": "City tax that applies to stays between 1 and 10 nights.",
"level": "HotelTax",
"applyToFreeNights": true,
"calculateFromRoomPricing": true,
"calculateFromPackagePricing": true,
"inclusive": false,
"taxType": "Unknown",
"chargeType": "Unknown",
"chargeFrequency": "PerNight",
"validity": {
"startDate": "2020-01-01",
"endDate": "2020-12-31"
},
"amount": {
"unitType": "Percentage",
"value": 10.1
},
"hotel": {
"links": [
{
"href": "string",
"rel": "self"
}
],
"id": "11113",
"code": "CHANCON2",
"name": "SynXis Test Hotel"
},
"RateList": [
{
"code": "BAR",
"name": "Best Available Rate"
}
],
"RoomList": [
{
"code": "A1K",
"name": "Single King"
}
],
"Multiseason": true,
"sortOrder": {
"value": 0
}
}
],
"pagination": {
"size": 50,
"start": 0,
"total": 146
}
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
links | The array of Links elements. | array |
href | Link to the related API request. | string |
rel | Describes the relationship between the href and the current request. Example: self | string |
taxes | The array of Taxes elements. | array |
id | The ID associated with the tax. Example: 14523 | string |
code | The code associated with the tax. Example: CITY10 | string |
name | The name of the tax. Example: City Tax 1-10 nights | string |
description | Descriptive information about the tax. Example: City tax that applies to stays between 1 and 10 nights. | string |
level | Indicates what the tax is based on. | string |
applyToFreeNights | If true, indicates that taxes are applied to all nights in a reservation, including nights where the price is zero. Example: True | boolean |
calculateFromRoomPricing | If true, indicates that the tax uses only the base price (not the net room price) and not previous taxes to calculate this tax. | boolean |
calculateFromPackagePricing | If true, indicates that the tax uses only the base price of the package and not previous taxes to calculate this tax. | boolean |
inclusive | If true, indicates that the tax is included in the rate. | boolean |
taxType | Tax type that best describes the tax. | string |
chargeType | Indicates how the tax is applied. | string |
chargeFrequency | Indicates how the tax is calculated. | string |
validity | The array of start date and end date during which the tax is valid. | array |
startDate | Date when the tax became effective (yyyy-mm-dd). Example: 2025-01-01 | string |
endDate | Last date when the tax is effective (yyyy-mm-dd). Example: 2025-12-31 | string |
amount | The array of tax amount elements. | array |
unitType | Unit type associated to the value. Example: Percentage | string |
value | Value of the tax. Example: 10.1 | number |
hotel | The array of links for the hotel. | array |
links | The array of hotel links elements. | array |
href | Link to the hotel. | string |
rel | Describes the relationship between the href and the current request. Example: self | string |
RateList | The array of rates elements. | array |
code | Code associated with the particular rate. Example: BAR | string |
name | Name of the rate. Example: Best Available Rate | string |
RoomList | The array of rooms elements. | array |
code | Code associated with the particular room. Example: A1K | string |
name | Name of the room. Example: Single King | string |
Multiseason | If true, indicates that the tax is allowing multiple seasons. Example: True | boolean |
sortOrder | The array of sort order elements. | array |
value | Zero-based sort order of the tax (0 = first). | integer |
pagination | The array of pagination elements. | array |
size | Number of records to be returned in the response (0 = return all). Example: 50 | integer |
start | Starting record to be returned in the response. | integer |
total | Total number of records. Example: 146 | integer |
GET taxes for a tax code
This endpoint enables you to retrieve tax information for a tax code that you specify.
[GET] /v1/api/admin/hotels/{id}/taxes/{code}
Path Parameters
The following table describes the path parameters that you must include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
id | The ID of the hotel for which you want to get tax information. | integer | Yes |
code | The code of the tax for which you want to get tax information. | integer | Yes |
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
taxLevel | The tax Level applied to reservations. Available values: HotelTax, PackageTax, RateTax, RoomTax | string | No |
Response in JSON
{
"links": [
{
"href": "string",
"rel": "self"
}
],
"taxes": [
{
"links": [
{
"href": "string",
"rel": "self"
}
],
"id": "14523",
"code": "CITY10",
"name": "City Tax 1-10 nights",
"description": "City tax that applies to stays between 1 and 10 nights.",
"level": "HotelTax",
"applyToFreeNights": true,
"calculateFromRoomPricing": true,
"calculateFromPackagePricing": true,
"inclusive": false,
"taxType": "Unknown",
"chargeType": "Unknown",
"chargeFrequency": "PerNight",
"validity": {
"startDate": "2020-01-01",
"endDate": "2020-12-31"
},
"amount": {
"unitType": "Percentage",
"value": 10.1
},
"hotel": {
"links": [
{
"href": "string",
"rel": "self"
}
],
"id": "11113",
"code": "CHANCON2",
"name": "SynXis Test Hotel"
},
"RateList": [
{
"code": "BAR",
"name": "Best Available Rate"
}
],
"RoomList": [
{
"code": "A1K",
"name": "Single King"
}
],
"Multiseason": true,
"sortOrder": {
"value": 0
}
}
],
"pagination": {
"size": 50,
"start": 0,
"total": 146
}
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
links | The array of Links elements. | array |
href | Link to the related API request. | string |
rel | Describes the relationship between the href and the current request. Example: self | string |
taxes | The array of Taxes elements. | array |
id | The ID associated with the tax. Example: 14523 | string |
code | The code associated with the tax. Example: CITY10 | string |
name | The name of the tax. Example: City Tax 1-10 nights | string |
description | Descriptive information about the tax. Example: City tax that applies to stays between 1 and 10 nights. | string |
level | Indicates what the tax is based on. | string |
applyToFreeNights | If true, indicates that taxes are applied to all nights in a reservation, including nights where the price is zero. Example: True | boolean |
calculateFromRoomPricing | If true, indicates that the tax uses only the base price (not the net room price) and not previous taxes to calculate this tax. | boolean |
calculateFromPackagePricing | If true, indicates that the tax uses only the base price of the package and not previous taxes to calculate this tax. | boolean |
inclusive | If true, indicates that the tax is included in the rate. | boolean |
taxType | Tax type that best describes the tax. | string |
chargeType | Indicates how the tax is applied. | string |
chargeFrequency | Indicates how the tax is calculated. | string |
validity | The array of start date and end date during which the tax is valid. | array |
startDate | Date when the tax became effective (yyyy-mm-dd). Example: 2025-01-01 | string |
endDate | Last date when the tax is effective (yyyy-mm-dd). Example: 2025-12-31 | string |
amount | The array of tax amount elements. | array |
unitType | Unit type associated to the value. Example: Percentage | string |
value | Value of the tax. Example: 10.1 | number |
hotel | The array of links for the hotel. | array |
links | The array of hotel links elements. | array |
href | Link to the hotel. | string |
rel | Describes the relationship between the href and the current request. Example: self | string |
RateList | The array of rates elements. | array |
code | Code associated with the particular rate. Example: BAR | string |
name | Name of the rate. Example: Best Available Rate | string |
RoomList | The array of rooms elements. | array |
code | Code associated with the particular room. Example: A1K | string |
name | Name of the room. Example: Single King | string |
Multiseason | If true, indicates that the tax is allowing multiple seasons. Example: True | boolean |
sortOrder | The array of sort order elements. | array |
value | Zero-based sort order of the tax (0 = first). | integer |
pagination | The array of pagination elements. | array |
size | Number of records to be returned in the response (0 = return all). Example: 50 | integer |
start | Starting record to be returned in the response. | integer |
total | Total number of records. Example: 146 | integer |
POST a new tax
This endpoint enables you to create a new tax.
[POST] /v1/api/admin/tax
Post Body Parameters
The following table describes the parameters to include in your post request:
Element | Description | Type |
---|---|---|
Criteria | The array to hold criteria for the tax. | array |
code | The code that identifies the tax. | string |
level | Indicates what the tax is based on. | string |
Hotel | The array to hold the ID of the hotel for which you are creating this tax. | array |
id | The ID of the hotel for which you are creating this tax. | string |
CreateTaxHeader | The array to hold the header information for the tax that you are creating. | array |
name | The name for the tax that you are creating. | string |
description | A description for the tax that you are creating. | string |
level | Indicates what the tax is based on. | string |
taxType | The type for the tax that you are creating. | string |
startDate | The first date when the tax can be used. | integer |
endDate | The last date when the tax can be used. | integer |
amount | The amount of the tax. This is configured in the amountFactorType element and is usually a percentage. | integer |
amountFactorType | Set this to the name of the element in which you configure the tax amount factor type. | string |
multiSeason | Set this to true if you want the tax to be enabled for seasons. Set this to false if you do not want the tax to use seasons. | boolean |
Attributes | The array to hold the attributes of the tax you are creating. | array |
applyToFreeNight | If true, the system applies taxes or fees to Points Only Using Hotel Tier redemption rates. If false, the system does not apply taxes or fees to Points Only Using Hotel Tier redemption rates.
| boolean |
chargeFrequency | Indicates how the tax is calculated. Example: You might set this to PerNight if your tax will be calculated per night in a reservation. | string |
calculateFromExternalRate | Set this to true if the tax will be calculated from a rate that is external to SynXis. | boolean |
calculateFromPackagePricing | Set this to true if the tax uses only the base price of the package and not previous taxes to calculate this tax. | boolean |
calculateFromRoomPricing | Set this to true if the tax uses only the base price (not the net room price) and not previous taxes to calculate this tax. | boolean |
eligibleDisclosureExclusion | If true, this allows hotels to distinguish which taxes and fees should be excluded from the total price on OTA and Metasearch site. | boolean |
hotelTierPointsInCalculation | If true, this calculates taxes for full cost of a reservation by using the cash equivalent of the points value plus the cash amount for a hotel tier redemption rate. | boolean |
payAtProperty | If true, the payment is to be "Paid at the hotel," and it should not be part of the Total that the customer can pay at the time of booking. | boolean |
redeemable | If true, this indicates that the tax or fee is charged in points instead of cash when a guest uses points to pay for a hotel product or package. | boolean |
ceilingAmount | If the tax or fee value causes the price to exceed this amount, this is the maximum price to charge. | integer |
AvailabilityInterval | The array to hold information about the availability interval of the tax. | array |
startDate | The first date when the tax can be used. | integer |
endDate | The last date when the tax can be used. | integer |
BaseTax | The array to hold the base tax information for this tax. | array |
code | The code that identifies the base tax for this tax. | string |
name | The full name of the base tax for this tax. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
Amount | The array to hold the amount information for this tax. | array |
amount | The amount of the tax. This is configured in the amountFactorType element and is usually a percentage. | integer |
amountFactorType | Set this to the name of the element in which you configure the tax amount factor type. | string |
ChargeType | The array to hold the charge type information for this tax. | array |
chargeType | Indicates how the tax is applied (charge per), such as Unknown, Flat, PerAdult, PerChild, PerPerson, PerGuestOffset. | string |
GuestOffsetList | The array to hold the guest offset list information for this tax. | array |
startAge | The starting age of the age group that receives the offset rate. | integer |
endAge | The ending age of the age group that receives the offset rate. | integer |
amount | The amount of offset that applies to those on this guest offset list. | integer |
type | Set this to the name of the element in which you configure the offset amount type. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
Inclusive | The array to hold the inclusive information for this tax. | array |
inclusive | If true, the tax or fee charge is included in the amount. If false, the tax or fee charge is not included in the amount and will be applied in addition to the hotel product or package value. When inclusive is true, ApplytoFreeNight must be false. | boolean |
type | The type for inclusive, such as CalculateAsExclusive or CalculateAsInclusive. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
PackageList | The array to hold the package list information for this tax. | array |
code | The code that identifies the package list. | string |
name | The full name of the package list. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
RateList | The array to hold the rate list information for this tax. | array |
code | The code that identifies the rate list. | string |
name | The full name of the rate list. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
RoomList | The array to hold the room list information for this tax. | array |
code | The code that identifies the room list. | string |
name | The full name of the room list. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
TaxByDailyPriceRange | The array to hold information about tax by daily price range for this tax. | array |
minimumPrice | If the tax is to be applied to rooms that fit a daily price range, set the minimum price of the range here. | integer |
maximumPrice | If the tax is to be applied to rooms that fit a daily price range, set the maximum price of the range here. | integer |
action | The type of action to take, such as add, edit, or unassign. | string |
TaxByLengthOfStay | The array to hold information about tax by length of stay range for this tax. | array |
min | If the tax is to be applied to rooms that fit a length of stay range, set the minimum length of stay here. | integer |
max | If the tax is to be applied to rooms that fit a length of stay range, set the maximum length of stay here. | integer |
action | The type of action to take, such as add, edit, or unassign. | string |
TranslationList | The array to hold information about the translation list for this tax. | array |
name | The full name of the translation list. | string |
description | The description of the translation list. | string |
Channel | The array to hold information about the translation list channel code for this tax. | array |
code | The translation list channel code for this tax. | string |
Language | The array to hold information about the translation list language code for this tax. | array |
code | The translation list language code for this tax. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
Post Body Example
The following is an example of the body for this post request:
{
"Criteria": {
"code": "CCITY10",
"level": "HotelTax",
"Hotel": {
"id": 13098
}
},
"CreateTaxHeader": {
"name": "City tax or fee 1-10 nights",
"description": "City tax or fee that applies to stays between 1 and 10 nights",
"level": "HotelTax",
"taxType": "BedTax",
"startDate": "2022-08-01",
"endDate": "2022-12-31",
"amount": 89.07,
"amountFactorType": "Amount",
"multiSeason": true
},
"Attributes": {
"applyToFreeNight": false,
"chargeFrequency": "PerNight",
"calculateFromExternalRate": false,
"calculateFromPackagePricing": false,
"calculateFromRoomPricing": false,
"eligibleDisclosureExclusion": false,
"hotelTierPointsInCalculation": false,
"payAtProperty": false,
"redeemable": false,
"ceilingAmount": 500.89
},
"AvailabilityInterval": {
"startDate": "2022-08-01",
"endDate": "2022-12-31"
},
"BaseTax": {
"code": "CITY10",
"name": "City tax or fee 1-10 nights",
"action": "AddEdit"
},
"Amount": {
"amount": 89.07,
"amountFactorType": "Amount"
},
"ChargeType": {
"chargeType": "Flat"
},
"GuestOffsetList": [
{
"startAge": "1",
"endAge": "9",
"amount": 89.07,
"type": "Amount",
"action": "AddEdit"
}
],
"Inclusive": {
"inclusive": true,
"type": "CalculateAsExclusive",
"action": "AddEdit"
},
"PackageList": [
{
"code": "string",
"name": "string",
"action": "AddEdit"
}
],
"RateList": [
{
"code": "StdRt1",
"name": "string",
"action": "AddEdit"
}
],
"RoomList": [
{
"code": "StdRm1",
"name": "string",
"action": "AddEdit"
}
],
"TaxByDailyPriceRange": {
"minimumPrice": 49.89,
"maximumPrice": 269.99,
"action": "AddEdit"
},
"TaxByLengthOfStay": {
"min": 1,
"max": 9,
"action": "AddEdit"
},
"TranslationList": [
{
"name": "Taxe de sejour",
"description": "Taxe de sejour",
"Channel": {
"code": "WEB"
},
"Language": {
"code": "fr-FR"
},
"action": "AddEdit"
}
]
}
Response in JSON
{
"success": true,
"timeStamp": "2022-12-1T18:25:43.511Z"
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
success | This element will be true or false to show whether or not your post was successful. | boolean |
timeStamp | The time stamp when your post succeeded or failed. | integer |
PATCH an existing tax
This endpoint enables you to make updates to an existing tax.
[PATCH] /v1/api/admin/tax
Patch Body Parameters
The following table describes the parameters to include in your patch request:
Element | Description | Type |
---|---|---|
Criteria | The array to hold criteria for the tax. | array |
code | The code that identifies the tax. | string |
level | Indicates what the tax is based on. | string |
Hotel | The array to hold the ID of the hotel for which you are creating this tax. | array |
id | The ID of the hotel for which you are creating this tax. | string |
CreateTaxHeader | The array to hold the header information for the tax that you are creating. | array |
name | The name for the tax that you are creating. | string |
description | A description for the tax that you are creating. | string |
level | Indicates what the tax is based on. | string |
taxType | The type for the tax that you are creating. | string |
startDate | The first date when the tax can be used. | integer |
endDate | The last date when the tax can be used. | integer |
amount | The amount of the tax. This is configured in the amountFactorType element and is usually a percentage. | integer |
amountFactorType | Set this to the name of the element in which you configure the tax amount factor type. | string |
multiSeason | Set this to true if you want the tax to be enabled for seasons. Set this to false if you do not want the tax to use seasons. | boolean |
Attributes | The array to hold the attributes of the tax you are creating. | array |
applyToFreeNight | If true, the system applies taxes or fees to Points Only Using Hotel Tier redemption rates. If false, the system does not apply taxes or fees to Points Only Using Hotel Tier redemption rates.
| boolean |
chargeFrequency | Indicates how the tax is calculated. Example: You might set this to PerNight if your tax will be calculated per night in a reservation. | string |
calculateFromExternalRate | Set this to true if the tax will be calculated from a rate that is external to SynXis. | boolean |
calculateFromPackagePricing | Set this to true if the tax uses only the base price of the package and not previous taxes to calculate this tax. | boolean |
calculateFromRoomPricing | Set this to true if the tax uses only the base price (not the net room price) and not previous taxes to calculate this tax. | boolean |
eligibleDisclosureExclusion | If true, this allows hotels to distinguish which taxes and fees should be excluded from the total price on OTA and Metasearch site. | boolean |
hotelTierPointsInCalculation | If true, this calculates taxes for full cost of a reservation by using the cash equivalent of the points value plus the cash amount for a hotel tier redemption rate. | boolean |
payAtProperty | If true, the payment is to be "Paid at the hotel," and it should not be part of the Total that the customer can pay at the time of booking. | boolean |
redeemable | If true, this indicates that the tax or fee is charged in points instead of cash when a guest uses points to pay for a hotel product or package. | boolean |
ceilingAmount | If the tax or fee value causes the price to exceed this amount, this is the maximum price to charge. | integer |
AvailabilityInterval | The array to hold information about the availability interval of the tax. | array |
startDate | The first date when the tax can be used. | integer |
endDate | The last date when the tax can be used. | integer |
BaseTax | The array to hold the base tax information for this tax. | array |
code | The code that identifies the base tax for this tax. | string |
name | The full name of the base tax for this tax. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
Amount | The array to hold the amount information for this tax. | array |
amount | The amount of the tax. This is configured in the amountFactorType element and is usually a percentage. | integer |
amountFactorType | Set this to the name of the element in which you configure the tax amount factor type. | string |
ChargeType | The array to hold the charge type information for this tax. | array |
chargeType | Indicates how the tax is applied (charge per), such as Unknown, Flat, PerAdult, PerChild, PerPerson, PerGuestOffset. | string |
GuestOffsetList | The array to hold the guest offset list information for this tax. | array |
startAge | The starting age of the age group that receives the offset rate. | integer |
endAge | The ending age of the age group that receives the offset rate. | integer |
amount | The amount of offset that applies to those on this guest offset list. | integer |
type | Set this to the name of the element in which you configure the offset amount type. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
Inclusive | The array to hold the inclusive information for this tax. | array |
inclusive | If true, the tax or fee charge is included in the amount. If false, the tax or fee charge is not included in the amount and will be applied in addition to the hotel product or package value. When inclusive is true, ApplytoFreeNight must be false. | boolean |
type | The type for inclusive, such as CalculateAsExclusive or CalculateAsInclusive. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
PackageList | The array to hold the package list information for this tax. | array |
code | The code that identifies the package list. | string |
name | The full name of the package list. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
RateList | The array to hold the rate list information for this tax. | array |
code | The code that identifies the rate list. | string |
name | The full name of the rate list. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
RoomList | The array to hold the room list information for this tax. | array |
code | The code that identifies the room list. | string |
name | The full name of the room list. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
TaxByDailyPriceRange | The array to hold information about tax by daily price range for this tax. | array |
minimumPrice | If the tax is to be applied to rooms that fit a daily price range, set the minimum price of the range here. | integer |
maximumPrice | If the tax is to be applied to rooms that fit a daily price range, set the maximum price of the range here. | integer |
action | The type of action to take, such as add, edit, or unassign. | string |
TaxByLengthOfStay | The array to hold information about tax by length of stay range for this tax. | array |
min | If the tax is to be applied to rooms that fit a length of stay range, set the minimum length of stay here. | integer |
max | If the tax is to be applied to rooms that fit a length of stay range, set the maximum length of stay here. | integer |
action | The type of action to take, such as add, edit, or unassign. | string |
TranslationList | The array to hold information about the translation list for this tax. | array |
name | The full name of the translation list. | string |
description | The description of the translation list. | string |
Channel | The array to hold information about the translation list channel code for this tax. | array |
code | The translation list channel code for this tax. | string |
Language | The array to hold information about the translation list language code for this tax. | array |
code | The translation list language code for this tax. | string |
action | The type of action to take, such as add, edit, or unassign. | string |
Patch Body Example
The following is an example of the body for this patch request:
{
"Criteria": {
"code": "CCITY10",
"level": "HotelTax",
"Hotel": {
"id": 13098
}
},
"UpdateTaxHeader": {
"code": "CITY10",
"name": "City tax or fee 1-10 nights",
"description": "City tax or fee that applies to stays between 1 and 10 nights",
"taxType": "BedTax",
"startDate": "2022-08-01",
"endDate": "2022-12-31"
},
"Attributes": {
"applyToFreeNight": false,
"chargeFrequency": "PerNight",
"calculateFromExternalRate": false,
"calculateFromPackagePricing": false,
"calculateFromRoomPricing": false,
"eligibleDisclosureExclusion": false,
"hotelTierPointsInCalculation": false,
"payAtProperty": false,
"redeemable": false,
"ceilingAmount": 500.89
},
"AvailabilityInterval": {
"startDate": "2022-08-01",
"endDate": "2022-12-31"
},
"BaseTax": {
"code": "CITY10",
"name": "City tax or fee 1-10 nights",
"action": "AddEdit"
},
"Amount": {
"amount": 89.07,
"amountFactorType": "Amount"
},
"ChargeType": {
"chargeType": "Flat"
},
"GuestOffsetList": [
{
"startAge": "1",
"endAge": "9",
"amount": 89.07,
"type": "Amount",
"action": "AddEdit"
}
],
"Inclusive": {
"inclusive": true,
"type": "CalculateAsExclusive",
"action": "AddEdit"
},
"PackageList": [
{
"code": "string",
"name": "string",
"action": "AddEdit"
}
],
"RateList": [
{
"code": "StdRt1",
"name": "string",
"action": "AddEdit"
}
],
"RoomList": [
{
"code": "StdRm1",
"name": "string",
"action": "AddEdit"
}
],
"TaxByDailyPriceRange": {
"minimumPrice": 49.89,
"maximumPrice": 269.99,
"action": "AddEdit"
},
"TaxByLengthOfStayModel": {
"min": 1,
"max": 9,
"action": "AddEdit"
},
"TranslationList": [
{
"name": "Taxe de sejour",
"description": "Taxe de sejour",
"Channel": {
"code": "WEB"
},
"Language": {
"code": "fr-FR"
},
"action": "AddEdit"
}
],
"SortOrder": {
"value": 0
}
}
Response in JSON
{
"success": true,
"timeStamp": "2022-12-1T18:25:43.511Z"
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
success | This element will be true or false to show whether or not your patch was successful. | boolean |
timeStamp | The time stamp when your patch succeeded or failed. | integer |
DELETE a tax
This endpoint enables you to delete a tax or a fee.
[DELETE] /v1/api/admin/tax/cancel
Delete Body Parameters
The following table describes the parameters to include in your delete request:
Element | Description | Type |
---|---|---|
Criteria | The array to hold criteria for the tax. | array |
code | The code that identifies the tax. | string |
level | Indicates what the tax is based on. | string |
Hotel | The array to hold the ID of the hotel from which you are deleting this tax. | array |
id | The ID of the hotel from which you are deleting this tax. | string |
Delete Body Example
The following is an example of the body for this patch request:
{
"Criteria": {
"code": "CCITY10",
"level": "HotelTax",
"Hotel": {
"id": 13098
}
}
}
Response in JSON
{
"success": true,
"timeStamp": "2022-12-1T18:25:43.511Z"
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
success | This element will be true or false to show whether or not your delete was successful. | boolean |
timeStamp | The time stamp when your delete succeeded or failed. | integer |
GET seasonal data for a hotel
This endpoint enables you to retrieve seasonal data for all seasons and all taxes for a hotel that you specify.
[GET] /v1/api/admin/hotel/{hotelID}/tax/seasons
Path Parameters
The following table describes the path parameters that you must include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
hotelID | The ID of the hotel for which you want to get seasonal tax information. | integer | Yes |
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
taxCode | The code that identifies a tax for which you want to view seasonal tax information. | string | No |
startDate | The start date of the data that you want to view. | integer | No |
endDate | The end date of the data that you want to view. | integer | No |
Response in JSON
{
"TaxDetails": [
{
"Code": "TaxCode",
"Level": "RoomTax",
"Name": "Tax Name",
"TaxSeasonList": [
{
"SeasonName": "tax season name",
"SeasonDescription": "Tax season description",
"Amount": 10.21,
"AmountFactorType": "Amount",
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"TaxType": "Unknown",
"CeilingAmount": 500.89,
"MinLengthOfStay": 0,
"MaxLengthOfStay": 5,
"MaximumDailyPrice": 500.89,
"MinimumDailyPrice": 120
}
]
}
],
"Pagination": {
"size": 50,
"start": 0,
"total": 146
}
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
TaxDetails | The array to hold details for the tax and its seasonal data. | array |
Code | The code that identifies the tax. | string |
Level | The level on which the tax is based. | string |
Name | The full name of the tax. | string |
TaxSeasonList | The array to hold the list of tax seasons for the tax. | array |
SeasonName | The name of the season that you are viewing. | string |
SeasonDescription | The description of the season that you are viewing. | string |
Amount | The amount of this seasonal tax. | string |
AmountFactorType | The name of the element in which the tax amount factor type is defined. | string |
startDate | The first date when the seasonal tax can be used. | integer |
endDate | The last date when the seasonal tax can be used. | integer |
TaxType | The type for the seasonal tax that you are viewing. | string |
CeilingAmount | If the tax or fee value causes the price to exceed this amount, this is the maximum price to charge. | integer |
MinLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the minimum length of stay. | integer |
MaxLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the maximum length of stay. | integer |
MaximumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the maximum price of the range. | integer |
MinimumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the minimum price of the range. | integer |
GET seasonal data for a specified tax and hotel
This endpoint enables you to retrieve seasonal data for all seasons of a tax that you specify and a hotel that you specify.
[GET] /v1/api/admin/hotel/{hotelID}/taxes/{taxCode}/seasons
Path Parameters
The following table describes the path parameters that you must include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
hotelID | The ID of the hotel for which you want to get seasonal tax information. | integer | Yes |
taxCode | The tax code of the tax for which you want to get seasonal tax information. | integer | Yes |
Query Parameters
The following table describes the elements that you can include when you query this endpoint:
Element | Description | Type | Required? |
---|---|---|---|
taxCode | The code that identifies a tax for which you want to view seasonal tax information. | string | No |
taxLevel | The level of the tax for which you want to view seasonal tax information. | string | No |
startDate | The start date of the data that you want to view. | integer | No |
endDate | The end date of the data that you want to view. | integer | No |
Response in JSON
{
"TaxDetails": [
{
"Code": "TaxCode",
"Level": "RoomTax",
"Name": "Tax Name",
"TaxSeasonList": [
{
"SeasonName": "tax season name",
"SeasonDescription": "Tax season description",
"Amount": 10.21,
"AmountFactorType": "Amount",
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"TaxType": "Unknown",
"CeilingAmount": 500.89,
"MinLengthOfStay": 0,
"MaxLengthOfStay": 5,
"MaximumDailyPrice": 500.89,
"MinimumDailyPrice": 120
}
]
}
],
"Pagination": {
"size": 50,
"start": 0,
"total": 146
}
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
TaxDetails | The array to hold details for the tax and its seasonal data. | array |
Code | The code that identifies the tax. | string |
Level | The level on which the tax is based. | string |
Name | The full name of the tax. | string |
TaxSeasonList | The array to hold the list of tax seasons for the tax. | array |
SeasonName | The name of the season that you are viewing. | string |
SeasonDescription | The description of the season that you are viewing. | string |
Amount | The amount of this seasonal tax. | string |
AmountFactorType | The name of the element in which the tax amount factor type is defined. | string |
startDate | The first date when the seasonal tax can be used. | integer |
endDate | The last date when the seasonal tax can be used. | integer |
TaxType | The type for the seasonal tax that you are viewing. | string |
CeilingAmount | If the tax or fee value causes the price to exceed this amount, this is the maximum price to charge. | integer |
MinLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the minimum length of stay. | integer |
MaxLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the maximum length of stay. | integer |
MaximumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the maximum price of the range. | integer |
MinimumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the minimum price of the range. | integer |
POST seasons for a specified tax
This endpoint enables you to create seasons for a tax that you specify.
[POST] /v1/api/admin/tax/{code}/seasons
Post Body Parameters
The following table describes the parameters to include in your post request:
Element | Description | Type |
---|---|---|
Criteria | The array to hold details for the tax and its seasonal data. | array |
TaxLevel | The level of the tax. | string |
Hotel | The array to hold hotel details. | array |
id | The ID of the hotel for which you are creating a seasonal tax. | string |
SeasonTaxList | The array to hold the list of tax seasons for the tax. | array |
SeasonName | The name of the season that you are creating. | string |
SeasonDescription | The description of the season that you are creating. | string |
Amount | The amount of this seasonal tax. | string |
AmountFactorType | The name of the element in which the tax amount factor type is defined. | string |
startDate | The first date when the seasonal tax can be used. | integer |
endDate | The last date when the seasonal tax can be used. | integer |
TaxType | The type for the seasonal tax that you are creating. | string |
CeilingAmount | If the tax or fee value causes the price to exceed this amount, this is the maximum price to charge. | integer |
MinLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the minimum length of stay. | integer |
MaxLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the maximum length of stay. | integer |
MaximumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the maximum price of the range. | integer |
MinimumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the minimum price of the range. | integer |
Post Body Example
The following is an example of the body for this post request:
{
"Criteria": {
"TaxLevel": "HotelTax",
"Hotel": {
"id": 13098
}
},
"SeasonTaxList": [
{
"SeasonName": "tax season name",
"SeasonDescription": "Tax season description",
"Amount": 10.21,
"AmountFactorType": "Amount",
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"TaxType": "Unknown",
"CeilingAmount": 500.89,
"MinLengthOfStay": 0,
"MaxLengthOfStay": 5,
"MaximumDailyPrice": 500.89,
"MinimumDailyPrice": 120
}
]
}
Response in JSON
{
"success": true,
"timeStamp": "2022-12-1T18:25:43.511Z"
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
success | This element will be true or false to show whether or not your post was successful. | boolean |
timeStamp | The time stamp when your post succeeded or failed. | integer |
PATCH seasons for a specified tax
This endpoint enables you to make updates to seasons for a tax that you specify.
[PATCH] /v1/api/admin/tax/{code}/seasons
Patch Body Parameters
The following table describes the parameters to include in your patch request:
Element | Description | Type |
---|---|---|
Criteria | The array to hold details for the tax and its seasonal data. | array |
TaxLevel | The level of the tax. | string |
Hotel | The array to hold hotel details. | array |
id | The ID of the hotel for which you are creating a seasonal tax. | string |
SeasonTaxList | The array to hold the list of tax seasons for the tax. | array |
SeasonName | The name of the season that you are creating. | string |
SeasonDescription | The description of the season that you are creating. | string |
Amount | The amount of this seasonal tax. | string |
AmountFactorType | The name of the element in which the tax amount factor type is defined. | string |
startDate | The first date when the seasonal tax can be used. | integer |
endDate | The last date when the seasonal tax can be used. | integer |
TaxType | The type for the seasonal tax that you are creating. | string |
CeilingAmount | If the tax or fee value causes the price to exceed this amount, this is the maximum price to charge. | integer |
MinLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the minimum length of stay. | integer |
MaxLengthOfStay | When the seasonal tax is applied to rooms that fit a length of stay range, this is the maximum length of stay. | integer |
MaximumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the maximum price of the range. | integer |
MinimumDailyPrice | When the seasonal tax is applied to rooms that fit a daily price range, this is the minimum price of the range. | integer |
Patch Body Example
The following is an example of the body for this patch request:
{
"Criteria": {
"TaxLevel": "HotelTax",
"Hotel": {
"id": 13098
}
},
"SeasonTaxList": [
{
"SeasonName": "tax season name",
"SeasonDescription": "Tax season description",
"Amount": 10.21,
"AmountFactorType": "Amount",
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"TaxType": "Unknown",
"CeilingAmount": 500.89,
"MinLengthOfStay": 0,
"MaxLengthOfStay": 5,
"MaximumDailyPrice": 500.89,
"MinimumDailyPrice": 120
}
]
}
Response in JSON
{
"success": true,
"timeStamp": "2025-12-1T18:25:43.511Z"
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
success | This element will be true or false to show whether or not your patch was successful. | boolean |
timeStamp | The time stamp when your patch succeeded or failed. | integer |
DELETE seasons for a specified tax
This endpoint enables you to delete seasons for a tax that you specify.
[DELETE] /v1/api/admin/tax/{taxCode}/season/cancel
Delete Body Parameters
The following table describes the parameters to include in your delete request:
Element | Description | Type |
---|---|---|
Criteria | The array to hold criteria for the tax season. | array |
TaxLevel | The level of the tax for which you want to delete seasonal tax information. | string |
Hotel | The array to hold the ID of the hotel from which you are deleting this tax season. | array |
id | The ID of the hotel from which you are deleting this tax season. | string |
DeleteTaxSeasonDate | The array to hold the start and end dates of the tax season that you want to delete. | array |
startDate | The start date of the data that you want to delete. | integer |
endDate | The end date of the data that you want to delete. | integer |
Delete Body Example
The following is an example of the body for this patch request:
{
"Criteria": {
"TaxLevel": "HotelTax",
"Hotel": {
"id": 13098
}
},
"DeleteTaxSeasonDate": {
"startDate": "2025-08-01",
"endDate": "2025-12-31"
}
}
Response in JSON
{
"success": true,
"timeStamp": "2025-12-1T18:25:43.511Z"
}
Response Elements
The following table explains the elements you receive in the response:
Element | Description | Type |
---|---|---|
success | This element will be true or false to show whether or not your delete was successful. | boolean |
timeStamp | The time stamp when your delete succeeded or failed. | integer |