Invoice XML

This topic lists the different XML tags which can be used when creating a custom XSL template for the invoice. These XML tags control the invoice layout and which information can be displayed on the invoice.

The image above illustrates the different sections and fields in the invoice that are affected by the tags. The table lists all available tags and what they affect.

Full Parameter Name and Path

Description

currency

The invoice currency

title

The invoice title

documentFor

The person the invoice was issued for

meta

 

dir

The direction of the text on the invoice: LTR (left to right) or RTL (right to left)

align

The invoice alignment

culture

The invoice language

printMode

This is a boolean value. If 1 is used, when the invoice is printed as a PDF, the column headers are displayed above the Totals section.

header

The invoice header

logo

The header image

phone

The phone number of the passenger or the travel agent/corporate client

fax

The fax number of the travel agent/corporate client

vatNum

The VAT number of the travel agent/corporate client

paidBy

The paying travel agent/corporate client

previousInvoiceNum

The travel agent/corporate client reference number

agentReference

The travel agent/corporate client reference number/MCO as defined in the Invoice Definitions page.

agentReferenceTitle

The name of the agent reference/MCO field on the invoice

iata

The IATA number of the travel company as defined in the General Details of the company.

companyVatNumber

The VAT number of the travel company as defined in the General Details of the company.

paxFileID

The travel file reference number

currency

The invoice currency (usually the travel file currency)

companyCode

The travel agent/corporate client company number

destination

The travel file destination

invType

The invoice type. Used for determining whether to display the payment terms of travel agents/corporate clients. This information is displayed in the UI only and not the secured PDF sent to customers.

header/address

The invoice beneficiary information

to

The information in the To field

street/line

The street and street number in the header address

city

The city in the header address

state

The state in the header address

country

The country in the header address

zipCode

The zip code in the header address

header/issueDate

The invoice issue date. These tags are the different date format options which can be defined in the XSL

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

header/valueDate

The invoice value date. These tags are the different date format options which can be defined in the XSL.

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

header/paxFileStartDate

The travel file start date. These tags are the different date format options which can be defined in the XSL.

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

header/status

The invoice status

text

The invoice status (Original, Copy, or Cancelled). Can be translated in Dictionary Builder.

header/status/cenceledDetails

The details of the user who cancelled the invoice

owner

The user who cancelled the invoice

header/status/cenceledDetails/date

The date on which the invoice was cancelled

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

header/pfileOpenDate

The travel file open date. These tags are the different date format options which can be defined in the XSL.

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

waterMark

The invoice watermark

text

The text of the watermark. The following watermarks can be used: canceled, paid, in use, statement.

css

The CSS class of the watermark. Each watermark requires a separate CSS class

customers @ amount

The Passengers field listing the amount of passengers the invoice is being issued for.

customers amount/customer

The passengers in the invoice

join

The passenger join arrows

title

The passenger title

name

The passenger name

remark1Title

The name of the field displaying the first passenger remark

text1

The first passenger remark defined in the Passenger Details page

remark2Title

The name of the field displaying the second passenger remark

text2

The second passenger remark defined in the Passenger Details page

employeeID

This information is returned as UDID from the GDS.

The employee ID with the travel agent/corporate client

employeeIDTitle

This information is returned as UDID from the GDS.

The name of the EmployeeID field with the travel agent/corporate client

services

The Services section in the invoice. These parameters affect the Services table.

services @ totalTitle

The name of the Total column

services @ showVat

"1" to display the VAT column

services @ commPercentageTitle

The name of the Commission/Reduction Percentage column

services @ commTitle

The name of the Commission/Reduction column

services/service

The individual services in the Services section. These parameters affect which information is displayed for each service in the invoice.

serviceType

The service type

fromDate

The service start date

toDate

The service end date

startTime

The service start time

endTime

The service endTime

days

The number of days or nights

serviceDescriptions/description

The service description that appears in the Description column

fare

The gross price of the transaction

vat

The VAT on the transaction

vatPercent

The VAT percentage

tax

The tax on the transaction

comm

The commission/reduction on the transaction

commPlusVatOnComm

The commission/reduction on the transaction + VAT.

commPercentage

The commission/reduction percentage

total

The total amount of the transaction

currency

The transaction currency

isNet

The transaction is a net transaction

isRemark

The transaction is a remark transaction

services/serviceCustomers/customer

The breakdown of the price for each passenger in the invoice

name

The name of the passenger

fare

The gross price for the passenger

vat

The VAT on the price for the passenger

comm

The commission/reduction amount for the passenger

commPlusVatOnComm

The commission/reduction amount + VAT for the passenger

services/service/credit

This information is displayed when the client payment method in the transaction is Credit Supp, Prepaid Abroad, or MCO.

desc

The person/company being directly paid

amount

The amount being directly paid

vat

The VAT on the amount being directly paid

tax

The tax on the amount being directly paid

vatOnCommission

The VAT on the commission/reduction

comm

The commission/reduction
total

The total amount to remit

handlingFees/fee

These parameters affect the Transaction Fee section on the invoice

title

