Maxxton External API

Sections

Get details for a reservation

Header Parameters

localestring

The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc.

Query Parameters

returnAllInclusiveBillboolean

The all inclusive bill details will be returned when the value is set to true

returnSectionsarray

List of constant strings to return only the selected sections in the response. The possible values are : AGENTBILL - Fetch agent billing details for reservations, CUSTOMER - Retrieve customer details of the reservation, PAYING_CUSTOMER - Retrieve details of the paying customer, CUSTOMERBILL - Fetch customer billing details for reservations, CUSTOMERSTATUS - Fetch the current status of the customer, EMERGENCYCONTACTS - Retrieve emergency contact information, INFOTEXTS - Fetch infotexts ...

Enum values:
AGENTBILLCUSTOMERPAYING_CUSTOMERCUSTOMERBILLCUSTOMERSTATUSEMERGENCYCONTACTSINFOTEXTSINSTALMENTSRESERVEDRESOURCESCUSTOMFIELDS
... 6 other enums
Allow unique items
true

Path Parameters

reservationIdinteger Required

The identifier of the reservation.

Response

200
Object
The request is completed successfully without any errors

Response Attributes

locationIdinteger
externalBookingReferencestring
distributionChannelIdinteger
distributionChannelCodestring
reservationCategoryIdinteger
categoryCodestring
reservationDatestring
parentIdinteger
arrivalDatestring
reservationIdinteger
reservationNumberstring
tncSignedDatestring
tncSignedboolean
tncSigneeCustomerNamestring
cancelDatestring
customerobject

Show child attributes

payingCustomerobject

Show child attributes

modifiedDatestring
supplierBookingReferencestring
departureDatestring
statusinteger
typestring
Enum values:
INVOICERESERVATIONALLOTMENTCASHLINEAR
resellerIdinteger

Reseller Id if reservation is made by reseller

reservedResourcesarray

Show child attributes

reservationSubjectsarray

Show child attributes

infotextsarray

Show child attributes

customerBillarray

Show child attributes

agentBillarray

Show child attributes

payingCustomerBillarray

Show child attributes

instalmentsarray

Show child attributes

emergencyContactsarray

Show child attributes

paymentMethodsarray

Show child attributes

activitiesarray

Show child attributes

expectedArrivalDateTimestring
expectedDepartureDateTimestring
validationStatusIdinteger
statusValuestring
Enum values:
PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL
... 7 other enums
sendMethodIdinteger
employeeIdinteger
currencyIdinteger
currencyCodestring
previousPmsIdinteger
paymentTermSetIdinteger
voucherstring
vouchersarray

List of Special Vouchers redeemed for reservation.

readOnly

Show child attributes

reservationKindstring

Possible values for reservation kind ACCOMMODATION_RESERVATION("acco"), ADDON_RESERVATION("addon"), GROUP_RESERVATION("group")

Enum values:
ACCOMMODATION_RESERVATIONADDON_RESERVATIONGROUP_RESERVATION
customerStatusobject

Show child attributes

404
Object
No reservation found for given reservation id.
500
Object
Error occurred while fetching this reservation

GET

/

Select
1

Response