GET api/v1/Vouchers?AccountCode={AccountCode}&fromCreateDate={fromCreateDate}&toCreateDate={toCreateDate}
Retrieves a list of vouchers which were created between given dates for given account
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
AccountCode |
Account under which the vouchers exist. Mandatory |
string |
Default value is Empty |
fromCreateDate |
The create time of the voucher is later than this (in UTC). Mandatory |
string |
Default value is Empty |
toCreateDate |
The create time of the voucher is earlier than this (in UTC). Mandatory |
string |
Default value is Empty |
Body Parameters
None.
Response Information
Resource Description
A list of vouchers matching the search criteria. If no vouchers are found, an empty list is returned
Collection of VoucherName | Description | Type | Additional information |
---|---|---|---|
Partner |
The partner associated with this voucher |
Partner |
None. |
Clients |
The clients this voucher is associated with |
Collection of Client |
None. |
ConfigurationName |
Name of the configuration the voucher should be part of |
string |
None. |
Code |
The unique voucher code |
string |
None. |
IsEnabled |
Whether the voucher is enabled |
boolean |
None. |
ValidFrom |
The date the voucher is valid from (inclusive) / Voucher cannot be used before this date |
date |
None. |
ValidTo |
The date the voucher is valid until (inclusive) / Voucher cannot be used after this date |
date |
None. |
PickupAvailableFrom |
The booking has to start after this date (inclusive) |
date |
None. |
PickupAvailableTo |
The booking has to start before this date (inclusive) |
date |
None. |
PaymentType |
How payment should be handled when using the voucher (eg. credit card, voucher only, etc) |
string |
None. |
TermsAndConditions |
Terms and Conditions of voucher use |
string |
None. |
RemainingUsages |
The remaining number of times the voucher may be used, or -1 for unlimited |
integer |
None. |
MaximumUsages |
Maximum number of times the voucher may be used, or -1 for unlimited |
integer |
None. |
DiscountPercent |
A discount in percent that this voucher will enable. 0 if no discount |
decimal number |
None. |
DiscountAmount |
A discount in monetary terms that this voucher will enable. 0 if no discount |
decimal number |
None. |
Attributes |
A dictionary of custom attributes for the voucher. To pre-populate fields when booking, you can use the following attributes: CardHolderCountryID: Country ID for the passenger (for visa vouchers only).; VBook field values: BookerName: Name of booker; BookerEmail: Email of booker; BookerIsPax: Set booker details as passenger details; CardHolderName: Passenger name; CardHolderEmail: Passenger email; CardHolderPhoneNumber: Passenger phone number; PaxTotalNumber: Total number of passengers(max value depends on vehicle); PaxSignboard: Passenger signboard; TransportationType: Flight, Train, Other; FlightDateTime: Date of flight; IsArrival: Is arrival flight; FlightNumber: Flight number; AirportCode: Airport code used to pick up / drop off passenger; AddressLine: Address line used to pick up / drop off passenger; VehicleCategory : Select chosen vehicle category.Business, First Class, etc.; |
Dictionary of string [key] and string [value] |
None. |
LogoURL |
File path of the logo used for the voucher campaign. |
string |
None. |
GroupBookingName |
Name of the group booking selected in the voucher config. |
string |
None. |
BrandName |
Name of the brand associated with the voucher campaign. |
string |
None. |
NewBookingCutOff |
Cut-off time (in hours) for new bookings. |
integer |
None. |
ModifyBookingCutoff |
Cut-off time (in hours) for modifying bookings. |
integer |
None. |
Status |
Voucher Status (See ) |
string |
None. |
VehicleName |
Vehicle ID on the config. It will have a value when the payment type is 'Funded Base Rate'. |
string |
None. |
AlwaysShowPrice |
If Always Show Price is set on the voucher config then prices will always show when quoting on VBook even if using a payment type where no payment is needed like voucher |
boolean |
None. |
AlwaysRequirePaymentDetails |
If set, we must collect payment details from the booker even if there is no outstanding excess. |
boolean |
None. |
ExtRefID |
An external reference provided by you returned to you. This should not be visible to the end user and only serves the purpose to link up different system. |
string |
None. |
Response Formats
application/json, text/json
[ { "partner": { "name": "sample string 1", "address": { "airportCode": "sample string 1", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "postcode": "sample string 5", "city": "sample string 6", "country": "sample string 7", "state": "sample string 8", "longitude": 9.1, "latitude": 10.1, "postalAddress": "sample string 11", "googlePlaceID": "sample string 12", "googleUserInputAddress": "sample string 13", "locationType": "sample string 14" }, "email": "sample string 2", "websiteURL": "sample string 3", "bookingWebsiteURL": "sample string 4", "notesToBooker": "sample string 5", "notes": "sample string 6", "phone": "sample string 7" }, "clients": [ { "accountCode": 1, "name": "sample string 2", "address": { "airportCode": "sample string 1", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "postcode": "sample string 5", "city": "sample string 6", "country": "sample string 7", "state": "sample string 8", "longitude": 9.1, "latitude": 10.1, "postalAddress": "sample string 11", "googlePlaceID": "sample string 12", "googleUserInputAddress": "sample string 13", "locationType": "sample string 14" }, "phone": "sample string 3", "email": "sample string 4", "logoUrl": "sample string 5", "language": "sample string 6", "settings": { "sample string 1": {}, "sample string 3": {} }, "userDefinedFields": [ { "name": "sample string 1", "required": true }, { "name": "sample string 1", "required": true } ] }, { "accountCode": 1, "name": "sample string 2", "address": { "airportCode": "sample string 1", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "postcode": "sample string 5", "city": "sample string 6", "country": "sample string 7", "state": "sample string 8", "longitude": 9.1, "latitude": 10.1, "postalAddress": "sample string 11", "googlePlaceID": "sample string 12", "googleUserInputAddress": "sample string 13", "locationType": "sample string 14" }, "phone": "sample string 3", "email": "sample string 4", "logoUrl": "sample string 5", "language": "sample string 6", "settings": { "sample string 1": {}, "sample string 3": {} }, "userDefinedFields": [ { "name": "sample string 1", "required": true }, { "name": "sample string 1", "required": true } ] } ], "configurationName": "sample string 1", "code": "sample string 2", "isEnabled": true, "validFrom": "2024-12-05T07:44:58.6551569+00:00", "validTo": "2024-12-05T07:44:58.6551569+00:00", "pickupAvailableFrom": "2024-12-05T07:44:58.6551569+00:00", "pickupAvailableTo": "2024-12-05T07:44:58.6551569+00:00", "paymentType": "sample string 8", "termsAndConditions": "sample string 9", "remainingUsages": 10, "maximumUsages": 11, "discountPercent": 12.0, "discountAmount": 13.0, "attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "logoURL": "sample string 14", "groupBookingName": "sample string 15", "brandName": "sample string 16", "newBookingCutOff": 17, "modifyBookingCutoff": 18, "status": "sample string 19", "vehicleName": "sample string 20", "alwaysShowPrice": true, "alwaysRequirePaymentDetails": true, "extRefID": "sample string 23" }, { "partner": { "name": "sample string 1", "address": { "airportCode": "sample string 1", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "postcode": "sample string 5", "city": "sample string 6", "country": "sample string 7", "state": "sample string 8", "longitude": 9.1, "latitude": 10.1, "postalAddress": "sample string 11", "googlePlaceID": "sample string 12", "googleUserInputAddress": "sample string 13", "locationType": "sample string 14" }, "email": "sample string 2", "websiteURL": "sample string 3", "bookingWebsiteURL": "sample string 4", "notesToBooker": "sample string 5", "notes": "sample string 6", "phone": "sample string 7" }, "clients": [ { "accountCode": 1, "name": "sample string 2", "address": { "airportCode": "sample string 1", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "postcode": "sample string 5", "city": "sample string 6", "country": "sample string 7", "state": "sample string 8", "longitude": 9.1, "latitude": 10.1, "postalAddress": "sample string 11", "googlePlaceID": "sample string 12", "googleUserInputAddress": "sample string 13", "locationType": "sample string 14" }, "phone": "sample string 3", "email": "sample string 4", "logoUrl": "sample string 5", "language": "sample string 6", "settings": { "sample string 1": {}, "sample string 3": {} }, "userDefinedFields": [ { "name": "sample string 1", "required": true }, { "name": "sample string 1", "required": true } ] }, { "accountCode": 1, "name": "sample string 2", "address": { "airportCode": "sample string 1", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "postcode": "sample string 5", "city": "sample string 6", "country": "sample string 7", "state": "sample string 8", "longitude": 9.1, "latitude": 10.1, "postalAddress": "sample string 11", "googlePlaceID": "sample string 12", "googleUserInputAddress": "sample string 13", "locationType": "sample string 14" }, "phone": "sample string 3", "email": "sample string 4", "logoUrl": "sample string 5", "language": "sample string 6", "settings": { "sample string 1": {}, "sample string 3": {} }, "userDefinedFields": [ { "name": "sample string 1", "required": true }, { "name": "sample string 1", "required": true } ] } ], "configurationName": "sample string 1", "code": "sample string 2", "isEnabled": true, "validFrom": "2024-12-05T07:44:58.6551569+00:00", "validTo": "2024-12-05T07:44:58.6551569+00:00", "pickupAvailableFrom": "2024-12-05T07:44:58.6551569+00:00", "pickupAvailableTo": "2024-12-05T07:44:58.6551569+00:00", "paymentType": "sample string 8", "termsAndConditions": "sample string 9", "remainingUsages": 10, "maximumUsages": 11, "discountPercent": 12.0, "discountAmount": 13.0, "attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "logoURL": "sample string 14", "groupBookingName": "sample string 15", "brandName": "sample string 16", "newBookingCutOff": 17, "modifyBookingCutoff": 18, "status": "sample string 19", "vehicleName": "sample string 20", "alwaysShowPrice": true, "alwaysRequirePaymentDetails": true, "extRefID": "sample string 23" } ]