Target audiencePBX, In room systems, Mobile and Kiosk
Version3.0.
AuthenticationBearer Token
Message typeAsynchronous, Push
DirectionInbound

Message Description

protel I/O uses this request and response message pair to provide external system the possible of posting of charges to previously identified accounts (for example guest folios, membership accounts, house accounts, AR accounts). With the HTNG_ChargePostingRQ an external System can post Payment or Revenue. Of course it is as well possible to post Revenue and Payment in one request.



Message Attributes

HTNG_ChargePostingRQ

Element | @Attribute

Type

Num

Description

Comments + Content Inbound pAIROnPrem

HTNG_ChargePostingRQ


1

Root element of the message.


(Haken)(Haken)

@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.


(Haken)(Haken)

@CorrelationID

StringLength1to641

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.


(Haken)(Haken)

@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

(Haken)(Haken)

@Version

decimal

0..1

For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.


(Haken)(Haken)

@PrimaryLangID

language

0..1

The default language of the property

ISO-639-1 (2-char code)

(Haken)(Haken)

HTNG_ChargePostingRQ | POS


0..1

See: POS_Type in the OpenTravel specification.


(Haken)(Haken)
HTNG_ChargePostingRQ | POS | Source
1..10Holds the details about the requester
(Haken)(Haken)
HTNG_ChargePostingRQ | POS | Source | RequestorID
0..1An identifier of the entity making the request
(Haken)(Haken)

@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.


(Haken)(Haken)

@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)

(Haken)(Haken)

@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”

(Haken)(Haken)
HTNG_ChargePostingRQ | POS | Source | BookingChannel
0..1Specifies the booking channel type and whether it is the primary means of connectivity of the source
(Haken)(Haken)

@Primary

Boolean

0..1

Indicates whether the enumerated booking channel is the primary means of connectivity used by the source.

  • "true" 

  • "false"

(Fehler)(Haken)

@Type

OTA_CodeType BCT

1

The type of booking channel. Refer to the OTA code lists Booking Channel Type (BCT).

(Fehler)(Haken)

HTNG_ChargePostingRQ | PropertyInfo


0..1

See: HotelReferenceGroup in the OpenTravel specification. PropertyInfo needed for HotelCode check


(Haken)(Haken)

@ChainCode

StringLength1to8

0..1

The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors.


(Haken)(Haken)

@HotelCode

StringLength1to16

0..1

The code that uniquely identifies a single hotel property. 


(Haken)(Haken)

@HotelCodeContext

StringLength1to32

0..1

A text field used to communicate the context.

"protelIO"

(Haken)(Haken)

@HotelName

StringLength1to128

0..1

A text field used to communicate the proper name of the hotel.


(Haken)(Haken)

HTNG_ChargePostingRQ | Posting


1

Describes the charge posting and associated information.


(Haken)(Haken)

@ID

String

1

A unique identifier for this posting.


(Haken)(Haken)
HTNG_ChargePostingRQ | Posting | RevenueCenter
0..1Describes the revenue center of charge posting and associated information.
(Haken)(Haken)
@DescriptionString0..1Description of the revenue center"Kiosk"(Haken)(Haken)
@IDString0..1A unique identify value assigned to the revenue center and is mapped to the predefined cash register in the PMS.99(Haken)(Haken)
HTNG_ChargePostingRQ | Posting | RevenueCenter | Terminal
1Describes the terminal of charge posting and associated information.
(Fehler)(Haken)
@IDString0..1A unique identify value assigned to the terminal. 250(Fehler)(Haken)

HTNG_ChargePostingRQ | Posting | Transaction


1

Transactional information pertaining to a check/invoice.


(Haken)(Haken)

@TicketID

StringLength1to16

0..1

The check/invoice number representing the charges.


(Haken)(Haken)

@OpenTime

date

0..1

The time, the phone call was started
OR
The time the consumption was posted via phone (minibar)


(Haken)(Fehler)

@Extension

StringLength1to16

0..1

The extension of the telephone (obviously in the same room) used by the employee, who fills in the minibar.
OR
The extension of the telephone used for the phone call.


(Haken)(Fehler)

HTNG_ChargePostingRQ | Posting | Transaction | RevenueDetails


1

A collection of line items.


(Haken)(Haken)

HTNG_ChargePostingRQ | Posting | Transaction | RevenueDetails | RevenueDetail


1..n

The line item detail of specific revenue transactions. Separate group of elements/attributes have to be provided per line item.


(Haken)(Haken)

@ReferenceID

StringLength1to8

0..1

Article number of the item, consumed by the guest. Passed from the PBX to the PMS without interpretation.

