Fee Services¶
A FeeService is and administrative service that cannot be booked and has no underlying product. A negative regular_price value on this resource represents a booking credit for that value.
XML Schema:
GET: Get a Fee Service
Fields
Name |
Type |
Description |
---|---|---|
id read-only |
String |
|
href read-only |
Field |
|
name read-only |
String |
The name of this service. |
status |
String |
The current status of the service:
Active service status transitions:
|
status_transitions read-only |
List |
A list of status values to which this service can transition. |
type read-only |
String |
The type of this resource. |
sub_type read-only |
String |
A brief description of this service type. |
start_date read-only |
Date |
The start date of this service. |
finish_date read-only |
Date |
The finish date of this service. |
customers |
Field |
|
|
String |
|
|
Field |
|
|
Nested Object |
|
|
String |
Legal first name as it appears on a passport. |
|
String |
Legal middle name as it appears on a passport. |
|
String |
Legal last name as it appears on a passport. |
|
String |
The name this person likes to be called if different from their legal name. |
|
String |
The title. Valid values are: Mr, Mrs, Ms, and Miss |
date_created read-only |
Datetime |
The date/time this service was created, in the standard Dates & Times. |
date_confirmed read-only |
Datetime |
The date/time this service had its service status set to Confirmed, in the standard Dates & Times. |
date_cancelled read-only |
Datetime |
The date/time this service had its service status set to Cancelled, in the standard Dates & Times. |
option_expiry_date read-only |
Datetime |
The date/time when an Option service status will automatically be set to Expired, in the standard Dates & Times. |
purchase_price read-only |
Decimal |
The currency-specific purchase price this service was Confirmed at, in the standard Currencies & Prices. The price reflected includes any promotions applied. The price is not locked until the service has its service status set to Confirmed (i.e. the price could change when the service status is on Option). |
commission read-only |
Decimal |
The currency-specific commission amount that the booking agent will receive for this service, in the standard Currencies & Prices. |
applied_promotion |
Nested Object |
|
|
String |
|
|
Field |
|
|
String |
The name of the promotion used. |
|
String |
A unique code for this promotion. |
|
Decimal |
The currency-specific amount that has been discounted from the purchase_price. Add the discount_amount and purchase_price to see the original non-discounted price. |
|
Integer |
The commission rate for this promotion. |
|
String |
|
flags read-only |
List |
A list of codes that, when present, require special considerations for a booked service. The list of departure service flags related to the current status of a request to hike the Inca Trail, or the option booked for services on these special departures: Service Status Flags
Inca Trail Flags
|
booking read-only |
Reference Object |
|
documents read-only |
Field |
|
|
String |
|
|
Field |
|
|
Datetime |
The time when the resource was created, in the standard Dates & Times. |
|
String |
The document type, currently: INVOICE, ATOL_CERTIFICATE, VOUCHER. |
|
String |
The intended audience of this document. Either |
|
Reference Object |
The related booking resource. |
|
String |
The Internet media type. |
declined_reason read-only |
Reference Object |
The related declined reason resource. |
description |
String |
A brief description of the fee |
related_service read-only |
Reference Object |
|
product read-only |
Reference Object |
A reference to the fee resource for this service |
Get a Fee Service¶
- GET /fee_services/(string: service_id)/¶