Aggregate Tax

This node provides a break-up of the tax amount. It is returned as part of Search, Quote, and Book responses. You must include this field in your queries only if you plan to display the tax break-up in your application. If you only need the tax amount, you can use the tax field instead.

The aggregateTaxInfo node will contain only the total tax to be charged (for both payAtProperty and payAtBooking) for each tax but only for the stay. This node is replacing the deprecated taxInfo node.

Below is an example of the aggregateTaxInfo node:

"aggregateTaxInfo": {
    "payAtBooking": [
        {
            "name": "NY Occupancy Tax",
            "description": "New York Occupancy Tax",
            "currency": "USD",
            "value": 8.0
        },
        {
            "name": "Javits Tax",
            "description": "",
            "currency": "USD",
            "value": 6.0
        },
        {
            "name": "New York State Sales Tax",
            "description": "New York State Sales Tax",
            "currency": "USD",
            "value": 90.68
        },
        {
            "name": "New York City Sales Tax",
            "description": "New York City Sales Tax",
            "currency": "USD",
            "value": 137
        }
    ],
    "payAtProperty": [
        {
            "name": "Facilities Fee",
            "description": "Facility Fee: $17.21 per room, per night which provides guests with the following services, amenities and added value offerings:",
            "currency": "USD",
            "value": 68.84
        }
    ]
}

As you can see above, this node provides a break-up of taxes payable at the time of booking as well as those that the guest must pay at the property. Should you choose to display this information in your UI, we recommend that you use the aggreateTaxInfo node.

This node is available in the Search, Quote, and Book messages.