Tax Audit API

The Tax Metadata Audit API ensures that the tax metadata pushed by Hotel Trader is accurately stored on the client system. This API validates all tax details for a specific property to maintain data consistency and alignment with the metadata sent in the Tax Metadata Push API

The audit can be for a single tax or all taxes of the property. Appropriate alert messages will be sent out after the audit to Partner systems.

Initiator - Hotel Trader

Endpoint

[POST] https://<client-base-url>/tax-audit

Request

HTTP Headers

All HTTP headers are mandatory and apply consistently across both endpoints of the API.

Clients must provide their username and password to Hotel Trader. For more information on username and password encoding, please refer to the Authentication page in our Knowledge Base.


Header NameType
Content-Typeapplication/json
Accept-Encodinggzip
AuthorizationBasic <token>

Request Description

All the fields in the request are described below.

Field/Object Datatype Required Description
messageId String Yes A string that uniquely identifies this particular message. This should be returned in the response.
propertyCodeStringYesThe unique property code of the hotel for which rateplan metadata is requested.
taxCodesArrayNoIf present, return only the taxes with these codes.

Example

{
    "messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
    "propertyCode": "NYCMIL",
    "taxCodes": null
}

Response

Success

Object Description

Field/ObjectDatatypeRequiredDescription
messageIdStringYesThe same messageId string that is sent in the request.
status
ObjectYesThe standard status object that describes the success/error status and the error message, if any.
propertyCodeStringYesThe property code that is sent in the request.
taxesArrayYesAn array of tax objects, which contain the rateplan metadata.

Example

{
    "messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
    "status": {
        "success": true
    },
    "taxes": [
        {
            "code": "FACFEE",
            "name": "Facilities Fee",
            "percentOrFlat": "FLAT",
            "chargeFrequency": "DAY",
            "chargeBasis": "ROOM",
            "value": 27.22,
            "taxType": "FEE",
            "appliesToChildren": false,
            "payAtProperty": true
        },
        {
            "code": "STATE",
            "name": "New York State Sales Tax",
            "percentOrFlat": "PERCENT",
            "chargeFrequency": "STAY",
            "chargeBasis": "ROOM",
            "value": 8.875,
            "appliesToChildren": false,
            "payAtProperty": false,
            "taxType": "TAX"
        },
        {
            "code": "CITTAX",
            "name": "NY City Sales Tax",
            "percentOrFlat": "PERCENT",
            "chargeFrequency": "STAY",
            "chargeBasis": "ROOM",
            "value": 5.875,
            "appliesToChildren": false,
            "taxType": "FEE",
            "payAtProperty": false
        }
    ]
}

Error

This API follows the Standard Response model of the Metadata Push API.