HE - GetRevenue - Details

Summary The Revenue API allows you to pull actual and forecasted revenue data directly from Hotel Effectiveness. This helps you seamlessly sync your property's performance data into custom reports or external systems.

Things to Consider

• You must make the call using your generated token as the Authorization header (e.g., Authorization: Bearer <insert-token-here>).

• Times returned are in military format and Eastern Time.

• hotelID and variableID are unique identifiers that cannot be modified.

Required Parameters To successfully call the Revenue API, you must include the following:

1. hotelID: The Hotel Effectiveness ID associated with the property.

2. startDate: The beginning of the date range (Format: yyyy-mm-dd).

3. endDate: The end of the date range (Format: yyyy-mm-dd).

Optional Parameters

• dataType: Choose between actual, forecast, or both.

• Note: If left blank, the system defaults to downloading actual data.

The Successful Response When your call is successful, the data returns with the following fields:

• Date: The date of the returned data.

• dataType: Displays as Actual or Forecast.

• hotelID: The unique location identifier.

• hotelName: The property name (You can request a change to this).

• variableType: Displays as Business Driver or Business Driver Group.

• variableID: The unique ID of the driver or group.

• variableName: The name of the driver or group (You can change this in Settings).

• Value: The saved value for the item.

• lastDateModified: The timestamp of the last modification.

💡 Pro-Tip: Business Drivers (like Breakfast Covers) are the smallest detail level, coming from the property or PMS. If you need aggregated data for Labor Plans, you can create Business Driver Groups, which the system calculates automatically.

Possible Errors If something goes wrong, you will see one of these errors:

• HTTP 400 (Bad Request):

  • Start Date must be less than or equal to End Date: The 'from date' is after the 'to date'.

  • Invalid Date Format: Date is blank or not in yyyy-mm-dd format.

  • Invalid Data Type: Input doesn't match actual, forecast, both, or blank.

• HTTP 401 (Unauthorized):

  • Invalid Token: Token failed validation, is over 1 hour old, or belongs to an inactive user.

• HTTP 403 (Forbidden):

  • Hotel not Assigned: Hotel ID is valid but not in your assigned list.

  • Hotel not Subscribed: The hotel lacks an active API subscription.

  • Hotel not Active: The requested hotel is inactive.

  • Account not Active: The hotel's parent account is inactive.

• HTTP 500 (Internal Server Error):

  • Internal Server Error: The response couldn't load. Try downloading only forecast/actual data or reducing the date range.