The name of the transaction fee

fare

The transaction fee amount

vat

The VAT on the transaction fee

tax

The tax on the transaction fee

vatPercentage

The VAT percentage

vatOnCommission

The VAT on the commission/reduction

total

The total amount of the transaction fee

currency

The transaction fee currency

totals

This parameter is relevant when printing a totals invoice by selecting the Print Total Invoice option in the Invoice Definitions page. Only used when printing an extended invoice

fare

The total selling price of the transactions and transaction fees

vat

The VAT on the transactions and transaction fees

tax

The tax on the transactions and transaction fees

comm

The commission/reduction on the transactions and transaction fees

commPlusVatOnComm

The total commission/reduction amount + the VAT on the commission/reduction

total

The total amount on the invoice after VAT, taxes, and commissions/reductions

commission

These parameters affect the Commission/Reduction row listed below the breakdown of services and transaction fees.

title

The name of the Commission/Reduction row

amount

The amount of the commission/reduction

vat

The VAT on the commission/reduction

tax

This parameter affects the Tax row listed below the breakdown of services and transaction fees

amount

The tax amount

vat

This parameter affects the VAT row listed below the breakdown of services and transaction fees

amount

The VAT amount

netToRemit

This parameter affects the Net to Remit row.

pfileReceiptsTotalAmount

The total receipts in the travel file (both receipts and transfer-receipts).

total

The total amount after VAT, taxes and commissions/reductions are deducted.

fare

The total amount before VAT, taxes and commissions/reductions are deducted.

vat

The total VAT on the transactions and transaction fees

tax

The total taxes on the transactions and transaction fees

comm

The commission/reduction on the transactions and transaction fees

commPlusVatOnComm

The total commission/reduction amount + the VAT on the commission/reduction

vatOnCommission

The VAT on the commission/reduction

totalOfAllRows

The total net amount on the invoice

additionalInfo

This parameter affect the additional information displayed below the transactions and transaction fees.

equivalentSys

The invoice amount in the system currency

rateOfExchange

The currency exchange rate on the invoice

depositPaid

The paid amount on the invoice

partialPaid

The amount that is left to pay

depositAmount

The deposit amount (when using deposits)

noDepositRemittance

The total to remit when there is no deposit and no paid amount and the Print Deposit option is selected.

reconciledInvoice

The credit invoice which is reconciled with this invoice

employeeID

This information is returned as UDID from the GDS.

The employee ID with the travel agent/corporate client

employeeIDTitle

This information is returned as UDID from the GDS.

The name of the EmployeeID field with the travel agent/corporate client

additionalInfo/partialPaidDueDate

The invoice due date

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

additionalInfo/depositDueDate

When using deposits, the date by which the deposit needs to be paid

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

additionalInfo/depositValueDate

When using deposits, the value date of the deposit (the date when payment is made).

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

additionalInfo/noDepositValueDate

The due date when there is no deposit and no paid amount, and the Print Deposit option is selected.

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

additionalInfo/optionDate

The travel file option date

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

additionalInfo/vatRemarks/remark

When working with VAT tables, the VAT codes

code

The VAT code

text

The remark for the VAT code

additionalInfo/budget

This is a UDID remark returned from the GDS

title

The name of the budget field

number

The number returned from the GDS

additionalInfo/costCenter

This is a UDID remark returned from the GDS

title

The name of the Cost Center field

value

The value returned from the GDS

additionalInfo/projectNumber

This is a UDID remark returned from the GDS

title

The name of the Project Number field

value

The value returned from the GDS

additionalInfo/orderNumber

This is a UDID remark returned from the GDS

title

The name of the Order Number field

value

The value returned from the GDS

additionalInfo/referenceNumber1

This is a UDID remark returned from the GDS

title

The name of the Reference Number 1 field

value

The value returned from the GDS

additionalInfo/remark1

This is a UDID remark returned from the GDS

title

The name of the Remark1 2 field

value

The value returned from the GDS

additionalInfo/remark2

This is a UDID remark returned from the GDS

title

The name of the Remark2 field

value

The value returned from the GDS

remarks

These parameters affect the invoice remarks

title

The title of the remarks section

title @ dirClass

The direction of the remark (left to right or right to left)

text

The text of the remark

remarks/docRemarks

 

item

The remark text

item @ dirClass

The direction of the remark (left to right or right to left)

coveringDocs

These parameters affect the covering documents on the invoice

coveringDocs @ leftToPay

The left to pay amount on the invoice

coveringDocs/Doc

 

text

The details of the document covering the invoice

coveringDocs/doc/issueDate

 

yearFull

The year in four digits (for example, 2016)

year

The year in two digits (for example, 16)

month3

The month in three letters (for example, Mar)

month

The numerical value of the month (for example, 03)

day

The day in the month

hour24

The hour using a 24 clock (for example, 15)

hour

The hour using a 12 hour clock (for example, 03)

minute

The minutes

footer

The invoice footer

issuedBy

The user who issued the invoice

note

The invoice footer note

officeBrandDetails

The branding details of the travel company or branch