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 the HTTP Headers are mandatory. These headers are applicable and remain the same for both end-points of the {}.
| Header Name | Type |
|---|---|
| Content-Type | application/json |
| Accept-Encoding | gzip |
| Authorization | Basic <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. |
| propertyCode | String | Yes | The unique property code of the hotel for which rateplan metadata is requested. |
| taxCodes | Array | No | If present, return only the taxes with these codes. |
Example
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
"taxCodes": null
}
Response
Success
Response Object Description
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | The same messageId string which is sent in the request. |
| status | Object | Yes | The standard status object that describes the success/error status, and the error message, if any. |
| propertyCode | String | Yes | The property code that is sent in the request. |
| taxes | Array | Yes | An 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.