Additional comment: PBX is solely transmitting the Postings without interpretation. If the minibar should be filled up, you have to press a softkey or functional key or a specific key combination to activate minibar-posting. First input must be the article number followed by (#) to submit in case of posting e.g. 1x Coke or followed by (*) to enter a quantity and finally submitted with # in case of posting e.g. 3x coke.
EXAMPLE: Softkey | 3 | * | 2 | # → 2x article 3

With the attribute @ReferenceID it will be possible to post as well articles. In the attribute @ReferenceID the Article ID needs to be sent to protel. with the attribute @PMSRevenueCode the TAA from the article should be provided.(Fehler)(Haken)
@PMSRevenueCodeStringLength1to81TAA of the item consumed by the guest.
(Haken)(Haken)

@CurrencyCode

AlphaLength3

0..1

The code specifying a monetary unit. Use ISO 4217, three alpha code.

Currency code is mandatory for proper processing(Haken)(Haken)

@Amount

Money

1

A monetary amount.


(Haken)(Haken)

@Description

StringLength1to64

0..1

The line item detail description for this posting
OnPrem: If provided, text will be used to populate leist.zustext (for Payment and Revenue). If not provided, zahlart.bez (for Payment) or ukto.bez (for Revenue) will be used instead. In case of Deposit, this text is not used.


(Haken)(Haken)

@SubTypeID

string

0..1

A value used to further detail the category

  • Revenue
  • Payment
  • Deposit
    (Warnung) For future (not checked-in) reservations a payment can only be posted by using SubTypeID=Deposit.
(Haken)(Haken)
@RevenueCategoryCodeOTA_CodeType RCC0..1Describes the type of revenue generated.
Refer to OpenTravel Code List Revenue Category Code (RCC).
(Haken)(Haken)

HTNG_ChargePostingRQ | Posting | Transaction | RevenueDetails | RevenueDetail | ExtendedPrice


0..1

The total amount charged for the service including additional amounts and fees.


(Haken)(Haken)

@AmountAfterTax

Money

0..1

Single Amount of the posted item


(Haken)(Haken)

@Quantity

integer

0..1

Quantity of items consumed by the guest. Passed from the PBX to the PMS without interpretation. Only mandatory if quantity is larger than 1.

Additional comment: PBX is solely transmitting the Postings without interpretation. If the minibar should be filled up, you have to press a softkey or functional key or a specific key combination to activate minibar-posting. First input must be the article number followed by (#) to submit in case of posting e.g. 1x Coke or followed by (*) to enter a quantity and finally submitted with # in case of posting e.g. 3x coke.
EXAMPLE: Softkey | 3 | * | 2 | # → 2x article 3
OR
(mandatory) Quantity of units, to charge the call, if there is no monetary amount available. (Wrong terminology, but more common: meta pulses)


(Haken)(Haken)
@CurrencyCodeAlphaLength30..1The code specifying a monetary unit. Use ISO 4217, three alpha code.
(Haken)(Haken)
HTNG_ChargePostingRQ | Posting | Transaction | RevenueDetails | RevenueDetail | Account
0..1Identification of the exact allocation of the posted charge/payment.
(Haken)(Haken)

@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.


(Haken)(Haken)

@ID_Context

StringLength1to32

1

Used to identify where the ID comes from.

"protelIO"

(Haken)(Haken)

@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).

(Haken)(Haken)

HTNG_ChargePostingRS

Element | @Attribute

Type

Num

Description/Contents

Comments + Content OutboundpAIROnPrem

HTNG_ChargePostingRS


1

Root element of the message.


(Haken)(Haken)

@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.


(Haken)(Haken)

@CorrelationID

StringLength1to641

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.


(Haken)(Haken)

@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

(Haken)(Haken)

@Version

decimal

0..1

For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.


(Haken)(Haken)

@PrimaryLangID

language

0..1

The default language of the property

ISO-639-1 (2-char code)

(Haken)(Haken)

HTNG_ChargePostingRS | Success


1

Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors.


(Haken)(Haken)

HTNG_ChargePostingRS | Warnings


1

Collection of warnings.


(Haken)(Haken)

HTNG_ChargePostingRS | Warnings | Warning


1..n

Used when a message has been successfully processed to report any warnings or business errors that occurred.


(Haken)(Haken)

@Type 

OTA_CodeType

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

(Haken)(Haken)

@Code 

OTA_CodeType

0..1 

Refers to the OTA Code List: Error Codes (ERR). 

(Haken)(Haken)

@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. 


(Haken)(Haken)

@ShortText

StringLength1to64

0..1

Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided."


(Haken)(Haken)

HTNG_ChargePostingRS | Errors


1

A collection of errors that occurred during the processing of a message.


(Haken)(Haken)

HTNG_ChargePostingRS | Errors | Error


1..n

Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.


(Haken)(Haken)

@Type 

OTA_CodeType

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

(Haken)(Haken)

@Code 

OTA_CodeType

0..1 

Refers to the OTA Code List: Error Codes (ERR). 

(Haken)(Haken)

@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. 


(Haken)(Haken)

@ShortText

StringLength1to64

0..1

Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided."


(Haken)(Haken)
  • Keine Stichwörter