Message Description
Transmit invoice data & already assigned fiscal codes.
Message Attributes
IO_InvoiceFiscalizeNotifRQ
| Element | @Attribute | Type | Num | Description Outbound | Comments + Contents outbound | pAir | OnPrem | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
IO_InvoiceFiscalizeNotifRQ | 1 | Root element of the message. |  |  | ||||||||
| @CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | | | |||||||
| @Timestamp | dateTime | 0..1 | Time of the transaction. | | | |||||||
| @Version | decimal | 0..1 | Message version. | | | |||||||
IO_InvoiceFiscalizeNotifRQ | UniqueID | 0..10 | | | |||||||||
@ID | StringLength1to32 | 1 | ID of the business object (e.g. hotel, invoice, customer, reservation) | | | |||||||
| @ID_Context | StringLength1to32 | 1 | System identifier (which generated the ID) | | | |||||||
| @Type | protel CodeType | 0..1 | see protel Code List PIT - IO Unique ID Types "Tenant", "Invoice", "Customer", "Hotel" | | | |||||||
| IO_InvoiceFiscalizeNotifRQ | ExternalTerminal | 0..1 | | | |||||||||
| @TerminalName | string | 1 | | | ||||||||
| @URL | string | 0..1 | | | ||||||||
| @Location | string | 0..1 | | | ||||||||
| @Notes | string | 0..1 | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalCode | 0..1 | | | |||||||||
| @Value | Text (number) to display on the invoice. Will be sent in RQ Reference element for void operation | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalClosingID | 0..1 | | | |||||||||
| @Value | Text (number) to display on the invoice. Will be sent in RQ Reference element for void operation | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalDate | 0..1 | | | |||||||||
| @Value | Will be sent in RQ Reference element for void operation | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalNotes | 0..1 | | | |||||||||
| @Value | Textual information regarding the fiscalization process | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalSignatures | 0..1 | Fiscalization result w/ more complex data (e.g. QR codes & signatures) | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalSignatures | Signature | 0..10 | | | |||||||||
@Type | protel CodeType | 0..1 | see protel Code List PIT - IO Unique ID Types | | | |||||||
@Format | protel CodeType | 0..1 | see protel Code List PIT - IO Unique ID Types | | | |||||||
@Timestamp | dateTime | 0..1 | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalSignatures | Signature | Label | 0..1 | | | |||||||||
| @Value | Description of signature created | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | ExternalFiscalSignatures | Signature | Data | 1 | | | |||||||||
| @Value | Actual data of signature (Binary data must be Base64 encoded) | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | 0..1 | Copy of invoice data sent with RQ | | | ||||||||
| @InvoiceCode | string | 0..1 | Invoice number (shown to the user) | | | |||||||
| @FiscalCode | string | 0..1 | The fiscal code assigned to this invoice | | | |||||||
| @FiscalCodeID | string | 0..1 | Internal ID for the Fiscal code assigned to this invoice | | | |||||||
| @Open | boolean | 0..1 | Is this invoice open (true / false) | | | |||||||
| @Void | boolean | 0..1 | Is this invoice voided (true/false) | | | |||||||
| @InvoiceID | string | 0..1 | Reference to the Voided invoice (@InvoiceCode) | | | |||||||
| @FiscalCode | string | 0..1 | Reference to the voided invoice (@FiscalCode) | | | |||||||
| @Type | string | 1 | "Reservation", "Passerby", "Group", "Unknown" | | | |||||||
| @InvoiceDate | dateTime | 0..1 | Timestamp of the invoice generation, stored in invoices table and printed on invoice (ISO DateTime) | | | |||||||
| @User | string | 0..1 | The user who initiated Invoice creation (close of the folio) | | | |||||||
| @UserTaxNo | string | 0..1 | Tax Number of the user who closed/checked Invoice | | | |||||||
| @DeliveryDate | string | 0..1 | Display the invoice delivery date / sales date date (legal for Poland) | | | |||||||
| @TaxProcedureCode | string | 0..1 | For some TAA’s it’s necessary to assign TaxProcedureCode. When this code is assigned then it has to be reported to the Government server. | PMS_TaxProcedureCode | | | ||||||
| @BusinessDate | string | 0..1 | | | ||||||||
| @ExternallyFiscalized | boolean | 0..1 | | | ||||||||
| @FiscalCodeName | string | 0..1 | | | ||||||||
| @FiscalDate | string | 0..1 | | | ||||||||
| @Fiscalized | boolean | 0..1 | | | ||||||||
| @PastEndOfDay | boolean | 0..1 | | | ||||||||
| @SystemFiscalCode1 | string | 0..1 | Fiscal config extra Code1 | |||||||||
| @SystemFiscalCode2 | string | 0..1 | Fiscal config extra Code2 | |||||||||
| @SystemFiscalCode3 | string | 0..1 | Fiscal config extra Code3 | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | VoidReason | 0..1 | Voiding reason info text. | | | ||||||||
| Value | string | 0..1 | Textual description | | | |||||||
| IO_InvoiceFiscalizeNotifRQ | Invoice | TotalChargeAmount | 1 | Total (gross) charged amount | | | ||||||||
| @Amount | decimal | 1 | Total amount decimal | | | |||||||
| @CurrencyCode | AlphaLength3 | 1 | Three-letter currency code | | | |||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | TotalPaymentsAmount | 1 | Total payment amount | | | ||||||||
| @Amount | decimal | 1 | Total amount decimal | | | |||||||
| @CurrencyCode | AlphaLength3 | 1 | Three-letter currency code | | | |||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | TotalDepositsAmount | 1 | Total deposits amount | | | ||||||||
| @Amount | decimal | 1 | Total amount decimal | | | |||||||
| @CurrencyCode | AlphaLength3 | 1 | Three-letter currency code | | | |||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | TotalExpensesAmount | 1 | Total expenses amount | | | ||||||||
| @Amount | decimal | 1 | Total amount decimal | | | |||||||
| @CurrencyCode | AlphaLength3 | 1 | Three-letter currency code | | | |||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | 0..1 | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item
| 0..n | | | |||||||||
| @Quantity | integer | 1 | Number of items charged/payed | | | |||||||
| @TaxRate | decimal | 1 | Percentage of VAT as a decimal value | | | |||||||
| @TaxCode | protel CodeType | 0..1 | Tax name as defined by the sender | | | |||||||
| @Type | string | 1 | Type of item (Payment, Article, Expense) | | | |||||||
| @ServiceDate | string | 1 | Date item was posted to the invoice | | | |||||||
| @CashRegisterID | string | 1 | ID of Cash register the user was logged in to | | | |||||||
| @ID | string | 1 | | | ||||||||
| @PostingAccount | string | 0..1 | | | ||||||||
| @SystemDate | string | 1 | | | ||||||||
| @GroupCode | string | 1 | In some situations it is necessary to have GTUCode assigned to the invoice header. This should be related to fiscal code (assignable to fiscal code in PMS SD). | PMS_GroupCode | | | ||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | PostingText | 1 | | | |||||||||
| Value | string | Description of the item posted | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | AdditionalText | 0..1 | | | |||||||||
| Value | string | Additional text to the posting | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | TotalAmountAfterTax | 1 | | | |||||||||
| @CurrencyCode | AlphaLength3 | 1 | Three-letter currency code | | | |||||||
| @ExchangeRate | string | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | TotalAmountAfterTax | Amount | 1 | | | |||||||||
| Value | decimal | A decimal value of the item's total | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | SingleAmountAfterTax | 1 | | | |||||||||
| @CurrencyCode | AlphaLength3 | 1 | Three-letter currency code | | | |||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | SingleAmountAfterTax | Amount | 1 | | | |||||||||
| Value | The decimal value of the item's single amount including VAT | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | TotalAmountBeforeTax | 1 | | | |||||||||
| @CurrencyCode | AlphaLength3 | Three-letter currency code | | | ||||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | TotalAmountBeforeTax | Amount | 1 | | | |||||||||
| Value | The decimal value of the item's total amount excluding VAT | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | SingleAmountBeforeTax | 1 | | | |||||||||
| @CurrencyCode | AlphaLength3 | Three-letter currency code | | | ||||||||
| @ExchangeRate | decimal | 0..1 | The exchange rate applied for conversion to hotel default currency | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | SingleAmountBeforeTax | Amount | 1 | | | |||||||||
| Value | The decimal value of the item's single amount excluding VAT | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Charges | Item | TaxInfo | 0..1 | | | |||||||||
| @Rate | decimal | 0..1 | Percentage of VAT as a decimal value | | | |||||||
| @SubCode1 | protel CodeType | 0..1 | Subcode of tax (if given) | | | |||||||
| @SubCode2 | protel CodeType | 0..1 | Subcode of tax (if given) | | | |||||||
| @ID | protel CodeType | 0..1 | ID of tax | | | |||||||
| @Code | protel CodeType | 0..1 | Shortname of tax | | | |||||||
| @Value | string | 0..1 | Description of tax | | | |||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Payments | 0..1 | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Payments | Item | 0..n | | | |||||||||
| see Invoice | Charges | Item | | | ||||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Deposits | 1 | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Deposits | Item | 0..n | | | |||||||||
| see Invoice | Charges | Item | | | ||||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Expenses | 1 | | | |||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | Expenses | Item | 0..n | | | |||||||||
| see Invoice | Charges | Item | | | ||||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | InvoiceRecipient | 1 | | | |||||||||
| @ProfileID | string | 0..1 | | | ||||||||
| @ProfileType | string | 0..1 | | | ||||||||
| see Generic elements for Legal & Fiscal messaging#Persons | 1 | The legal or individual person receiving this invoice | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | InvoiceRecipientReminderCode | 0..1 | | | |||||||||
| @Code | protel CodeType | 0..1 | | | ||||||||
| @Description | string | 0..1 | | | ||||||||
| @PrimaryInd | boolean | 0..1 | | | ||||||||
| @Inactive | boolean | 1 | | | ||||||||
| @CurrencyCode | AlphaLength3 | 0..1 | | | ||||||||
IO_InvoiceFiscalizeNotifRQ | Invoice | InvoiceRecipientReminderCode | Level | 1..10 | | | |||||||||
| @Step | integer | 1 | | | ||||||||
| @Fee | decimal | 1 | | | ||||||||
| @Days | integer | 1 | | |
IO_InvoiceFiscalizeNotifRS
| Element | @Attribute | Type | Num | Description Outbound | Comments + Contents outbound | pAir | OnPrem |
|---|---|---|---|---|---|---|
IO_InvoiceFiscalizeNotifRS | 1 | | | |||
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | | | |
@TimeStamp | dateTime | 0..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 | | | |
@Version | decimal | 0..1 | For all OpenTravel versioned messages, the version of the message is indicated by a decimal value. | | | |
| IO_InvoiceFiscalizeNotifRS | Success | boolean | 0..1 | | | ||
| IO_InvoiceFiscalizeNotifRS | Errors | boolean | 0..1 | | | ||
| IO_InvoiceFiscalizeNotifRS | Errors | Result | string | 0..n | Send one or more errors, that prevented successful message processing | | | |
| @Code | OTA_CodeType ERR | 0..1 | Code of the error | Error Codes (ERR) | | |
| @ReferenceCode | string | 0..1 | Refer to the identifier of business in RQ message | | | |
| IO_InvoiceFiscalizeNotifRS | Errors | Result | Message | string | 0..1 | | | ||
| @Value | string | 1 | | | ||
| IO_InvoiceFiscalizeNotifRS | Warnings | boolean | 0..1 | | | ||
| IO_InvoiceFiscalizeNotifRS | Warnings | Result | string | 0..1 | | | ||
| @Code | OTA_CodeType ERR | 0..1 | Code of the warning | Error Codes (ERR) | | |
| @ReferenceCode | string | 0..1 | Refer to the identifier of business in RQ message | | | |
| IO_InvoiceFiscalizeNotifRS | Warnings | Result | Message | string | 0..1 | | | ||
| @Value | string | 1 | | |