Travel Credit
This resource represents a travel credit.
Fields
Name |
Type |
Description |
id read-only |
String |
|
href read-only |
Field |
|
type required |
Choice |
The type slug for this travel_credit which will be one of the following values:
* GIFT_CERTIFICATE
* LIFETIME_DEPOSIT
* TRAVEL_CREDIT |
booking_company read-only |
Reference Object |
The booking_company associated to this travel_credit. |
code required |
String |
The code (readable value) for this travel_credit. This _may_ in the be used as a means to apply the credit, although the primary method will be to use the id field. |
date_created |
Datetime |
The time when the resource was created, in the standard Dates & Times. |
expiry_date required |
Datetime |
The date this travel_credit expires.
NOTE: Travel Credits with type value GIFT_CERTIFCATE or LIFETIME_DEPOSIT do NOT expire, and this will have a null value.
|
amount required |
Decimal |
The price value of this travel_credit. |
currency required |
String |
The currency ISO code, in the standard Currencies & Prices. |
applied required |
Boolean |
Boolean (true/false ) field indicating if this travel_credit has already been applied. |
commissionable required |
Boolean |
Boolean (true/false ) field indicating if this travel_credit can generate a commission. |
date_applied required |
Datetime |
The datetime this travel_credit was applied to a Booking |
booking_applied read-only |
Reference Object |
The booking to which this travel_credit is applied. |
booking_issued read-only |
Reference Object |
The booking for which this travel_credit was issued. |
service_issued read-only |
Reference Object |
The Service to which this travel_credit was issued. It can refer to any of the *_services resources, except for fee_services and insurance_services . |
customer read-only |
Reference Object |
The customer to whom this travel_credit is issued. |
agency read-only |
Reference Object |
The agency to which this credit’s customer belongs. |
Get a Travel Credit
-
GET /travel_credits/(string: nationality_id)