Context
Message schemas have reusable parts, used to transport information about business objects needed in different use cases.
Business objects
Identifiers of business objects in different systems
UniqueID | Occurrence | Additional information |
|---|
@ID | 1 | ID of the business object (e.g. hotel, invoice, customer, reservation) |
| @ID_Context | 1 | System identifier (which generated the ID) |
| @Type | 1 | see protel Code List PIT - IO Unique ID Types
"Tenant", "Invoice", "Customer", "Hotel" |
Persons
Person Info (XSD: IOPersonType) | Occurrence | Additional information | protelAir field | protelAir logic / status |
|---|
| FirstName | 0..1 |
| Guest.FirstName |
|
| LastName | 1 | Person's or Company's name | Guest.LastName |
|
| MiddleName | 0..1 |
| Guest.MiddleName |
|
| SecondName | 0..1 |
|
|
|
| Title | 0..1 |
| Guest.Title |
|
| Salutation | 0..1 |
| Guest.Salut |
|
| BirthDate | 0..1 |
| Guest.BirthDate |
|
| BirthPlace | 0..1 | Municipality of birth |
|
|
| BirthCountry | 0..1 | Country of birth | Guest.BirthPlace |
|
| Nationality | 0..1 | Nationality of profile (2-letter ISO) | Guest.Nationality |
|
| Notes | 0..1 | Free text | Guest.GuestNotes |
|
| Language | 0..1 | Language code of profile (2-letter ISO) | Guest.Language |
|
| Passport | 0..1 | Number of passports | Guest.Passport |
|
| Department | 0..1 | Department of the company the person is working | Guest.Department |
|
| Gender | 0..1 | Gender code of the person | Guest.Gender |
|
| TaxNumber | 0..1 |
| Guest.SalesTaxNumber |
|
| TaxNumber2 | 0..1 |
| Guest.SalesTaxNumber2 |
|
| Adresses | 0..1 | Postal address of the legal/private person |
|
|
|---|
| Adresses | Address | 1..n |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#Addresses |
|
|
|
|
| EmailAddresses | 0..1 | E-Mail adresses to use |
|
|
|---|
| EmailAddresses | Communication | 1..n |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#Communications |
|
|
|
|
| PhoneNumbers | 0..1 | Phone number to use |
|
|
|---|
| PhoneNumbers | Communication | 1..n |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#Communications |
|
|
|
|
| FaxNumbers | 0..1 | Fax numbers to use |
|
|
|---|
| FaxNumbers | Communication | 1..n |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#Communications |
|
|
|
|
| OtherCommunications | 0..1 | Further communication methods available |
|
|
|---|
| OtherCommunications | Communication | 1..n |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#Communications |
|
|
|
|
| Company | 0..1 | Company related to the (private) profile |
| If profile is a person, it may have a company relationship |
|---|
| see Generic elements for Legal & Fiscal messaging#Persons |
|
|
|
|
| ContactPerson | 0..1 | Contact person related to the (company) profile |
| If profile is a company, it may have a contact person named |
|---|
| see Generic elements for Legal & Fiscal messaging#Persons |
|
|
|
|
| AccountingInfos |
| Accounting Infos |
|
|
| @PublicAdministrationInd | 0..1 | |
| If it is set to true, the PublicAdministration is active for this profile (legal requirement for Italy) |
| @SplitPaymentInd | 0..1 | |
| If it is set to true, the SplitPayment is active for this profile (legal requirement for Italy) |
| @FiscalUID | 0..1 | UID Number |
|
|
| @CompanyRegNumber | 0..1 | Company Registration Number |
|
|
Addresses
Address info (XSD: IOAddressType) | Occurrence | Additional Information | protelAir field | protelAir logic / status |
|---|
| @PostCode | 1 | Code/Zip of municipality | Address.ZIP |
|
| @CountryCode | 1 | Country's 2-letter ISO code | Address.CountrCode |
|
| @PrimaryInd | 0..1 |
|
|
|
| City | 1 | Name of city |
|
|
|---|
| Value | 1 |
| Address.City |
|
| Street1 | 1 | Address line 1 |
|
|
|---|
| Value | 1 |
| Address.Street1 |
|
| Street2 | 0..1 | Address line 2 |
|
|
|---|
| Value | 1 |
| Address.Street2 |
|
| Street3 | 0..1 | Address line 3 |
|
|
|---|
| Value | 1 |
| Address.Street3 |
|
| State | 0..1 | Name of the federal state |
|
|
|---|
| Value | 1 |
| Address.State |
|
| Region | 0..1 |
|
|
|
|---|
| Value | 1 |
|
|
|
| Notes | 0..1 |
|
|
|
|---|
|
|
|
|
|
Communications
Communication info (XSD: IOCommunicationType) | Occurrence | Additional Information | protelAir field | protelAir logic / status |
|---|
| @Value | 1 | Number or actual address to use | GuestCommunication.Value |
|
| @Type | 0..1 | Type of communication method | GuestCommunication.SystemTypeID | - 1: Phone
- 2: Mobile Phone
- 3: Email
- 4: Fax
|
| @Notes | 0..1 | Description | GuestCommunication.Notes |
|
| @PrimaryInd | 0..1 | Indicator (true/false) for the primary method to use | GuestCommunication.Primary |
|
Items
Item (XSD: IOItemType) | Occurrence | Additional Information | protelAir field | protelAir logic / status |
|---|
| @Quantity | 1 | Number of items | InvoicedItem.Quantity |
|
| @TaxRate | 1 | Rate (Percentage) of VAT applied | TaxLogic.Rate |
|
| @TaxCode | 1 | Code of tax logic applied | TaxLogic.Code |
|
| @Type | 1 | Item type like deposit, package, payment, etc. | InvoicedItem.TypeID |
|
| @ServiceDate | 1 | ISO DateTime of item generation | InvoicedItem.ServiceDate |
|
| @CashRegisterID | 0..1 | Cash Register the user was logged in to | InvoicedItem.CachRegisterID |
|
| @TransactionCode | 0..1 |
|
|
|
| @PostingAccount | 0..1 |
|
|
|
| PostingText | 1 |
|
|
|
|---|
| Value |
| Item posting text | InvoicedItem.PostingText |
|
| AdditionalText | 0..1 |
|
|
|
|---|
| Value |
| Additional posting text | InvoicedItem.AdditionalText |
|
| TotalAmountAfterTax | 1 |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#CurrencyAmounts |
| Total of posting after VAT applied | InvoicedItem.ATTotalAmount |
|
| SingleAmountAfterTax | 1 |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#CurrencyAmounts |
| Single item after VAT applied | InvoicedItem.ATSingleAmount |
|
| TotalAmountBeforeTax | 1 |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#CurrencyAmounts |
| Total of posting before VAT applied | InvoicedItem.PTTotalAmount |
|
| SingleAmountBeforeTax | 1 |
|
|
|
|---|
| see Generic elements for Legal & Fiscal messaging#CurrencyAmounts |
| The single item before VAT applied | InvoicedItem.PTSingleAmount |
|
| TaxInfo | 0..1 |
|
|
|
|---|
| @Rate | 1 | Tax Rate (Percentage) |
|
|
| @ID | 0..1 | ID of TaxLogic |
|
|
| @Code | 0..1 | Code of TaxLogic |
|
|
| @SubCode1 | 0..1 | Code of TaxLogic |
|
|
| @SubCode2 | 0..1 | Code of TaxLogic |
|
|
| Value | 0..1 | Name of TaxLogic |
|
|
Currency Amounts
Amount info (XSD: IOCurrencyAmountType) | Occurrence | Additional Information | protelAir field | protelAir logic / status |
|---|
| @ExchangeRate | 1 | If the foreign currency was used, this exchange rate has been used for conversion | CurrencyAmount.ExchangeRate |
|
| @CurrencyCode | 1 | 3-letter currency code | CurrencyAmount.CurrencyCode |
|
| Amount | 1 | Amount in local hotel currency | CurrencyAmount.Amount |
|
|---|
| Value |
|
|
|
|
Generic Elements
*RQ and *RS messages must hold these attributes
| Occurrence | |
|---|
| @CorrelationID | 1 | Must be sent to refer RS originating request |
| @Timestamp | 1 | Must be sent to log sender time and zone |
| @Version | 1 | Must be sent to detect compatibility problems |
Generic Results message elements
| *RS | Success | 0..1 | The element must be present if the result should be processed |
|---|
|
|
|
*RS | Errors | 0..1 |
|
|---|
*RS | Errors | Result | 1..n | Send one or more errors, that prevented successful message processing |
|---|
| @Code | 1 | Code of the error |
| @ReferenceCode | 1 | Refer to the identifier of business in RQ message |
*RS | Errors | Result | Message |
|
|
|---|
|
| Description of what went wrong |
*RS | Warnings | 0..1 |
|
|---|
*RS | Warnings | Result | 1..n |
|
|---|
| @Code | 1 | Code of the error |
| @ReferenceCode | 1 | Refer to the identifier of business in RQ message |
*RS | Warnings | Result | Message |
|
|
|---|
|
| Description of what went wrong |
