Message Description
protel I/O uses this request and response message pair to inform external system about folios details of a reservation on request. External systems can use either the reservation ID or the FolioID to request the items already booked and the items planned for an invoice. Protel returns with each folios that are attached to a reservation. The Information can be used by the guest to review the charges incurred during their stay, or to get the information about the outstanding amount to be paid.
Sample Worflow:
Message Attributes
HTNG_HotelFolioRQ
Element | @Attribute | Type | Num | Description | Comments + Content Inbound | pAIR | OnPrem |
---|---|---|---|---|---|---|
HTNG_HotelFolioRQ | 1 | Root element of the message. | ||||
@EchoToken | StringLength1to128 | 0..1 | A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. | |||
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | |||
@TimeStamp | dateTime | 1 | Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock (e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z). | YYYY-MM-DDThh:mm:ssZ | ||
@Version | decimal | 0..1 | For all OpenTravel versioned messages, the version of the message is indicated by a decimal value. | |||
@PrimaryLangID | language | 0..1 | The default language of the property | ISO-639-1 (2-char code) | ||
HTNG_HotelFolioRQ | POS | Source | 1..10 | This holds details regarding the requestor. It may be repeated to also accommodate the delivery systems. | ||||
HTNG_HotelFolioRQ | POS | Source | RequestorID | 0..1 | An identifier of the entity making the request (e.g.; ATA/IATA/ID number, Electronic Reservation Service Provider (ERSP), Association of British Travel Agents (ABTA)). | ||||
@ID | StringLength1to32 | 1 | A unique identifying value assigned by the creating system. In the context of protel IO, this will be the unique hotel ID where the profile was created. | |||
@Type | OTA_CodeType UIT | 1 | A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists Unique ID Type (UIT) | |||
@ID_Context | StringLength1to32 | 1 | Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value | “protelIO” | ||
HTNG_HotelFolioRQ | UniqueID | 0..1 | An identifier used to uniquely reference an object in a system (e.g.; an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). | ||||
@ID | StringLength1to32 | 1 | A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | |||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT). |
HTNG_HotelFolioRS
Element | @Attribute | Type | Num | Description | Comments + Content Outbound | pAIR | OnPrem |
---|---|---|---|---|---|---|
HTNG_HotelFolioRS | 1 | Root element of the message. | ||||
@EchoToken | StringLength1to128 | 0..1 | A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. | |||
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | |||
@TimeStamp | dateTime | 1 | Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock (e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z). | YYYY-MM-DDThh:mm:ssZ | ||
@Version | decimal | 0..1 | For all OpenTravel versioned messages, the version of the message is indicated by a decimal value. | |||
@PrimaryLangID | language | 0..1 | The default language of the property | ISO-639-1 (2-char code) | ||
@Target | NMToken | 0..1 | Test or Production target system indicator. | |||
@TransactionStatusCode | NMToken | 0..1 | This indicates where this message falls within a sequence of messages. | |||
@RetransmissionIndicator | boolean | 0..1 | When true, indicates the message is being re-sent after a failure. |
| ||
HTNG_HotelFolioRS | Success | 0..1 | The presence of the empty Success element explicitly indicates that the OpenTravel Alliance message succeeded. | ||||
HTNG_HotelFolioRS | Errors | 0..1 | Used in conjunction with the Success element to define one or more business errors. | ||||
HTNG_HotelFolioRS | Errors | Error | 1..n | Used when a message has been successfully processed to report any warnings or business errors that occurred. | ||||
@Type | OTA_CodeType | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | |||
@Code | OTA_CodeType | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | |||
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | |||
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided." | |||
HTNG_HotelFolioRS | Warnings | 0..1 | Collection of warnings. | ||||
HTNG_HotelFolioRS | Warnings | Warning | 1..n | Used when a message has been successfully processed to report any warnings or business errors that occurred. | ||||
@Type | OTA_CodeType | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | |||
@Code | OTA_CodeType | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | |||
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | |||
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided." | |||
HTNG_HotelFolioRS | UniqueID | 1 | An identifier used to uniquely reference an object in a system (e.g.; an airline reservation reference, customer profile reference, booking confirmation number or a reference to a previous availability quote). | ||||
@ID | StringLength1to32 | 1 | A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | |||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT). | |||
HTNG_HotelFolioRS | Folios | 0..1 | A collection of folios. | ||||
HTNG_HotelFolioRS | Folios | Folio | 1..n | An individual folio of charges. | ||||
@GuestPayable | boolean | 0..1 | When true, the Guest may provide payment for the folio. When false, the Guest may not provide payment for the folio. | |||
@FolioID | StringLength1to16 | 0..1 | Unique identifier of a given folio. on prem: | |||
@InvoiceID | StringLength1to16 | 0..1 | Unique identifier of a given invoice. | |||
@FolioGroupingID | StringLength1to16 | 0..1 | Indicator for the status of an invoice If it is "closed" no further booking is possible If it is "open" further booking is possible even if a InvoiceID is existing | |||
@FolioType | NMTOKEN | 0..1 | An enumeration of the following values: Group, Corporate, Wholesaler, Comp Accounting, Guest, Package, Other. | possible Values:
| ||
HTNG_HotelFolioRS | Folios | Folio | BasicPropertyInfo | 1 | An abbreviated short summary of hotel descriptive information. | ||||
@ChainCode | StringLength1to8 | 0..1 | The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. | |||
@HotelCode | StringLength1to16 | 0..1 | The code that uniquely identifies a single hotel property. | |||
@HotelCodeContext | StringLength1to32 | 0..1 | A text field used to communicate the context. | "protelIO" | ||
@HotelName | StringLength1to128 | 0..1 | A text field used to communicate the proper name of the hotel. | |||
HTNG_HotelFolioRS | Folios | Folio | CustomerProfile | 1 | The profile for the guest incurring the charges. | ||||
HTNG_HotelFolioRS | Folios | Folio | CustomerProfile | ProfileInfo | 1..n | The profile for the guest incurring the charges. | ||||
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | |||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | |||
HTNG_HotelFolioRS | Folios | Folio | CustomerProfile | ProfileInfo | UniqueID | CompanyName | 0..1 | Identifies a company by name. | ||||
@CompanyShortName | StringLength1to32 | 0..1 | Used to provide the company common name. | |||
@TravelSector | OTA_CodeType TVS | 0..1 | The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS). | |||
@Code | StringLength1to16 | 0..1 | Identifies a company by the company code. | |||
@CodeContext | StringLength1to32 | 0..1 | Identifies the context of the identifying code, such as DUNS, IATA or internal code, etc. |
| ||
HTNG_HotelFolioRS | Folios | Folio | CustomerProfile | ProfileInfo | Profile | _Profile element | 1..n | The profile for the guest incurring the charges. | |||
HTNG_HotelFolioRS | Folios | Folio | PayerProfile | 1 | The profile for the entity with financial responsibility for the charges incurred. | ||||
HTNG_HotelFolioRS | Folios | Folio | PayerProfile | ProfileInfo | 1 | The profile for the entity with financial responsibility for the charges incurred. | ||||
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | |||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | |||
HTNG_HotelFolioRS | Folios | Folio | PayerProfile | ProfileInfo | UniqueID | CompanyName | 0..1 | Identifies a company by name. | ||||
@CompanyShortName | StringLength1to32 | 0..1 | Used to provide the company common name. | |||
@TravelSector | OTA_CodeType TVS | 0..1 | The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS). | |||
@Code | StringLength1to16 | 0..1 | Identifies a company by the company code. | |||
@CodeContext | StringLength1to32 | 0..1 | Identifies the context of the identifying code, such as DUNS, IATA or internal code, etc. |
| ||
HTNG_HotelFolioRS | Folios | Folio | PayerProfile | ProfileInfo | Profile | _Profile element | 1..n | The profile for the guest incurring the charges. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueSummary | 0..1 | A summary of all items posted to this folio. | ||||
HTNG_HotelFolioRS | Folios | Folio | RevenueSummary | GrossAmount | 0..1 | The total booking cost to the customer. | ||||
@Amount | Money | 1 | A monetary amount. | If a Reservation is cancelled or No-Show the Amount will be 0,00 | ||
@CurrencyCode | AlphaLength3 | 1 | Currency code. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueSummary | TaxItems | 0..1 | The total taxes charged to the customer. | ||||
@Amount | Money | 1 | A monetary amount. | If a Reservation is cancelled or No-Show the Amount will be 0,00 | ||
@CurrencyCode | AlphaLength3 | 1 | Currency code. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueSummary | BalanceDueAmount | 1 | The amount remaining to be paid by the customer, i.e., GrossAmount less the greater of DepositAmount and Amount Received. | ||||
@Amount | Money | 1 | A monetary amount. | If a Reservation is cancelled or No-Show the Amount will be 0,00 | ||
@CurrencyCode | AlphaLength3 | 1 | Currency code. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueSummary | AmountReceived | 0..1 | The payment amount received against the reservation. | ||||
@Amount | Money | 1 | A monetary amount. | If a Reservation is cancelled or No-Show the Amount will be 0,00 | ||
@CurrencyCode | AlphaLength3 | 1 | Currency code. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | 0..1 | |||||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | 1..n | The line item detail of specific revenue transactions. | ||||
@ReferenceID | StringLength1to8 | 0..1 | The unique transaction identifier for this posting. | |||
@TransactionDate | date | 0..1 | The date the transaction was posted. | |||
@PMSRevenueCode | StringLength1to8 | 1 | The transaction code assigned by the PMS. | |||
@RevenueCategoryCode | OTA_CodeType RCC | 0..1 | Describes the type of revenue generated. Refer to OpenTravel Code List Revenue Category Code (RCC). | |||
@CurrencyCode | AlphaLength3 | 0..1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
@Amount | Money | 1 | A monetary amount. | |||
@Description | StringLength1to64 | 0..1 | The line item detail description for this posting. | |||
@SubTypeID | string | 0..1 | This field shows the type of posting | Unknown("Unknown"), Batch("Batch"), BatchForecast("BatchForecast"), Revenue("Revenue"), RevenueForecast("RevenueForecast"), Payment("Payment"), Void("Void"), VoidBatch("VoidBatch"), Deposit("Deposit"), Allowance("Allowance"), Tax("Tax"), TaxForecast("TaxForecast") | ||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | FolioIDs | 1 | This element is no implemented in the Kiosk messaging, but the OpenTravel Alliance schema requires its use. Only a single child FolioID is needed in order to fulfill the schema requirement. | ||||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | FolioIDs | FolioID | StringLength1to32 | 1..99 | This element holds the unique transaction identifier for this posting. | All FolioID will have one or more of the short in front
| ||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | UnitPrice | 0..1 | The unit amount charged for the service including additional amounts and fees. | ||||
@AmountBeforeTax | Money | 0..1 | The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax). | |||
@AmountAfterTax | Money | 0..1 | The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax). | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
@Type | OTA_CodeType | 0..1 | Type of charge. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | UnitPrice | Taxes | 0..1 | A collection of taxes. | Is not be displayed for SubType="Batch"/"BatchForecast" | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | UnitPrice | Taxes | Tax | 0..99 | Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. | ||||
@Type | AmountDeterminationType | 0..1 | Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). |
| ||
@Percent | Percentage | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | Sample: Percent="7.00 | ||
@Amount | Money | 1 | A monetary amount. | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | ExtendedPrice | 0..1 | The total amount charged for the service including additional amounts and fees. | ||||
@AmountBeforeTax | Money | 0..1 | The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax). | |||
@AmountAfterTax | Money | 0..1 | The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax). | |||
@Quantity | integer | 0..1 | The number of items purchased. | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
@Type | OTA_CodeType | 0..1 | Type of charge. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | ExtendedPrice | Taxes | 0..1 | A collection of taxes. | Is not be displayed for SubType="Batch"/"BatchForecast" | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | ExtendedPrice | Taxes | Tax | 0..99 | Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. | ||||
@Type | AmountDeterminationType | 0..1 | Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). |
| ||
@Percent | Percentage | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | Sample: Percent="7.00 | ||
@Amount | Money | 1 | A monetary amount. | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | Account | ||||||
@ID | StringLength1to32 | 1 | A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | |||
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT). | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | 0..1 | The item details of posted revenue transactions for packages or batches. | ||||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | RevenueDetailItem | 1..n | |||||
@Amount | Money | 1 | A monetary amount (gross). | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
@Description | StringLength1to64 | 0..1 | The line item detail description for this posting. | |||
@PMSRevenueCode | StringLength1to8 | 1 | The transaction account code in PMS. | |||
@ReferenceID | StringLength1to8 | 0..1 | The unique transaction identifier for this posting. | |||
@TransactionDate | date | 1 | The date the transaction was posted. | |||
@RevenueCategoryCode | OTA_CodeType RCC | 0..1 | The category code for the item revenue. | |||
@GuestViewable | boolean | 0..1 | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | FolioIDs | 1 | This element holds the unique transaction identifier for this posting. | ||||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | FolioIDs | FolioID | StringLength1to32 | 1..99 | This element holds the unique transaction identifier for this posting. | All FolioID will have one of the short in front
| ||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | UnitPrice | 0..1 | The unit amount charged for the service including additional amounts and fees. | ||||
@AmountBeforeTax | Money | 0..1 | The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax). | |||
@AmountAfterTax | Money | 0..1 | The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax). | |||
@CurrencyCode | AlphaLength3 | 1 | The local currency of the property. | |||
@Type | OTA_CodeType | 0..1 | Type of charge. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | UnitPrice | Taxes | 0..1 | A collection of taxes | ||||
@CurrencyCode | AlphaLength3 | 1 | The local currency of the property. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | UnitPrice | Taxes | Tax | 0..99 | Applicable tax element. should be calculated in only one of the two ways | ||||
@Type | AmountDeterminationType | 0..1 | Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). | |||
@Percent | Percentage | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | Sample: Percent="7.00 | ||
@Amount | Money | 1 | A monetary amount. | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | ExtendedPrice | 0..1 | The total amount charged for the service including additional amounts and fees. | ||||
@AmountBeforeTax | Money | 0..1 | The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax). | |||
@AmountAfterTax | Money | 0..1 | The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax). | |||
@Quantity | integer | 0..1 | The number of items purchased. | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
@Type | OTA_CodeType | 0..1 | Type of charge. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | ExtendedPrice | Taxes | 0..1 | A collection of taxes. | ||||
@CurrencyCode | AlphaLength3 | 1 | The local currency of the property. | |||
HTNG_HotelFolioRS | Folios | Folio | RevenueDetails | RevenueDetail | RevenueDetailItems | ExtendedPrice | Taxes | Tax | 0..99 | Applicable tax element. This element allows for both percentages and flat amounts. | ||||
@Type | AmountDeterminationType | 0..1 | Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). | |||
@Percent | Percentage | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||
@Amount | Money | 1 | A monetary amount. | |||
@CurrencyCode | AlphaLength3 | 1 | The code specifying a monetary unit. Use ISO 4217, three alpha code. | |||
HTNG_HotelFolioRS | TPA_Extensions | FiscalExtensions | FiscalExtension | 0..1 | Used to provide information about the used FiscalCode for fiscalizing PMS only | ||||
@InvoiceID | string | 1 | InvoiceID | |||
@FiscalCode | string | 1 | Used FiscalCode |