Documentation

Tax Breakdown

For clients interested in receiving information related to taxes and fees included and / or excluded from the price recieved, the option of activating the tax breakdown feature exists. By default this feature is disabled, so you will need to contact your HBX Technical Account Manager or apitude@hotelbeds.com that will guide you on which of the possible tax breakdown display combinations are suitable for you.



Please note that the tax breakdown feature activation will modify the API responses accordingly.

INCLUDED TAXES

The API will return all taxes and fees concepts included in the price, summed and grouped under the Taxes / Type : "TAXESANDFEES". Bear in mind that these taxes and fees are already included in the rate prices APItude returns, the aim of this is just informative, so you must not add them to the final price.



For the included taxes option the "included" field value will be true.

"taxes": {
                                    "taxes": [
                                        {
                                            "included": true,
                                            "amount": "108.42",
                                            "currency": "EUR",
                                            "type": "TAXESANDFEES"
                                        }
                                    ],
                                    "allIncluded": true
                                }
<taxes allIncluded="true"> <tax included="true" amount="108.42" currency="EUR" type="TAXESANDFEES"/> </taxes>


NOT INCLUDED TAXES

The API will return all taxes and fees concepts not included in the price, usually to be paid by the end customer directly at the hotel.

There are two ways of receiving the not included taxes and fees concepts:

Grouped: The API will return one amount that will sum all concepts not included in the price.

Concept Breakdown: The API will return two additional fields, type and subtype that will give extra visibility on what the end customer will need to pay by each concept.


The possible values for the field "type" are: "TAX" or "FEE"

The possible values for the field "subtype" are:

"City Tax"

"Fees"

"Convenience Fee"

"Amenity Fee"

"Boutique Fee"

"Connection Fee"

"Facility Fee"

"Activity Fee"

"Service Charge"

"Hospitality Fee"

"Energy surcharge"

"Cleaning Fee"

"Transportation Fee"

"Ecologic Fee"

"Tips"

"Mountain Rescue Fee"

"Resort Fee"

"City Tax 3"

"Taxes"

"Service Fee"

"State tax"

"Service Fee I"

"City Tax 1"

"County Tax 1"

"County Tax 2"

"City Tax 2"

"Taxes"

"VAT"

For the not included taxes option the "included" field value will be false.

"taxes": {
                                    "taxes": [
                                        {
                                            "included": false,
                                            "amount": "181.07",
                                            "currency": "USD",
                                            "type": "FEE",
                                            "subType": "Resort Fee",
                                            "clientAmount": "169.05",
                                            "clientCurrency": "EUR"
                                        }
                                    ],
                                    "allIncluded": false
                                }
<taxes allIncluded="false"> <tax included="false" amount="181.07" currency="USD" type="FEE" subType="Resort Fee" clientAmount="169.05" clientCurrency="EUR"/> </taxes>

INCLUDED AND NOT INCLUDED TAXES

With this option, both the included and not included taxes and fees concepts will be returned in the API responses.

Bear in mind that in the cases of Not Included Taxes, still you can activate them to be returned Grouped or using the Concept Breakdown as previously explained.


"taxes": {
                                    "taxes": [
                                        {
                                            "included": false,
                                            "amount": "181.07",
                                            "currency": "USD",
                                            "type": "FEE",
                                            "subType": "Resort Fee",
                                            "clientAmount": "169.05",
                                            "clientCurrency": "EUR"
                                        },
                                        {
                                            "included": true,
                                            "amount": "108.42",
                                            "currency": "EUR",
                                            "type": "TAXESANDFEES"
                                        }
                                    ],
                                    "allIncluded": false
                                }
<taxes allIncluded="false"> <tax included="false" amount="181.07" currency="USD" type="FEE" subType="Resort Fee" clientAmount="169.05" clientCurrency="EUR"/> <tax included="true" amount="108.42" currency="EUR" type="TAXESANDFEES"/> </taxes>

This structure is applied inside the rate node that can be find in the different responses of APItude, such as Availability, CheckRates or Booking.