|
|
|
HCC Export File Data Definition
The HCC data export file consists of 5 record types as described below. Each field within the records is separated by the pipe symbol. Although a field is mandated by a certain number of characters, the exact length of the data can be less than the column, but not more. In all cases the termination of the field will again be with existence of the pipe symbol (|). For a numeric value, it is not necessary to pad either left or right with zeros. Decimal placement is based on the property data. If no taxes are reported on the RC Report Commission, a TX Tax Record will not be created.
Note: Tables/Views along with the respective Column Names are highlighted in red. All amounts are shown in the bank currency.
Each file export conducted will always have a Batch Header record sent. This record must be the first record in the file. The format of the record is as follows.
HCC Field Name |
Length |
Description and Table/View Column |
Record ID |
2 Char |
BH |
Property ID |
10 Char |
Property ID ASCII FFORMAT.HOTEL ID |
Destination ID |
3 Char |
Brand/Destination ID ASCII FFORMAT.CORPORATE ID |
Batch ID |
16 Char |
Unique batch identification number (revolving 3 digit number. ASCII FFORMAT.HOTEL ID + last 3 digits from ASCII FFORMAT.EXPORT FILE + increment by 1 |
Batch Creation Date |
8 Char |
YYYYMMDD format SYSTEM DATE |
File Creation Time |
4 Char |
HHMM format (military time) SYSTEM TIME |
Batch Description |
24 Char |
HCC Batch: BOSSO102.hlk (5 digit property code + 3 digit revolving batch number. Batch ID will be taken plus the .HLK as the file extension. |
This should always be the second record in the file after the BH.
HCC Field Name |
Length |
Description |
Record ID |
2 Char |
PM |
Brand Code |
2 Char |
Brand/Destination ID ASCII FFORMAT.CORPORATE ID |
Chain Property ID |
10 Char |
Property ID ASCII FFORMAT.HOTEL ID |
Action Code |
1 Char |
A |
Property Name |
30 Char |
Name of the Property as shown in Property Data ASCII FFORMAT.CHAIN NAME |
Address Line 1 |
25 Char |
Properties Street Address RESORT.STREET |
Address Line 2 |
25 Char |
Blank |
City |
15 Char |
Properties City Address RESORT.CITY |
State/Province Code |
3 Char |
Properties State Address RESORT.CITY |
Country Code |
2 Char |
Properties Country Address RESORT.COUNTRY CODE |
Postal Code |
15 Char |
Properties Postal/Zip Code RESORT.POST CODE |
Phone Number |
20 Char |
Properties Telephone Number RESORT.TELEPHONE |
Property ID - Sabre |
10 Char |
Blank |
Property ID Covia |
10 Char |
Blank |
Property ID System One |
10 Char |
Blank |
Property ID Pars |
10 Char |
Blank |
Property ID Datas II |
10 Char |
Blank |
Property ID JAL |
10 Char |
Blank |
Property ID Sita/Sahara |
10 Char |
Blank |
Property ID Abacus |
10 Char |
Blank |
Property ID Gemini |
10 Char |
Blank |
Property ID Galileo |
10 Char |
Blank |
Property ID AAA |
10 Char |
Blank |
Reported commission records account for reservation stays, cancellations and no-shows. Within this format Gross is referenced as Net, and Net is referenced as Gross. For each commissionable guest, one RC record will be created.
HCC Field Name |
Length |
Description |
Record ID |
2 Char |
RC |
Action Code |
1 Char |
A |
Guest Stay Number |
12 Char |
Unique identifier for guest stay (reported commission) number. ASCII FFORMAT.HOTEL ID & TA GUEST COMMISSIONS.RESV NAME ID (5 digits property ID + last 7 digits of reservation name ID |
Brand Code |
2 Char |
Brand/Destination ID ASCII FFORMAT.CORPORATE ID |
Booking Source Code |
3 Char |
OTH |
Property ID |
10 Char |
Property ID ASCII FFORMAT.HOTEL ID |
PNR Number |
6 Char |
Blank |
Confirmation Number |
12 Char |
Confirmation Number TA GUEST COMMISSIONS.RESV NAME ID |
Cancellation Number |
12 Char |
If reservation is of a canceled status CXL; otherwise Blank. |
Corporate ID Number |
12 Char |
If company profile attached uses the CORPID/Member number. If no CORPID exists, use company name ID. If no company is attached, then Blank. RESERVATION GENERAL VIEW.COMPANY ID |
Travel Agency Number |
8 Char |
IATA number. If Blank, then use internal number PROFILE 1W.IATA CORP NO; if Blank then NAME.NAME ID |
Guest Last Name |
30 Char |
Guest Last Name NAME.LAST/COMPANY |
Guest First name |
20 Char |
Guest First Name NAME.FIRST |
Status Code |
2 Char |
1 = Fully commissionable 4 = Cancellation, 5 = No show, RESERVATION GENERAL VIEW.COMPANY ID |
Reason Code |
6 Char |
Blank |
Arrival Date |
8 Char |
YYYYMMDD format TA GUEST COMMISSIONS.ARRIVAL |
Departure Date |
8 Char |
YYYYMMDD format TA GUEST COMMISSIONS.DEPARTURE |
Number of Nights |
3 Digits |
Nights RESERVATION GENERAL VIEW.NIGHTS |
Number of Rooms |
3 Digits |
1 |
Commissionable Revenue |
15 Digits |
Revenue that is commissionable TA GUEST COMMISSIONS.COMMISSION REVENUE |
Gross Commission Due |
15 Digits |
Net commission (Gross Commission - Tax Amount) TA GUEST COMMISSIONS.GROSS COMM AMT |
Adjustment Amount |
15 Digits |
0.00 |
Net Commission Due |
15 Digits |
Gross Commission (Net Commission + Tax Amount) TA GUEST COMMISSIONS.COMMISSION AMOUNT |
Currency Code |
3 Char |
Currency Code of Bank Account. PMS P CURRENCY |
Comments |
250 Char |
Blank |
Number of Tax Records |
3 Digits |
1 or 0 based on where tax has been calculated References parameter CALC VAT ON COMMISSIONS |
Tax Amount |
15 Digits |
The calculated tax amount TA GUEST COMMISSIONS.VAT AMOUNT |
Agency Name |
30 Char |
Travel agent name attached to the reservation PROFILE 1W.NAME |
Agency Address 1 |
25 Char |
Travel agent address 1 attached to the reservation PROFILE 1W.ADDRESS1 |
Agency Address 2 |
25 Char |
Travel agent address 2 attached to the reservation PROFILE 1W.ADDRESS2 |
Agency City |
15 Char |
Travel agent city attached to the reservation PROFILE 1W.CITY |
Agency State/Province |
3 Char |
Required if country code = US or CA PROFILE 1W.STATE |
Agency Country Code |
2 Char |
Travel agent country code PROFILE 1W.COUNTRY DESC |
Agency Postal Code |
15 Char |
Travel agent postal code PROFILE 1W.ZIP CODE |
Agency Phone Number |
20 Char |
Travel agent telephone number PROFILE 1W.PHONE NO |
There is one tax record for each reported commission record. This record type must immediately follow the associated RC record. Tax Record is mandatory for each commission record. This record is only required for properties sending tax information; which will be based on where the parameter called CALC VAT ON COMMISSION is active. If there is not a tax amount in the RC record, a TX record is not required.
HCC Field Name |
Length |
Description |
Record ID |
2 Char |
TX |
Brand Code |
2 Char |
Brand/Destination ID ASCII FFORMAT.CORPORATE ID |
Guest Stay Number |
12 Char |
Reservation Confirmation Number (resv name id). Same as reported in the RC record. |
Taxing Authority Code |
3 Char |
Country of Tax Authority ASCII FFORMAT.CNTRY TAXING AUTHORITY |
Tax Type |
8 Char |
Tax Code ASCII FFORMAT.TAX TYPE |
Reporting Cycle |
1 Char |
Blank |
Gross Commission Amount |
15 Digits |
Net Commission (Gross Commission Tax Amount) TA GUEST COMMISSIONS.GROSS COMM AMT |
Tax Amount |
15 Digits |
Tax calculated on Net Commission TA GUEST COMMISSIONS.VAT AMOUNT |
Commission Amount |
15 Digits |
Gross Commission (Net Commission + Tax AMOUNT) TA GUEST COMMISSIONS COMMISSION AMT |
Tax Percentage Used |
6 Digits |
Right four digits considered decimal positions. 10% would appear in this field as 100000. RESORT COMMISSION.VAT AMOUNT |
Travel Agent Tax ID |
15 Digits |
If a TAX ID shown on the associated Travel Agent profile has been entered this should populate this column, otherwise the words NOT PROVIDED must appear in this field NAME.TAX1 NO |
Reporting Flag |
1 Char |
Blank |
The Batch Trailer record is mandatory for all batch transfers. This record must be the last record in the file.
Note: The total values are not calculated, but are added up from the RC (Reported Commission) and TX (Tax Record) included with the file.
HCC Field Name |
Length |
Description |
Record ID |
2 Char |
BT |
Total RC Records |
8 Digits |
Total number of RC records in this batch. |
Total TX Records |
8 Digits |
Total number of TX records in this batch. |
Total PM Records |
8 Digits |
Total number of PM records in this batch. |
Total Commissionable Revenue |
15 Digits |
Total Commissionable revenue from which the commission is calculated. |
Total Gross Commission |
15 Digits |
Total Net commission (Gross commission Tax Amount) |
Total Adjustment Amount |
15 Digits |
0.00 |
Total Tax Amount |
15 Digits |
Tax calculated on Net Commissions |
Total Net Commission Due Amount |
15 Digits |
Total Gross Commission (Net Commission + Tax Amount) |
Currency Code |
3 Char |
Use the 3 digit currency code defined in the EFT setup ASCII FFORMAT.REMITTING CURRENCY. |
Users are taken through the normal steps in order to initiate the process of payment to the EFT type HCC. The payment process is based according to the type associated to the bank account.
Upon initiating the payment processing from within OPERA, if the bank account is linked to an EFT type and the HCC export type has been selected the following validation checks occur:
If the Country code is US or CA (ISO Codes for United States and Canada) then States must be filled. Otherwise State can be left blank.
See Also
