Documentation

Voucher Generation


There is no specific request in order to generate the voucher, as a part of APITUDE for Activities documentation to help understanding how and when to build a voucher including barcodes, specific images or any other requirement needed to build a voucher that enables the final customer to enjoy an activity.


In most of the cases you’ll be generating the voucher with you custom template using the provided data at confirmation response, but some cases will return a “voucher array”, for those cases, you don’t need to generate any and instead provide one of the URL returned in the array.

In case at confirmation response the voucher array URL is not null, it is mandatory to provide one of the returned HB generated voucher.

For those cases, generating your own and providing to final customers will cause operational issues as if we return an voucher URL is because it has an specific provider information such as QR, barcode or any other custom provider identification method.


The following table explains when it’s possible to build your own voucher and when you must deliver the HB generated voucher to your final customer:

Response

Provide one of the PDF in voucher array

Generate your own

Voucher array is NOT null (PDF + Html returned)

Yes

No

Voucher array is null/not present

No

Yes



Mandatory data for generated vouchers:

-Reference number | Found in “BOOKINGCreate.booking.reference”

-Full name of the excursion or ticket | “BOOKINGCreate.booking.activities[x].name”

-Modality name | “BOOKINGCreate.booking.activities[x].modality.name”

-Date in which the booking was confirmed | “BOOKINGCreate.booking.creationDate”

-Lead pax name | “BOOKINGCreate.holder”

-From and to for the excursion or ticket | FROM -> “BOOKINGCreate.booking.activities[x].dateFrom” TO -> “BOOKINGCreate.booking.activities[x].dateTo”

-Pax distribution | “BOOKINGCreate.booking.activities[x].paxes”

-Children ages | (if (BOOKINGCreate.booking.activities[x].paxes[X].paxType) < 18 ) must show “BOOKINGCreate.booking.activities[x].paxes[x].age”

-Destination (of confirmed activity) | “BOOKINGCreate.booking.activities[x].contactInfo.country.destinations[x].name”

-Remarks | “BOOKINGCreate.booking.activities[x].comments[x].text” (TYPE ="CONTRACT_REMARKS")

-Provider | “BOOKINGCreate.booking.activities[x].providerInformation”

-Bookable and payable | “BOOKINGCreate.booking.activities[x].supplier” Bookable and payable thru “BOOKINGCreate.booking.activities[x].supplier.name” with VAT “BOOKINGCreate.booking.activities[x].supplier.vatNumber”

See visual example: