File-based delivery for Loyalty Earn
The standard earn report, also known as an accrual file, provides basic booking information along with the loyalty rewards earned. Using the standard reports in the Partner Portal means that you can get your data quickly, without additional development time.
The earn report includes a curated list of more than 30 fields to choose from, including:
- Basic booking information such as dates, itineraries, and trip amounts
- Loyalty member information
- Rewards information like earn date and program details
When you download your file via the Portal, you can configure the file name however you like. We recommend that you include the date of generation and type of report in the file name, for easy reference.
Learn more about file delivery setup
Best practices for file ingestion
Standard report default fields
There are many fields to choose from when customizing your reports. These are included by default in standard reports.
| Field name | Description | Example |
|---|---|---|
ITINERARY_NUMBER | The itinerary number or point of sale order reference number. | 12345678910111 |
TRANSACTION_TYPE | The type of transaction recorded. | Possible values: purchase, award, modification, or cancel. |
book_date | The date a booking was initially made, represented in ISO 8601 date format (YYYY-MM-DD). | 2023-02-05 |
TRANSACTION_DATE | The date a booking was last modified. This is the same as book_date if the booking is never updated. Represented in ISO 8601 date format (YYYY-MM-DD). | 2023-02-05 |
earn_date | The date the traveler earned the loyalty currency being used. | 2023-01-14 |
point_definition | Indicator of a campaign or promotion that changes your program’s base earning model. | base |
pending_points | Number of points earned but not yet awarded. | Broken down as: • total: –100.11 • base: –90.01 • bonus: –10.1 |
award_points | Number of points awarded for the transaction. | Broken down as: • total: –100.11 • base: –90.01 • bonus: –10.1 |
loyalty_id | Unique identifier of the member record. | 12345678 |
product_line_name | The type of business the booking item falls under. | Possible values: Air, Car, Cruise, Destination services, Insurance, Lodging, Package, or unknown. |
currency_code | Currency in which the booking was paid, represented in standard International Bank Account Number (IBAN) currency code format. | USD |
gbv_local | The gross booking value (GBV), or total booking amount including taxes and fees, in the currency used to pay. | 694.89 |
Additional optional fields
Note: This is not the order in which the fields will be displayed in the report. The order of the fields is determined by the order in which the fields are enabled during create/edit.
| Field Name | Description | Example |
|---|---|---|
trans_datetm | The date/time that the booking was last updated, is the same as the book date if booking is never changed. Date of business transaction event .When transaction type = purchase, this is the same as booking date but if transaction type = modification or cancellation then this is the date the modification or cancellation event occurred; If transaction type = award then this is the same as the earn date which is the date that the pending points are cleared and the awarded points are reported. | 2023-02-05 02:58:00.0 |
BEGIN_USE_DATE | Date travel begins (departure date, check-in date, pick-up date, etc). | 2023-03-09 |
END_USE_DATE | Date travel ends (arrival date, check-out date, drop-off date, etc). | 2023-03-14 |
PACKAGE_INDICATOR | Whether or not the booking is a package. | Possible values: standalone or part of a package. |
product_component | If a package, parts of the package otherwise lodging, air, car depending on the product line name. | Air |
refundable_rate_ind | Indicator of whether or not the rate is refundable. | 0 |
gbv_usd | Gross booking value of booking in US Dollars. | 694.8941 |
base_price_local | Base price (what points are based off of) in local currency. | 591.28549 |
base_price_usd | Base price (what points are based off of) in US Dollars. | 591.2857 |
loyalty_program_name | Name of loyalty program. | Rewards |
loyalty_tier | Tier of program member is in (can be used to help determine bonus points for example). | Standard |
pending_base_points | Points pending where point code / definition refers to base points. | -931.0000 |
pending_bonus_points | Points pending where point code / definition refers to bonus points. | 0.0000 |
award_base_points | Points awarded where point code / definition refers to base points. | 931.0000 |
award_bonus_points | Points awarded where point code / definition refers to bonus points. | 0.0000 |
member_first_name | First name of loyalty member. | James |
member_last_name | Last name of loyalty member. | Smith |
member_email_address | Email address of loyalty member. | James.smith@email.com |
member_enroll_date | Date member enrolled in the program. | 2019-02-05 |