Maxxton External API

Sections

Creates a reservation proposal comparison

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

returnBillboolean

The reservation bill will be returned when the value is set to true

Default value
false
returnPaymentOptionsboolean

This parameter will provide all possible payment term sets available, including the instalments for the provided criteria. The payment term set id can be provided in the “paymenttermsetid“ in the request to use the payment option. In case no payment option is set, it will take the one with the highest priority.

Default value
false
returnReservedResourcesboolean

The reserved resources will fetched when set to true

Default value
false
returnUnitsboolean

The available units be returned when the value is set to true

Default value
false

Body Parameters

distributionChannelCodestring Required

Unique code of distribution-channel.

categoryCodestring Required

Unique code of reservation-category.

customerIdinteger
accommodationTypesarray Required

It contains the details of the accommodationtype for which the reservation is made.

Show child attributes

rateTypeIdinteger

Unique id of the rate types for which the cashflow is applicable.

paymentTermSetIdinteger

Response

200
Object
The request is completed successfully without any errors

Response Attributes

arrivalDatestring

The date on which customer/guest will arrive.

departureDatestring

The date on which customer/guest will leave the accommodation.

currencyCodestring

Unique code representing the currency in which the reservation payment is done.

accommodationTypeobject

Represents the accommodation type details for which the reservation proposals are being compared.

Show child attributes

comparisonarray

List of reservation proposals with billing and offer info that are being compared

Show child attributes

preBookingboolean

Indicates whether the reservation proposals are in pre-booking state.

locationInfotextsarray

Show child attributes

500
Object
Error occurred while fetching reservation proposal

POST

/

Select
1

Response