Maxxton

Maxxton External API

1. Overview

The document comprises RESTful web services which refers to the methods (GET, POST, PUT, DELETE), endpoints of the APIs, required fields and explains what services consumes and produces.
It also tells what data is to be sent in request body and what will be returned in response body.
The dates that are being entered along with time depicts the UTC time zone and the one without time represents just that day.

1.1. Version information

Version :1.0

1.2. Contact information

Contact : Maxxton Group
Contact Email : api@maxxton.com

1.3. URI scheme

Host : Test: https://api-test.maxxton.net , Production: https://api.maxxton.net
BasePath : /maxxton/v1
Schemes : HTTPS

1.4. Tags

  • Accommodation Types : A group of similar units

  • AddOn : Extras and products that can be booked with an accommodation type

  • AdminOrganisation : List of AdminOrganisation

  • Allotment : Guaranteed availability for a specific distribution channel

  • Amenity : Features or facilities available on a resort or an accommodation type

  • Authentication : Authentication

  • Brands : Different labels used for marketing of an accommodation type

  • Cash Clearance : Informations related to cash reservations and company.

  • Contracts : Formal legal agreement between the owner and the resort

  • Countries : List of countries.

  • Currency : List of currencies

  • Customer Status : Statuses given to customers as per customer’s reservation history

  • Customers : Guest who can book reservations

  • DistributionChannels : Channel through which reservations can be booked

  • Employee : Employees

  • Events : Events occurred in the system due to modifications of the entities

  • Facilities : Different labels used for facilities

  • Groups : Grouping different kind of entities

  • Housekeeping : Information related to housekeeping

  • Icals : Icals

  • Infotexts : Information related to all the infotexts.

  • Languages : Available languages in the system

  • Ledgers : Ledgers

  • Locks : Locks

  • Memos : Informative text on different entities

  • Offer : Discounts or special offers on accommodations

  • Operations : Operations

  • Owners : Someone who owns an accommodation

  • Packages : Packages

  • Payment Term Set : Informations related to payment term sets.

  • PointsOfInterests : PointsOfInterests

  • PredefinedMemo : Informative text on different entities

  • Rate Types : A group of different prices of an accommodation type

  • Region : Defines region on a map

  • Rentability : Possible arrival and departure days

  • Representation : Defines accommodation type configuration valid for a distribution channel

  • Resellers : Agent who are selling accommodation types

  • Reservability : Number of units available

  • Reservations : Customer booking of an accommodation

  • Resorts : Group of accommodation types at the same location

  • Room types : Defines type of room in an unit

  • Rooms : Defines a room in an unit

  • Send Methods : Send methods of reservation

  • Subjects : Subjects for accommodation types

  • Units : Physical accommodation where customer stays

1.5. Authentication

Maxxton External APIs are secure RESTful web services and authentication(OAuth2) is required to access them, user will be authenticated based on the token passed in the request.

1.5.1. Endpoint used to generate access token

POST /maxxton/v1/authenticate?grant_type=client_credentials&client_id={api username}&client_secret={api key}&scope={concern code}
Parameters
Name Description

grant_type

Authentication type, this is 'client_credentials' for API.

concern

3 letter code which specifies the environment used, usually an abbreviation of the clients name(deprecated in favor of scope).

scope

3 letter code which specifies the environment used, usually an abbreviation of the clients name(this can be found in the Maxxton software URL).

client_id

The unique client identifier to access the API. This can be found in the Maxxton software backoffice where API users are configured.

client_secret

The secret associated with client id to access the API. This can be found in the Maxxton software backoffice where API users are configured.

The response that can be returned are:

Responses
HTTP Code Description

500

Error occurred while processing

200

OK. Access token is generated which is used for further calls to authenticate.

After generating the token, the access token can be used by adding it to the header parameters with
key: Authorization and value: {token_type} {access_token}

  • The client_id and the client_secret will be provided by Maxxton/Maxxton client as part of API credentials.

  • Please contact the particular Maxxton client to request API credentials to access their Maxxton environment and data.

  • Concern or scope can be used for passing the concern parameter but scope is preferred as it is fully oauth2 compatible.

Note: Either of the two parameters i.e Concern or Scope is mandatory.

For more information: Login

1.6. API Pricing

The API costs are based on the number of requests per month, the first 750,000 requests per month(25,000 requests per day) are not charged. Subsequent requests are charged as per the API price calculator. The processes can be speeded up by making multiple API requests at the same time, this is called concurrent calls in the model. Concurrent calls have a bigger impact on the Maxxton API resources, therefore extra costs are charged.

Estimate standard API costs based on usage.

Requests per day Requests per month

0

Free

per
day
month * based on a 30 day month

1.6.1. Notes applicable to the API Pricing

  • The number of concurrent calls is limited to the maximum number per IP, by default this is 15.

  • The number of concurrent calls will be used as a logarithmic parameter in the pay-per-use model and will impact the charges on actual usage.

  • The number of requests is not limited and will be charged based on actual usage.

  • Costs only apply to the new Maxxton REST API.

  • The number of requests only applies to the production API (api.maxxton.net).

  • The acceptance (api-test.maxxton.net) API can be used free of charge, subject to adherence to the fair use policy.

  • Fair use policy applies to both production and acceptance API.

  • API Support is included for daily support questions

  • Development of new features and project guidance/management is charged per hour.

  • Clients can request new features to decrease the REST API usage. Maxxton will, commercially reasonable, develop new features on request to decrease API usage.

1.6.2. Fair Use Policy

On our API we do not have a fixed restriction on the number of api calls. However, a Fair Use Policy applies to the usage of the API.

Normal usage is permitted. Excessive usage is not permitted. Excessive usage means, the usage which has an impact on our server performance or impact on other customers who use the API.

1.7. Filtering

Many calls contain filtering, this is a way to filter the output of the calls. In swagger(url can be found in documentation) it says filter parameter where this can be used. filtering means you can filter on any non-nested field in the output with the following features:

Definition Symbol Usage Result

Equals

:

?filter=name:bob

Selects all the records where the name contains the String bob.

Strict Equals

::

?filter=name::bob

Selects all the records where the name is strictly equals to bob.

Not Equals

!:

?filter=name!:bob

Selects all the records where the name is not equal to bob.

Greater Than

>

?filter=age>30

Selects all the records where the age is greater than 30.

Greater Than Equals

>:

?filter=age>:30

Selects all the records where the age is greater than or equal to 30.

Less Than

<

?filter=age<30

Selects all the records where the age is less than 30.

Less Than Equals

<:

?filter=age <: 30

Selects all the records where the age is less than or equal to 30.

These are the operators you can use in the filtering of the filter:

Definition Symbol Usage Result

Chain multiple filters (OR)

||

?filter=name:Bob||age=30

Selects all the records where name is Bob or age is 30.

Creating a single filter or chain multiple(AND)

&

?filter=name:Bob&filter=age:30

Selects all the records where name is Bob and age is 30.

1.8. Pagination

Pagination is used to divide large response into small response which leads minimizing the response time. General concept is separating a large page into small pages.
Most of the Maxxton External API endpoints follow pagination
You can control the number of results returned in a single request by specifying the page number and page size.
Page and Size are 2 request parameters that can be used with request to control pagination.

Name Description

page

Default page is 0, Page can be used to extract response of specific page.

size

Default size is 20, Size can be used to extract required no of elements per specific page.

With every response, there are few parameters in response that gives information about the pagination followed in request.

size Size value considered for request

number

Page no considered for request

numberOfElements

No of elements fetched in the response

totalElements

Total no of elements that can be fetched

totalPages

Total no of pages that can be requested

first

True if its a first page, else False

last

True if its a last page, else False

1.9. Sorting

Sorting is used to order the response based on the values of a particular field of the response. General concept is fetching a page/list of response in the ascending or descending order of the specified field.
Sorting is possible in all the endpoints where pagination is supported.

This can be done by specifying the sort request parameter with the field name and order of descending, as follows:
sort=fieldname,desc or sort=fieldname,asc

Name Description

sort

Default sorting is asc if only sort=fieldname is used, orders the response based on a particular field of the response.

With every sorted response, there are few parameters under the section sort at the end of page that gives information about the sorting followed in request.

direction The order of the sorting. ASC for ascending or DESC for descending

property

the fieldname in the response whose value was used for sorting the response

ignoreCase

whether casing of alphanumberic values was considered in sorting in case of string fields

nullHandling

enumeration for null handling hints that can be used in the sorting. typical values are NATIVE, NULLS_FIRST or NULLS_LAST

ascending

True if sorting was ascending, else False

descending

True if sorting was descending, else False

1.10. Date Fields

Following is the description of different date fields used in various domains of API endpoints.

Name Description

reservationDate

date the guest creates the reservation.

arrivalDate

date the guest arrives.

departureDate

date the guest leaves.

stayDateFrom

start of period within a period of the reservation(between and including arrival and departure date).

stayDateTo

end of period within a period of the reservation(between and including arrival and departure date).

1.11. Header

Header parameters contain information that are an important part of the API request and response as they represent the meta-data associated with the API request and response.
Following header parameters can be used with Maxxton APIs:

Name Description Example

locale

This header can be passed in the request to filter all the translations in the response in any specific language. The user can pass the language code as value of the locale header to filter the translations. The value of the locale header can also be passed in the following format "en_US" (language code followed by country code).

locale=en
OR
locale=en_US

x-show-archived

This header can be used to get archived data in the response. The user can pass "true" as value of the header to view the archived data in the response and if the value of this header is passed as "false" then the archived data is not displayed in the response.

x-show-archived=true
OR
x-show-archived=false

1.12. Error Codes

Following error codes are available in response of Maxxton APIs:

Error Code Description HTTP Status

ThirdParty-101

Resource not found

404

ThirdParty-102

Unit not found

404

ThirdParty-103

Locks not found

404

ThirdParty-104

Unable to load addresses

500

ThirdParty-105

Offer is not found

404

ThirdParty-107

Distribution channel id is not valid or is null

400

ThirdParty-108

Manager id is not found.

400

ThirdParty-109

Accommodation type is not found

404

ThirdParty-110

Representation is not found

404

ThirdParty-111

add-ons is not found

404

ThirdParty-112

Group type is not correct.

400

ThirdParty-113

Wrong input

400

ThirdParty-114

Unable to generate or use property descriptor for field

500

ThirdParty-115

Resort not found

404

ThirdParty-116

Unable to filter translation

500

ThirdParty-117

Year paramater is missing

400

ThirdParty-118

Configuration is missing

500

ThirdParty-122

The category code does not exist or not equivalent to the token reservation category or not linked with input distribution channel

400

ThirdParty-123

The distribution channel code does not exist or null

400

ThirdParty-124

The subject does not exist with subjectId or null

400

ThirdParty-125

The resource does not exist with resourceId

400

ThirdParty-126

Customer details not provided.

400

ThirdParty-127

There is no availability for the given criteria

400

ThirdParty-128

Status should be QUOTATION or OPTIONAL

400

ThirdParty-129

The request has an incorrect body

400

ThirdParty-130

Reservation does not exist.

404

ThirdParty-131

Rate type does not exist or null.

404

ThirdParty-132

No default rate type is selected for given distribution channel.

404

ThirdParty-133

You are not allowed to create reservation with given distribution channel code.

400

ThirdParty-134

The header IF_MODIFIED_SINCE is missing.

400

ThirdParty-135

Internal server error occurred.

500

ThirdParty-136

Missing or invalid parameter

400

ThirdParty-137

Reservation category not found.

404

ThirdParty-138

Accommodation does not exists.

404

ThirdParty-139

Invalid subject

400

ThirdParty-140

Property preference not found.

400

ThirdParty-141

No choice found for the given criteria.

400

ThirdParty-142

No customer found for the customer id

400

ThirdParty-143

No modified records found.

404

ThirdParty-144

start/end date should not be null and startDate should be less than endDate and the period should be in between reservation period.

400

ThirdParty-145

Additions not found.

400

ThirdParty-146

Quantity should not be null, less than or equal to 0.

400

ThirdParty-147

Unable to retrieve turnover for the reservation

404

ThirdParty-148

The unit does not exist with unitId.

400

ThirdParty-149

The given addition criteria does not match or addition’s show moment is incorrect.

400

ThirdParty-150

Accommodation not available.

400

ThirdParty-151

Distribution channel code is not valid or is null

400

ThirdParty-152

Section parameters are invalid in batch request

400

ThirdParty-153

Capacities are not configured on accommodationtype.

404

ThirdParty-154

The incorrect format of input parameter.

400

ThirdParty-155

The quantiy and price should not be passed with unitId

400

ThirdParty-156

Resource quantity is not valid or can not be changable

400

ThirdParty-157

Reservation can not be updated because of some internal error

400

ThirdParty-158

The header IF_MODIFIED_SINCE is incorrect.

400

ThirdParty-159

The date in IF_MODIFIED_SINCE should not be greater than current date

400

ThirdParty-160

Modify the time stamp format. Should be : EEE, dd MMM yyyy HH:mm:ss

400

ThirdParty-161

No currency found for the currency id

404

ThirdParty-162

Concern or scope not found

400

ThirdParty-163

Required parameter is missing in new-reservation customer request body

400

ThirdParty-164

Language not available for Locale or Locale is incorrect

400

ThirdParty-165

Invalid region id

404

ThirdParty-166

Brand not found

404

ThirdParty-167

start/end or actual start/end date can not be update for the reserved resource

400

ThirdParty-168

Invalid ownerId

404

ThirdParty-169

The distribution channel does not exist

404

ThirdParty-170

No data found

404

ThirdParty-171

Invalid ownerGroupId

404

ThirdParty-172

Requested page size is invalid

400

ThirdParty-173

Invalid memoCategoryId

400

ThirdParty-174

Seasonality not found

404

ThirdParty-175

Either Fiscal year or startDate/endDate allowed

400

ThirdParty-176

Resource type is invalid

400

ThirdParty-177

the url passed is invalid

400

ThirdParty-178

Given fiscal year is not configured

400

ThirdParty-179

Update reservation request has invalid reservation status

400

ThirdParty-180

Payer type is invalid

400

ThirdParty-181

ArrivalDate field cannot be null or empty

400

ThirdParty-182

Arrival date passed in invalid

400

ThirdParty-183

NumberOfDaysInResult is mandatory, cannot be null or greater than 30

400

ThirdParty-184

Invalid room id

404

ThirdParty-185

ResourceIds is mandatory, cannot be null

400

ThirdParty-186

Invalid preference type

400

ThirdParty-187

Invalid reservation status

400

ThirdParty-188

Maximum size of paged response is limited to 2000

400

ThirdParty-189

Request body can’t be empty or blank with post method

400

ThirdParty-190

You have insufficient permission to update the field provided in request body

403

ThirdParty-191

Customer not found

404

ThirdParty-192

Resource does not allow price change

400

ThirdParty-193

Reseller not found

404

ThirdParty-194

Reservation status cannot be changed as a unit is not available.

400

ThirdParty-195

Cannot change the reservation status as the reservation config is missing.

400

ThirdParty-196

Invalid countryId.

400

ThirdParty-197

Quantity too high for addition.

400

ThirdParty-198

Quantity too low for addition.

400

ThirdParty-199

Group type is invalid

400

ThirdParty-200

Either reservationIds or customerIds should be passed in request with accommodationKindIds.

400

ThirdParty-201

The startDate and endDate of accommodation or special cannot be updated.

400

ThirdParty-202

Only one resourceId could be passed in resourceIds.

400

ThirdParty-203

Invalid field name passed in the request body.

400

ThirdParty-204

Missing required parameter.

400

ThirdParty-205

DateRange is exceeded limit.

400

ThirdParty-206

The amenity passed in preferences is not valid for reservation stay.

400

ThirdParty-207

Accommodation is of work order type.

400

ThirdParty-208

AdditionResourceId is either invalid or is not available for reservation stay.

400

ThirdParty-209

ResourceId is invalid

400

ThirdParty-210

Incorrect reservedResourceId for reservation.

400

ThirdParty-211

Invalid titleId passed in the request.

400

ThirdParty-212

Price engine General Error.

400

ThirdParty-213

contractTypId passed in the request is invalid.

400

ThirdParty-214

Contract can be created for either resourceId or unitId

400

ThirdParty-215

Credentials null or invalid.

400

ThirdParty-216

Representation for the resourceIds and distribution channel is archived.

400

ThirdParty-217

Invalid rentability period.

400

ThirdParty-218

Record already exists with same criteria, but with different priority value and rate type id

400

ThirdParty-219

Error while creating addition.

400

ThirdParty-220

Total number of subjects and travel parties doesn’t match.

400

ThirdParty-221

Subjects or travel parties should be passed in the request to make reservation.

400

ThirdParty-222

The dateMargin parameter cannot be used in combination with includeAllPrices parameter.

400

ThirdParty-223

Travel parties should be passed with travel insurance addon.

400

ThirdParty-224

Supplier addition not available.

400

ThirdParty-225

Invalid amenityId.

400

ThirdParty-226

Value field passed in the request does not match amenity type.

400

ThirdParty-227

Only one type of subject list is allowed for insertion at a time.

400

ThirdParty-228

Invalid powerPlayGroupId passed in the request.

400

ThirdParty-229

Invalid offerType passed in the request.

400

ThirdParty-230

The startDate should be less than endDate.

400

ThirdParty-231

Cannot create reservation with current GDPR access.

401

ThirdParty-232

Voucher was not found.

400

ThirdParty-233

Either offerCode or voucherCode should be passed.

400

ThirdParty-234

Voucher is not valid for this period.

400

ThirdParty-235

Voucher is blocked.

400

ThirdParty-236

Voucher is already redeemed.

400

ThirdParty-237

Voucher is not allowed on this distribution channel.

400

ThirdParty-238

Voucher is not allowed with this accommodation type and period.

400

ThirdParty-239

There is no valid offer/resource linked to this voucher.

400

ThirdParty-240

Invalid preferenceId.

400

ThirdParty-241

Modification not allowed.

400

ThirdParty-242

Checked out reservation cannot be modified from API.

401

ThirdParty-243

Failed to generate JWT token response.

500

ThirdParty-244

Language passed in request is incorrect.

400

ThirdParty-245

Authentication token created with invalid api_key.

400

1.13. Release Notes

We are continuously improving and extending the REST API. The release notes of each release can be found here.
Release Notes

2. Swagger UI

2.1. Go to the Swagger UI

Swagger documentation can be used for executing the calls as well apart from the available endpoint list and descriptions.
NOTE: The Swagger UI Rest client

3. Flows

3.1. Maxxton environments

Maxxton works using a DTAP(Development, Testing, Acceptance, Production) approach. For this there are 4 environments available and the code is promoted from the left to the right. The staging is not available for all clients. In case no staging is available the test can be used.

The development environment is not externally available and only available to the Maxxton developers.

Both staging and production environments use the same API URLs because it’s using the same infrastructure with the difference that the database used is a test/staging database on staging.

Maxxton environment flow overview
Figure 1. Maxxton environments

3.1.1. Environment refresh

The Test environment can be refreshed with production data. In this case all test environment data will be overriden with the data from the production environment, including the API users.
For security reasons the API keys are excluded and the test API keys which existed before the refresh are kept during the refresh process. This means the API keys from the production and test environment will always be different and never overriden.
However the API users are the same. In case no api user is available on the production environment, the API key on the test environment is removed by the refresh process. This means after a refresh, users who don’t have access to the production environment will also not have access to the test environment.
This can result in a scenario where it will no longer be possible to login to the test environment. This can be solved by creating a new API user and API key after the refresh process is finished. If the user already existed on the production environment and no API key was available on the test environment a new API key has to be generated as well to gain access.
Contact the Maxxton client to provide you with new API details if necessary.

3.2. Events Flow

Any change(creation, deletion or modification) made in any of the entities will generate events, which are stored and can be fetched using the Events endpoint. Below are the events generated with their description. The details of the entity along with the changes can be fetched through separate endpoints mentioned for every event type below.

Events are not logged for entity records which become invalid or inactive after a given date.
For ex. validTo date in cashflowrule. In this case, no events will be logged for cashflowrule entity, after the respective validTo date of that cashflowrule is passed.

3.2.1. Events Generated

1) ACCOMMODATION_TYPE_EVENT

Any change made to the accommodationtype, which includes creation, modification or deletion of accommodationtype or any of its entities like address, images, amenities, capacities etc. will generate an ACCOMMODATION_TYPE_EVENT. In case of an ACCOMMODATION_TYPE_EVENT, the entity id logged will be the resourceId of the accommodationtype that was changed.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/accommodationtypes/{resourceId}/details

To refresh specific data following endpoints can be used:

  • GET: maxxton/v1/accommodationtypes/{resourceId}

  • GET: maxxton/v1/accommodationtypes/{resourceId}/capacities

  • GET: maxxton/v1/accommodationtypes/{resourceId}/images

  • GET: maxxton/v1/accommodationtypes/{resourceId}/amenitylinks

To refresh the data for multiple accommodationtypes at the same time the resourceId can be combined using the following endpoint:

  • GET: /maxxton/v1/accommodationtypes?filter=resourceId:[resourceId1,resourceId2,resourceId3…​]

2)ADDITION_EVENT

Any change made to the additions, which includes creation, modification or deletion of an addition will generate an ADDITION_EVENT. The entity id logged will be the resourceId of the accommodationtype, addition or offer on which the addition was added.

To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/accommodationtypes/{resourceId}/additions

  • GET: maxxton/v1/offers/{resourceId}/additions

  • GET: maxxton/v1/accommodationtypes/additions?filter=resourceId:[resourceId1,resourceId2,resourceId3…​]

  • GET: maxxton/v1/offers/additions?filter=resourceId:[resourceId1,resourceId2,resourceId3…​]

3) ADDON_EVENT

Any changes which includes creation, modification or deletion of extras or products will generate an ADDON_EVENT. The entity id logged will be the resourceId of the add-on that was changed.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/add-ons/{resourceId}

4) AVAILABILITY_EVENT

Changes in the availability of resources will generate an AVAILABILITY_EVENT. The event is created once the available is processed in the availability indexes and available from below defined endpoints. The following scenarios will generate an availability event:

  • When the prices or availability of a certain accommodation type changes this will be processed in the availability index once running. When this is processed an availability event is created

  • When the prices or rentability of an offer change this will be processed in the availability index once running. When this is processed an availability event is created for all the accommodation types for which this offer is applicable.

  • When the last unit of an accommodation type is booked, it is removed from the availability index right away and an availability event is created near real-time.

The entity id logged will be the resourceId of the accommodation type whose availability was changed.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/accommodationtypes/availability

5) CUSTOMER_EVENT

Any change made to the customers, which includes creation, modification or deletion of a customer or any of its fields will generate CUSTOMER_EVENT. The entity id logged will be the customerId of the customer that was changed.

To refresh the data the following endpoints can be used with the customerId fetched from the event endpoint:

  • GET: maxxton/v1/customers/{customerId}

  • GET: maxxton/v1/customers/{customerId}/communications

  • GET: maxxton/v1/customers/{customerId}/files

To refresh the data for multiple customers at the same time the customerIds can be combined using the following endpoint:

  • GET: maxxton/v1/customers?filter=customerId:[customerId1,customerId2,customerId3…​]

The customer event also contains events about merged customer by the deduplication script running in the Maxxton system.
This is indicated by the "entityAction" MERGE and will provide the customer id which is removed in the "oldEntityId" field and the customer id where the data is merged to(the customerId it has become) in the "entityId" field.

Incase of changes to the loyalty status or loyalty transactions also a customer event is generated.
To refresh this data the following endpoints can be used:

GET: maxxton/v1/customers/{customerId}/loyalty

GET: maxxton/v1/customerstatus?filter=customerId:{customerId}

6) DISTRIBUTIONCHANNEL_EVENT

Any change made to a distribution channel, which includes creation, modification or deletion of a distribution channel or any of its fields will generate DISTRIBUTIONCHANNEL_EVENT. The entity id logged will be the distributionChannelId of the distribution channel that was changed.

To refresh the data the following endpoints can be used with the distributionChannelId fetched from the event endpoint:

  • GET: maxxton/v1/distributionchannels/{distributionChannelId}

To refresh the data for multiple distribution channels at the same time the distributionChannelIds can be combined using the following endpoint:

  • GET: maxxton/v1/distributionchannels?filter=distributionChannelId:[distributionChannelId1,distributionChannelId2,distributionChannelId3…​]

7) IMPLY_EVENT

Any change made to the implies, which includes creation, modification or deletion of the imply of an accommodationtype, unit, add-on or offer will generate an IMPLY_EVENT. The entity id logged will be the resourceId of the accommodationtype, add-on or offer. In case of a unit it will be unitId. Based on the entityType it can be identified if it’s an accommodationtype, unit, add-on or offer.

To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/accommodationtypes/{resourceId}/implies

  • GET: maxxton/v1/add-ons/{resourceId}/implies

  • GET: maxxton/v1/offers/{resourceId}/implies

  • GET: maxxton/v1/units/{unitId}/implies

8) OFFER_EVENT

Any change made to the offers, which includes creation, modification or deletion will generate an OFFER_EVENT. The entity id logged will be the resourceId of the offer that was changed.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/offers/{resourceId}

  • GET: maxxton/v1/offers?filter=resourceId:[resourceId1,resourceId2,resourceId3…​]

9) OWNER_EVENT

Any change made to the owners, which includes creation, modification or deletion of an owner or any of its fields will generate OWNER_EVENT. The entity id logged will be the ownerId of the owner that was changed.

To refresh the data the following endpoints can be used with the ownerId fetched from the event endpoint:

  • GET: maxxton/v1/owners/{ownerId}

To refresh the data for multiple owners at the same time the ownerIds can be combined using the following endpoint:

  • GET: maxxton/v1/owners?filter=ownerId:[ownerId1,ownerId2,ownerId3…​]

10) RATE_EVENT

Any change made to the rates, which includes creation, modification or deletion of the rate of an accommodationtype, add-on or offer will generate a RATE_EVENT. The entity id logged will be the resourceId of the accommodationtype or offer. Based on the entityType it can be identified if it’s an accommodationtype or offer.

To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/accommodationtype/{resourceId}/rates

  • GET: maxxton/v1/offers/{resourceId}/rates

11) RENTABILITY_EVENT

Any change made to the rentability, which includes creation, modification or deletion of the rentability of an accommodationtype or offer will generate a RENTABILITY_EVENT. The entity id logged will be the resourceId of the accommodationtype, add-on or offer. Based on the entityType it can be identified if it’s an accommodationtype or offer.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET /maxxton/v1/rentability/config?resourceId={resourceId}

  • GET /maxxton/v1/rentability/stays?resourceId={resourceId}&distributionChannelId={distributionchannelId}

12) RESERVABILITY_EVENT

Any change made to the reservability, which includes creation, modification or deletion in the reservability of an accommodationtype, unit, add-on or offer will generate RESERVABILITY_EVENT. The entity id logged will be the resourceId of the accommodationtype, add-on or offer. In case of a unit it will be unitId. Based on the entityType it can be identified if it’s an accommodationtype, add-on, offer or unit,.

To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/resourcereservability?resourceId={resourceId}

  • GET: maxxton/v1/unitreservability?unitId={unitId}

13) RESERVATION_EVENT

Any change made to the reservations, which includes creation, modification or deletion in the reservation will generate RESERVATION_EVENT. The entity id logged will be the reservationId of the reservation that was changed.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET: maxxton/v1/reservations/{reservationId}/details

To refresh specific data following endpoints can be used:

  • GET: maxxton/v1/reservations/{reservationId}

  • GET: maxxton/v1/reservations/{reservationId}/preferences

  • GET: maxxton/v1/reservations/{reservationId}/bills

  • GET: maxxton/v1/reservations/{reservationId}/content

  • GET: maxxton/v1/reservations/{reservationId}/subjects

To refresh the data for multiple reservations at the same time the reservationIds can be combined using the following endpoint:

  • GET: maxxton/v1/reservations?filter=reservationId:[reservationId1,reservationId2,reservationId3,…​]

14) RESORT_EVENT

Any change made to the resorts, which includes creation, modification or deletion of the resort will generate RESORT_EVENT. The entity id logged will be the resortId of the resort that was changed.

To refresh the data the following endpoint can be used with the resortId fetched from the event endpoint:

  • GET: maxxton/v1/resorts/{resortId}/details

To refresh specific data following endpoints can be used:

  • GET: maxxton/v1/resorts/{resortId}

  • GET: maxxton/v1/resorts/{resortId}/amenitylinks

  • GET: maxxton/v1/resorts/{resortId}/subjects

To refresh the data for multiple resorts at the same time the resortIds can be combined using the following endpoint:

  • GET: maxxton/v1/resorts?filter=resortId:[resortId1,resortId2,resortId3,…​]

15) UNIT_EVENT

Any change made to the units, which includes creation, modification or deletion of the unit will generate UNIT_EVENT. The entity id logged will be the unitId of the unit that was changed.

To refresh the data the following endpoint can be used with the unitId fetched from the event endpoint:

  • GET: maxxton/v1/units/{unitId}/details

To refresh specific data following endpoints can be used:

  • GET: maxxton/v1/units/{unitId}

  • GET: maxxton/v1/units/{unitId}/capacities

  • GET: maxxton/v1/units/{unitId}/amenitylinks

To refresh the data for multiple units at the same time the unitIds can be combined using the following endpoint:

  • GET: maxxton/v1/units?filter=unitId:[unitId1,unitId2,unitId3,…​]

16) ALLOTMENT_EVENT

Any change made to the allotments, which includes creation, modification or deletion of the allotment will generate ALLOTMENT_EVENT. The entity id logged will be the resourceId of the accommodationtype whose allotment was changed.

To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:

  • GET: /maxxton/v1/accommodationtypes/{resourceId}/allotments

To refresh the data for multiple accommodationtypes at the same time the resourceIds can be combined using the following endpoint:

  • GET: /maxxton/v1/allotments?filter=resourceId:[resourceId1,resourceId2,resourceId3…​]

3.3. Reservation Flow

A reservation is basically used for booking or reserving an accommodationtype by a guest. Reservations include reserving a particular type of accommodationtype for a particular guest for a given period of time.

  1. Availability and prices

    There are 2 options to fetch the availability. One is to call the Maxxton API realtime and show it on the website, this also provides filter possibilities. Option 2 is to fetch all possible availabilities and prices and popuplate your own availability and price index to search offline on the external application.

    Option 1:

    Using the availability search you can search what accommodation types are available and for which periods. This endpoint also makes it possible to filter the search results and provide you with all possible filter options.

    There are two search endpoints for different purposes:

    POST /maxxton/v1/accommodationtypes/search
    POST /maxxton/v1/accommodationtypes/arrivalrangesearch

    Check the accommodation type search and arrival range search endpoints for details.

    Option 2:

    Using the availability call you can fetch all available stays and prices for all accommodation types. This endpoint is usually used to fill a dedicated availability/price index at the third party side.

    POST /maxxton/v1/accommodationtypes/availability

    Check the accommodation type availability endpoint for details.

    Optional: In case you also would like to fetch all the mandatory costs(implies) to add this to your index the following call can be used:

    POST /maxxton/v1/accommodationtypes/availability/implies

    Check the accommodation type availability implies endpoint for details.

  2. Accommodation types configuration/master data

    Using the accommodation type endpoints you can get the accommodation type configuration i.e. translatable name and descriptions, units, amenities, images etc. It is also possible to filter the response.

    There are multiple endpoints available for different purposes below two will contain most information regarding acommodation types and units:

    GET /maxxton/v1/accommodationtypes/{resourceId}/details
    GET /maxxton/v1/units/{unitId}/details

    If only specific data is needed the following endpoints can be used:

    GET /maxxton/v1/accommodationtypes
    GET /maxxton/v1/units
    GET /maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
    GET /maxxton/v1/accommodationtypes/{resourceId}/images

    Check full list of accommodation type and related endpoints here.

  3. Reservation proposal

    POST: https://api.maxxton.net/maxxton/v1/reservations/proposals

    When a possibility is chosen based on the search endpoints a reservation proposal can be created. A reservation proposal provides the proposal on reservation costs for the specified criteria in the request and doesn’t create an actual reservation in the system.

    It is used to validate if the accommodation type is available for the specified arrival date and duration.

    The reservation id and reservation number is not generated since no reservation is created. The proposal also provides you with all possible additions that can be added in the reservation. It also include instalments as per the reservation bill.

    This proposal can be used multiple times, till you are totally fine with the reservation, nothing is saved in our system and no reservation costs apply by using this.

    Check the reservation proposal endpoint for details.

  4. NewReservation

    POST: https://api.maxxton.net/maxxton/v1/reservations

    When the reservation is correct and you have checked this with the proposal call, you can use the new reservation endpoint to create an actual reservation.

    At this moment the new reservation is stored in our system and the reservation id and reservation number is generated.

    • Once the request is sent by the user, the request is validated as per the availability of the resource for which the reservation needs to be created. The mandatory parameters that needs to be passed in the new reservation request are as follows:

      • accommodationTypes: the details of the accommodationtype on which reservation is to be made

        • duration: the duration for which a user wants to make a reservation and the duration should be passed in days ex: 7.

        • resourceId: unique id associated with the accommodationtype.

        • subjects: details related to the subjects who will come for stay in an accommodationtype for whom reservation is to be created

          • persons: details related to the persons for whom the accommodationtype is booked in reservation.

            • age: age of the person

            • quantity: total number of persons for whom the accommodationtype is booked in reservation.

      • categoryCode: unique code associated with reservation category.

      • distributionChannelCode: unique code associated with distribution channel.

      • customer: details of guest doing the booking. Or, you can use customerId field instead of customer in case you have customerId of the guest who is doing the booking.

    • If the resource is available as per the request criteria, then the reservation will be created successfully and the status of the reservation can be provisional, optional, quotation, or request reservation(see reservation status flow, refer point 6 below).

      Check the new reservation endpoint for details.

  5. Update reservation

    The reservation status can be updated to different status using:

    PUT: https://api.maxxton.net/maxxton/v1/reservations/{reservationId}

    The status which can be updated to different status. Please refer to below status chart:

    • QUOTATION(-5) → CONFIRM(will result in PROVISIONAL(12) or DEFINITIVE(21)), DECLINE(-10)

    • OPTIONAL(11) → CONFIRM(will result in PROVISIONAL(12) or DEFINITIVE(21)), DECLINE(-10)

    • REQUEST(10)→DECLINE(-10), CONFIRM(will result in PROVISIONAL(12) or DEFINITIVE(21))

    • PROVISIONAL(12) → CANCEL(-12), DECLINE(-10)

    • DEFINITIVE(21)→CANCEL(-12), CHECKED_IN(31)

    • CHECKED_IN(31)→CHECKED_OUT(41).

      The user can change the status of the reservation as per the above status flow specified.

      It’s also possible to update the expectedArrivalDateTime and expectedDepartureDateTime, the value should be passed in the below format ,

      'YYYY-MM-DDThh:mm:ss'

      The above fields are mainly used by the receptionist of the resort, by maintenance department and housekeeping.

      Check the update reservation endpoint for details.

  6. Reservation status flow overview

    After creating a reservation it start with the INIT (an initial reservation) status. After completing the reservation, having added a customer and some add-ons, there are multiple options. We can update it to DELETED(these reservations are removed regularly), to OPTIONAL(which is a temporary confirmation) or PROVISIONAL(a confirmed reservation without a payment). Both OPTIONAL and PROVISIONAL get a reservation number assigned. This means they may no longer be deleted from the system, for financial reasons.

    Reservation starts with OPTIONAL, QUOTATION, PROVISIONAL or DEFINITVE status when it is confirmed through the API.

    OPTIONAL: will go to EXPIRED if not confirmed (after x number of hours/days based on configuration) or to PROVISIONAL/DEFINITIVE based on the API user configuration settings if confirmed. With this status the accommodation type price and availability are guaranteed for the reservation.

    QUOTATION: will go to the EXPIRED if not confirmed after x number of hours/days based on configuration or to PROVISIONAL/DEFINITIVE based on API user if confirmed. With this status the accommodation type rates are guaranteed for the reservation period and not the availability. So, some other guest can also book the reservation and then it is no more available to the guest who created a QUOTATION reservation.

    PROVISIONAL: A confirmed booking without a payment.

    DEFINITIVE: If a payment is made(partial or full), a PROVISIONAL reservation will be changed to DEFINITIVE. When the guest arrives it will change to CHECKED_IN and finally to CHECKED_OUT when the guest leaves.

    If a guest decides not to use the reservation, it can be changed from PROVISIONAL to DECLINED or to CANCELLED and from DEFINITIVE to CANCELLED.

    DECLINED: There are no costs for the guest and the reservation is no more available.

    CANCELLED: It implies that some sort of payment is involved. That is why DEFINITIVE can only go to CANCELLED(since something was paid already). From CANCELLED it can go to DEF_CANCELLED(if the guest decides to cancel absolutely), or back to either PROVISIONAL or DEFINITIVE (depending on payments made) if the guest opt for reservation again.

Reservation status flow overview
Figure 2. Reservation status flow overview

3.4. Ingenico Integration

Maxxton is using Ingenico as a default PSP(Payment service provider). Because of this, the payments can be automatically added to a reservation made in the Maxxton system using an integration that is already in place, however, to do this a couple of additional parameters is needed.

The integration works as follow

Ingenico integration overview
Figure 3. Ingenico integration overview

1) Recommended option: The flow 1 in the above diagram is the redirect URL. This can be generated from the Maxxton REST API by using the Reservation payment link endpoint. The endpoint will automatically provide the url to the correct Ingenico platform(Ingenico direct or the legacy version of Ingenico). The url provided from the response can be used in the website or application created by the company that is creating the booking module or website.

Alternative option: Previously this payment link had to be created manually. Below provides the url for the legacy Ingenico platform(Non Ingenico direct), this is not needed if you use the above endpoint to generate the payment link:

POST https://secure.ogone.com/ncol/prod/orderstandard_utf8.asp

POST request
Headers:
Content-Type: application/x-www-form-urlencoded

Request body(key-value pair):
PSPID=ClientPSPID //Ingenico PSPID to use
orderID=00019026850000_827efb46dc7bb2f //the order id should have the following structure: reservationNumber_anyRandomNumber
amount=1234 //the amount to be paid in the below-defined currency in cents(for example 12,35 should be defined as 1235)
currency=EUR //currency of the payment
language=nl_ //The language the Ingenico Hosted Payment Page is displayed to your customer. The value is a combination of ISO 639-1 (language) and ISO 3166-1 (country) for example: nl_NL, en_US, fr_FR
EMAIL=customer@maxxton.com //email of the customer
SHASign=0b105725955aa9e0cba8d9906ccd64d66b0ca422 //see Ingenico backoffice how this is created and what needs to be used here. Now we are supporting SHA-512 and SHA-1 is deprecated.
accepturl=https://book.maxxton.com/reservation/success //URL where the customer should be redirected to in case of a successful payment
declineurl=https://book.maxxton.com/reservation/cancel //URL where the customer should be redirected to in case of a declined payment
exceptionurl=https://book.maxxton.com/reservation/cancel //URL where the customer should be redirected to in case of a failed payment
cancelurl=https://book.maxxton.com/reservation/cancel //URL where the customer should be redirected to in case of a canceled payment
PARAMPLUS=distributionchannelId%3D51142%26reservationId%3D4181444%26employeeId%3D80041%26concernId%3D22 //mandatory parameters which will be used by Maxxton to process the payment on the proper reservation.
a) distributionchannelId: id of the distribution channel where the reservation is created for, this can be found in the response of the reservation confirm call
b) reservationId: id of the reservation that was just created to make the payment for, this can be found in the response of the reservation confirm call
c) employeeId: id of the employee which should add the payment in the Maxxton system, this can be found in the response "client_id" of the REST API authentication call
d) concernId: id of the concern/environment of the Maxton client, this can be found in the response "concern_id" of the REST API authentication call
TP=https://book.maxxton.com/ingenico/template.html //the URL to the Ingenico template to be used, this is optional.

Incase you would like to integrate directly with Ingenico direct. The Ingenico direct documentation can be found here.

2) This is the redirect from the Ingenico hosted payment page to the website, see Ingenico documentation for all possible parameters. This can be used by the booking module or website to provide feedback that the payment has been processed.
For Ingenico Direct you have to call the Ingenico hosted checkout status Endpoint to fetch the status. This can be done using this endpoint. The "hostedCheckoutId" to provide is returned from the redirect url(when using Reservation payment link endpoint you can add this in the "returnUrl" parameter) of Ingenico hosted payment page to your website. The "merchantId" is the PSPId used for the payment.
For the Ingenico legacy platform: Incase using the Maxxton Reservation payment link endpoint this can be provided in the fields(acceptUrl, cancelUrl, exceptionUrl, declineUrl).

3) The asynchronous callback from Ingenico to Maxxton. There is no additional development needed here and this will work right away if the correct structure for the redirect URL(number 1) is used. In the Ingenico backoffice the "URL of the merchant’s post-payment page" should be configured and point to Maxxton(this is already configured for existing Maxxton clients using Ingenico most of the time).

3.5. Webhooks

  1. Introduction

    The webhook solution is integrated in Maxxton Software integration manager and will push data when certain configured data changes are triggered. Unlike the REST API, the webhooks can not be pulled but will push data to the subscribed endpoint. The Maxxton webhook implementation is in line with the webhook standard guidelines. For the data structures, the REST API structures are re-used, this means all REST API documentation applies and adjustments of the REST API will reflect in the webhooks.

  2. Concept

    In the webhooks the following 3 concepts are available:

    1. Context:
      High-level entities in the Maxxton system, such as reservations, determine the context for the events and data that can be configured in the request.

    2. Events:
      The event triggering the webhook(eg. a change in reservation status)

    3. Data:
      The actual data structure(data fields) added to the webhook request

      Webhook_datastructure

    Above the diagram describes how the webhook works. First, you configure your webhook in the Maxxton Software Integration Manager.
    Once enabled the following flow will apply:

    1. In case any of the entities/data configured as the trigger is changed(this means there is new, changed, or removed data in the respected entity) the webhook will be triggered

    2. The webhook engine is triggered and in case the change meets the configured events the webhook will initiate a request.

    3. For every change the configured data is fetched from the REST API. After that, the webhook container including all data is created

    4. Optinally the receiving endpoints can have authentication. In case authentication is configured on the webhook the authentication details are sent with the request or authentication to receive a valid token will take place first

    5. The webhook container including all data is pushed to the external URL configured in the webhook

    6. The receiving(webhook subscriber) system can process the data further.

  3. Request structure

    Every webhook request will have the following structure

    {
    "notificationId": "2342040", //unique id of the webhook request
    "webhookId": 1, //unique id of the configured webhook
    "webhookName": "Maxxton test service", //webhook name as configured in Maxxton software integration manager
    "eventOccurred": "2024-07-31T08:39:44.709527Z", //date and time when the event occured
    "sentDate": "2024-07-31T08:39:46.203144Z", //the date and time when the webhook request was send out to push the event
    "type": "reservation.status.changed", //type of event to idenify what event has triggered the webhook
    "data": { //data structure as configured for this webhook
         .....
    }
}

  4. Available Context & Events

    Events are organized by context and type. The context determines the available events and data for use in the webhook request. The specific event that triggered the webhook request can be identified by the “type” field in the root of the webhook request. The following contexts and events are currently supported:

    • Reservations

    • Status Change (type: reservation.status_change): The status of the reservation changed to provisional, definitive, or canceled.

    • Stay Period Change (type: reservation.stay_period_change): The arrival and/or departure date of the reservation changed.

    • Bill Change (type: reservation.bill_change): There was a change to the total bill amount for the customer, paying customer, or agent.

    • Payment Received (type: reservation.payment_received): Triggered when a payment is received.

    • Refund Given (type: reservation.refund_given) : Triggered when a refund is issued.

  5. Available data

    The data available depends on the selected context. All data is populated through the REST API and has the same data structure available as the REST API. For specific field en entity descriptions the REST API documentation is linked:

    Context Data Cardinality Endpoint used

    Reservation

    General

    1

    maxxton/v1/reservations/{reservationId}

    Reservation

    Customer

    1

    maxxton/v1/customers/{customerId} maxxton/v1/owners/{ownerId}

    Reservation

    Paying Customer

    0 .. 1

    maxxton/v1/reservations/{reservationId}/details?returnSections=PAYING_CUSTOMER

    Reservation

    Resort

    1

    maxxton/v1/resorts/{resortId}

    Reservation

    Distribution Channel

    1

    maxxton/v1/distributionchannels/{distributionChannelId}

    Reservation

    Customer Bill

    1

    maxxton/v1/reservations/{reservationId}/bills?payerType=CUSTOMER

    Reservation

    Paying Customer Bill

    0 .. 1

    maxxton/v1/reservations/{reservationId}/bills?payerType=PAYING_CUSTOMER

    Reservation

    Agent Bill

    0 .. 1

    maxxton/v1/reservations/{reservationId}/bills?payerType=AGENT

    Reservation

    Doorlock

    0 .. *

    maxxton/v1/reservations/{reservationId}/doorlocks

    Reservation

    Infotexts

    0 .. *

    maxxton/v1/reservations/{reservationId}/infotexts

    Reservation

    Memos

    0 .. *

    maxxton/v1/reservations/{reservationId}/memos

    Reservation

    Payments

    0 .. *

    maxxton/v1/reservations/{reservationId}/payments

    Reservation

    Preferences

    0 .. *

    maxxton/v1/reservations/{reservationId}/preferences

    Reservation

    Subjects

    0 .. *

    maxxton/v1/reservations/{reservationId}/subjects

    Reservation

    Instalments

    0 .. *

    maxxton/v1/reservations/instalments?reservationIds={reservationId}

    Reservation

    Reserved Resources

    0 .. *

    maxxton/v1/reservations/{reservationId}/content maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields

    Reservation

    Unit

    0 .. 1

    maxxton/v1/units/{unitId}?returnWorkOrderUnits=true

  6. Security

    Authentication

    The endpoint used to send the webhook requests can optionally require authentication. The authorization HTTP header is added to the webhook request. Currently, the following authentication types are supported:

    Basic auth

    Authorization: Basic {credentials}

    OAuth 2.0 (client credential grant)

    Authorization: Bearer {token}

    No authentication
    The endpoint is freely accessible from the internet or IP whitelisting is applied

  7. Sender validation

    The receiving party can use a webhook secret to verify that the delivered message is from Maxxton. During the webhook set up, the user can provide a secret token. This token must be stored securely at their server. Each incoming webhook payload must be validated against the token.

    Maxxton will use HMAC-SHA256 (Hash-based Message Authentication Code) to generate a hash signature. The signature is generated using the payload content and the provided Webhook secret.
    HMAC
    The signature is sent in the webhook-signature HTTP header.

    Example:

    webhook-signature: v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=

  8. Access & usage

    Webhooks can be configured through the Maxxton Software Integration Manager under the Webhooks tab. Access to this Maxxton Software module is required to set up new webhooks or view statistics. Please note that Maxxton does not grant access to this module; it is managed by our clients, who are responsible for configuring the webhooks.

    To receive requests you don’t need access to Maxxton software.

    API pricing and fair use policies apply to the webhooks usage.

  9. Support

    In case of questions please contact the party who configured the webhooks for you(mostly the Maxxton client). Incase of technical queries a ticket can be created in the Maxxton ticket system or an email can be sent to api@maxxton.com.

4. Entity Relations

4.1. Resort, Accommodation Type, Unit

  • Resort(called "location" in Maxxton Software):
    A resort is group of accommodation types at the same location which provides an array of accommodation types typically including entertainment and recreational activities.
    A resort may contain one or multiple accommodation types.

  • Accommodation Type:
    An accommodation type is group of similar units, here the units are configured that defines type of unit(Room, Bungalow, Chalet etc) and other possible configuration(Representation, Capacity, Cashflow, Rentability, Reserability, Amenities etc), which can be done per resort or condo.
    An accommodation type may contain one or multiple units.

  • Unit:
    A room, group of rooms, or bungalow in which someone may live or stay, it can be a single room, bungalow, chalet etc.

Diagrammatic representation of Resort, Accommodation Types, Units:

Resort, Accommodation types and Units

4.2. Resources and reserved resources

In the Maxxton system, there are many resources(items) available, these resources can be of multiple types. For example Accommodation type, add-on, or offers are all resources. These resources can be booked while creating a reservation, in this case, a resource is added to the reservation which is called a reserved resource. This is basically a booked version of the actual resource. A resource is unique in the system and used across multiple reservations, a reserved resource is unique to the reservation.

Diagrammatic representation of Resources and reserved resources:

Resources and reserved resources

5. Resources

5.1. Accommodation Types

A group of similar units

5.1.1. Add new accommodation type

POST /maxxton/v1/accommodationtypes
Description

Add the new accommodation type.The details are to be mentioned in the resquest body.

Parameters
Type Name Description Schema

Body

requestBody
required

Request body to create new accommodation type.

CreateAccommodationTypeRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

AccommodationType

500

Error occurred while adding new accommodation type.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes
Request body
{
  "accotypeKindId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "brandId" : 1,
  "code" : "string",
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : "string",
  "priority" : 1,
  "resortId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "accommodationTypeKindCode" : "string",
  "accotypeAddressmanagerId" : 1,
  "accotypeBarrier" : 1,
  "accotypeDoorlock" : 1,
  "accotypeKindId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "brand" : "string",
  "brandId" : 1,
  "capacityManagerId" : 1,
  "cashflowManagerId" : 1,
  "code" : "string",
  "dependsOnLedgerGroup" : true,
  "description" : "string",
  "groupId" : 1,
  "hasObjects" : true,
  "i18n" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "resourceId" : 1,
    "shortDescription" : "string"
  } ],
  "ledgerGroupId" : 1,
  "ledgerId" : 1,
  "name" : "string",
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "numberOfPersons" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "path" : "string",
  "powerplayGroupId" : 1,
  "previousPmsId" : "string",
  "priority" : 1,
  "qualityLevelId" : 1,
  "realRentabilityManagerId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "resourceManagerId" : 1,
  "shortDescription" : "string",
  "supplierOrigin" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "resourceId" : 1,
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

5.1.2. Add rentability for accommodation type

POST /maxxton/v1/accommodationtypes/{resourceId}/rentability
Description

Rentability defines a specific period in which the accommodation type is rentable. The rentability details are to be added to the request body.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which rentability will be added for accommodation type

integer (int64)

Body

requestBody
required

RentabilityDetail
Responses
Code Description Schema

200

The request is completed successfully without any errors

No Content

500

Error occurred while adding rentability.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rentability
Request body
{
  "bookdateFrom" : "01-01-2023T11:23:45Z",
  "bookdateTo" : "01-01-2023T11:23:45Z",
  "dateBegin" : "01-01-2023",
  "dateEnd" : "01-01-2023",
  "dayMax" : 1,
  "dayMin" : 1,
  "daysOfWeek" : [ "string" ],
  "isArrival" : true,
  "isDeparture" : true,
  "isTemporary" : 1,
  "managerId" : 1,
  "maxDeviationArrDepDate" : 1,
  "maxTimeAfterBookDate" : 1,
  "minDeviationArrDepDate" : 1,
  "minTimeAfterBookDate" : 1
}
Example HTTP response

5.1.3. Calculate total price of given accommodation type

POST /maxxton/v1/accommodationtypes/{resourceId}/calculateprices
Description

This call will calculate the accommodation type price in real-time based on the current configuration in Maxxton software. This price is not based on the indexes and for this reason, there is no delay, however, the performance will be less. This feature should be implemented in a proper way, this means it’s recommended to lazy load the price after the actual availability search result is populated. Also, it’s recommended to only calculate the prices which are actually shown on the screen.

Parameters
Type Name Description Schema

Query

removeWarrant
optional

The basePrice and totalPrice without the warrant costs bill will be returned when the value is set to true

boolean

Path

resourceId
required

resourceId of accommodation type for which the total price needs to be calculated

integer (int64)

Body

requestBody
required

Request body to calculate total price of new accommodation type.

CalculatePriceRequest
Responses
Code Description Schema

204

The request is completed successfully without any errors

CalculatePriceResponse

500

Error occurred while adding new accommodation type.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/calculateprices
Request body
{
  "arrivalDate" : "01-01-2023",
  "distributionChannelId" : 1,
  "duration" : 1,
  "offerCode" : "string",
  "petQuantity" : 1,
  "rateTypeId" : 1,
  "redeemableLoyaltyPoints" : 1,
  "reservationCategoryId" : 1,
  "subjects" : {
    "persons" : [ {
      "maxAge" : 1,
      "quantity" : 1
    } ]
  }
}
Example HTTP response
Response 204
{
  "basePrice" : 1,
  "loyaltyDiscount" : 1,
  "offerPrice" : 1,
  "totalPrice" : 1,
  "warrantTotalPrice" : 1
}

5.1.4. Create accommodationType representation

POST /maxxton/v1/accommodationtypes/{resourceId}/representations
Description

Create accommodationType representations. The representation details are to be passed in the request body.

Parameters
Type Name Description Schema

Path

resourceId
required

resourceId of accommodation for which representations are to be created

integer (int64)

Body

requestBody
required

representation object to create represenation for accommodation type

CreateRepresentationRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

Representation

500

Error occurred while creating accommodation type representation.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/representations
Request body
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "representationId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}

5.1.5. Create accommodationtype budgets.

POST /maxxton/v1/accommodationtypes/{resourceId}/budgets
Description

Create accommodationtype budgets.", notes = "Create or update the daily budget for the specific accommodation type based on id. This will set the modifiedBudget and originalBudget based on the following logic: when no budget is available for the date and accommodationtype it will set the originalbudget, every time after this when a new budget is sent it will store this in the modifiedbudget field.

Parameters
Type Name Description Schema

Path

resourceId
required

resourceId of accommodation type for which the budget needs to be created

integer (int64)

Body

requestBody
required

< ResourceBudgetRequest
> array
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while creating the accommodation type budget.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/budgets
Request body
[ {
  "budgetDate" : "01-01-2023",
  "turnoverBudget" : 1
} ]
Example HTTP response

5.1.6. Get accommodation kinds

GET /maxxton/v1/accommodationtypes/kinds
Description

Gets a page with accommodation kinds.The records can be filtered based on accommodation kind object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
accommodationkindId:0,
code:String,
priority:0,
excludeFromReporting:true,
workOrderUnits:true,
archivedFrom:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationKindDetail

500

Error occurred while fetching AccommodationKind.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/kinds
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationkindId" : 1,
    "archivedFrom" : "01-01-2023",
    "code" : "string",
    "excludeFromReporting" : true,
    "priority" : 1,
    "translations" : [ {
      "accommodationkindId" : 1,
      "description" : "string",
      "i18nAccommodationkindId" : 1,
      "languageId" : 1,
      "name" : "string"
    } ],
    "workOrderUnits" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.7. Get capacities of the accommodation type

GET /maxxton/v1/accommodationtypes/{resourceId}/capacities
Description

Capacity specify the details about the number persons (Adult, Youngster, Baby etc.) or pets that can be accommodated in the accommodation type. This endpoint provides capacities for an accommodation type.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
capacityId:0,
managerId:0,
capacity:0,
subjectId:0,
startDate:String(date),
endDate:String(date))

Path

resourceId
required

resourceId to fetch capacities

integer (int64)

Query

returnWorkOrderTypes
optional

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

< Capacity
> array

500

Error occurred while fetching capacities for AccommodationType.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/capacities
Example HTTP response
Response 200
[ {
  "capacity" : 1,
  "capacityId" : 1,
  "endDate" : "01-01-2023",
  "managerId" : 1,
  "name" : "string",
  "startDate" : "01-01-2023",
  "subjectId" : 1
} ]

5.1.8. Get resource availability based on provided criteria.

GET /maxxton/v1/accommodationtypes/availability
Description

The endpoint can be used in following way:
1.If resourceId is passed in the request then it will return next four month’s availability from currentDate.
2.If only resortId is passed in the request then it will return two months availability of accommodations for that resort.
3.If only offerCode is passed in the request then it will return two months availability for all the types for which the requested offer is valid.
4.The arrivalDateFrom & arrivalDateTo fields could be used to limit the availability response for specific arrival date range.
5.There is a max limit on the arrival range period of four months together with resourceId field in the request and max limit of two months if only resortId or offercode field value is passed in the request.
6.In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay.

Parameters
Type Name Description Schema

Query

duration
optional

integer (int32)

Query

includeAllPrices
optional

boolean

Query

rateTypeId
optional

integer (int64)

Query

resourceId
optional

integer (int64)

Query

offerCode
optional

string

Query

resortId
optional

integer (int64)

Query

arrivalDateFrom
optional

string (date)

Query

offerId
optional

integer (int64)

Query

distributionChannelId
optional

integer (int64)

Query

arrivalDateTo
optional

string (date)

Query

includeHiddenOffers
optional

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

< ResourceAvailability
> array

500

Error occurred while fetching availability of resource

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability
Example HTTP response
Response 200
[ {
  "accommodationKindId" : 1,
  "arrivalDate" : "01-01-2023",
  "departureDate" : "01-01-2023",
  "duration" : 1,
  "maxCapacity" : 1,
  "petCapacity" : 1,
  "prices" : [ {
    "basePrice" : 1,
    "basePriceInclusive" : 1,
    "calculationDate" : "01-01-2023T11:23:45Z",
    "offer" : {
      "maxAge" : 1,
      "minAge" : 1,
      "minCapacity" : 1,
      "offerCode" : "string",
      "offerId" : 1,
      "offerPolicy" : "string",
      "offerPrice" : 1,
      "offerPriceInclusive" : 1
    },
    "rateTypeId" : 1,
    "referencePrice" : 1,
    "referencePriceInclusive" : 1
  } ],
  "resortCode" : "string",
  "resortId" : 1,
  "resourceId" : 1,
  "units" : [ "integer" ]
} ]

5.1.9. Get rooms on a specific resource id

GET /maxxton/v1/accommodationtypes/{resourceId}/rooms
Description

Provides the details of the rooms specific to a particular resource id.. The records can be filtered based on rooms object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
roomId:0,
code:String,
parentId:0,
lowestLevel:true)

Path

resourceId
required

Resource id for which rooms are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRoom

500

Error occurred while fetching Rooms

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rooms
Example HTTP response
Response 200
{
  "content" : [ {
    "amenities" : [ {
      "amenityLinkId" : 1,
      "numberValue" : 1,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "name" : "string",
    "parentId" : 1,
    "roomId" : 1,
    "roomManagerId" : 1,
    "roomType" : {
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "roomTypeId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.10. Gets resource implies

GET /maxxton/v1/accommodationtypes/implies
Description

Gets a page with resource implies. Implies are the extras that can be linked to the special. The records can be filtered based on implies object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

500

Error occurred while fetching resource implies.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.11. Gets Cost prices on a specific resource id.

GET /maxxton/v1/accommodationtypes/{resourceId}/costprices
Description

Gets Cost prices based on resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which cost prices are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeCostPrice

500

Error occurred while fetching cost prices of resource

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/costprices
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "costPriceId" : 1,
    "currencyCode" : "string",
    "currencyId" : 1,
    "duration" : 1,
    "maxDuration" : 1,
    "minDuration" : 1,
    "resourceId" : 1,
    "usageDowList" : [ "string" ],
    "value" : 1,
    "valueType" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.12. Gets a Resource locks on specified resource id

GET /maxxton/v1/accommodationtypes/{resourceId}/locks
Description

Gets a page with resource locks specified with a particular resource id.The records can be filtered based on resource lock object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reasonId:0,
detailDescription:String,
startDate:String(date),
endDate:String(date),
type:String,
unitId:0)

Path

resourceId
required

Resource id for which locks are to be fetched

integer (int64)

Query

unitId
optional

unitId to filter the records

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageLock

500

Error occurred while fetching resource locks.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/locks
Example HTTP response
Response 200
{
  "content" : [ {
    "accoCreatedLock" : 1,
    "blockDate" : "01-01-2023",
    "clientId" : 1,
    "created" : "01-01-2023T11:23:45Z",
    "createdOn" : "01-01-2023T11:23:45Z",
    "detailDescription" : "string",
    "endDate" : "01-01-2023",
    "objectId" : 1,
    "reasonId" : 1,
    "resourceId" : 1,
    "resourceLockId" : 1,
    "resourceManagerId" : 1,
    "startDate" : "01-01-2023",
    "type" : "string",
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.13. Gets a page of resource occupancy on specified resource id

GET /maxxton/v1/accommodationtypes/{resourceId}/occupancy
Description

Gets a page with resource occupancy specified with a particular resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

The identifier of the ResourceId to fetch resource occupancy

integer (int64)

Query

endDate
required

The identifier of the EndDate to fetch resource occupancy

string (date)

Query

startDate
required

The identifier of the StartDate to fetch resource occupancy

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOccupancy

500

Error occurred while fetching resource occupancy.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/occupancy
Example HTTP response
Response 200
{
  "content" : [ {
    "allotted" : 1,
    "bookedAllotment" : 1,
    "endDate" : "01-01-2023",
    "freeAllotment" : 1,
    "locked" : 1,
    "reserved" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "total" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.14. Gets a resource releases on specified resource id

GET /maxxton/v1/accommodationtypes/{resourceId}/releases
Description

Accommodation type release specifies that the accommodation type is available for booking for which period and to which users i.e. all, owners or test,It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
releaseId:0,
maxArrivalDate:String(date),
minArrivalDate:String(date),
releasedDays:0,
status:String,
resourceId:0,
createdDate:String(date),
modifiedDate:String(date))

Path

resourceId
required

Resource id for which to fetch releases

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeRelease

500

Error occurred while fetching AccommodationType releases.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/releases
Example HTTP response
Response 200
{
  "content" : [ {
    "createdDate" : "01-01-2023T11:23:45Z",
    "maxArrivalDate" : "01-01-2023",
    "minArrivalDate" : "01-01-2023",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "releaseId" : 1,
    "releasedDays" : 1,
    "resourceId" : 1,
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.15. Gets a single price for each stay (combination of arrival date and duration) for a given resource

POST /maxxton/v1/accommodationtypes/arrivalrangesearch
Description

Gets accommodationtype range search based on provided criteria. This endpoint supports prebooking prices, only if the field preBooking = true in the request body. If not specified, prebooking prices are not considered in the response.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay.

Parameters
Type Name Description Schema

Body

requestBody
required

PriceRangeSearchRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

ResourceRangeAvailabilityResponse

400

Either offerCode or voucherCode should be passed

No Content

500

Error occurred while fetching accommodationTypes

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/arrivalrangesearch
Request body
{
  "accommodationKindIds" : [ "integer" ],
  "amenityIds" : [ "integer" ],
  "arrivalDateFrom" : "01-01-2023",
  "distributionChannelId" : 1,
  "filterOptions" : [ "string" ],
  "numberOfDaysInResult" : 1,
  "offerCode" : "string",
  "offerId" : 1,
  "petQuantity" : 1,
  "preBooking" : true,
  "qualityLevelIds" : [ "integer" ],
  "rateTypeId" : 1,
  "redeemableLoyaltyPoints" : 1,
  "resortIds" : [ "integer" ],
  "resourceIds" : [ "integer" ],
  "subjects" : {
    "persons" : [ {
      "maxAge" : "string",
      "quantity" : 1
    } ]
  },
  "unitId" : 1,
  "voucherCode" : "string"
}
Example HTTP response
Response 200
{
  "filterOptionsResult" : {
    "arrivals" : [ "string" ],
    "departures" : [ "string" ],
    "qualityLevels" : [ "integer" ]
  },
  "results" : {
    "content" : [ {
      "accommodationKindId" : 1,
      "arrivalDate" : "01-01-2023",
      "arrivalDowMask" : "string",
      "basePrice" : 1,
      "basePriceInclusive" : 1,
      "departureDate" : "01-01-2023",
      "duration" : 1,
      "freeLoyaltyDuration" : 1,
      "loyaltyPrice" : 1,
      "loyaltyPriceInclusive" : 1,
      "maxCapacity" : 1,
      "maxPetCapacity" : 1,
      "offerCode" : "string",
      "offerName" : "string",
      "offerPolicy" : "string",
      "offerPrice" : 1,
      "offerPriceInclusive" : 1,
      "preBooking" : true,
      "qualityLevelId" : 1,
      "rateTypeId" : 1,
      "referencePrice" : 1,
      "referencePriceInclusive" : 1,
      "requiredLoyaltyPoints" : 1,
      "resortId" : 1,
      "resourceCode" : "string",
      "resourceId" : 1
    } ],
    "empty" : true,
    "first" : true,
    "last" : true,
    "number" : 1,
    "numberOfElements" : 1,
    "size" : 1,
    "sort" : {
      "empty" : true,
      "sorted" : true,
      "unsorted" : true
    },
    "totalElements" : 1,
    "totalPages" : 1
  }
}

5.1.16. Gets accommodation Type Detail

GET /maxxton/v1/accommodationtypes/details
Description

Gets a page of accommodationtype details. Maximum and default page size for this endpoint is 10.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
code:String,
ledgerGroupId:0,
resortId:0,
priority:0,
nrOfBedrooms:0.0,
nrOfBathrooms:0.0,
hasObjects:true,
path:String,
checkinTime:String,
checkoutTime:String,
lateCheckoutTime:String,
earlyCheckinTime:String,
archivedFrom:String(date),
ledgerId:0,
parentId:0,
numberOfPersons:0,
accotypeKindId:0,
origin:String,
originId:String,
powerplayGroupId:0,
qualityLevelId:0,
previousPmsId:String)

Query

endDate
optional

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Query

returnWorkOrderTypes
optional

boolean

Query

brand
optional

brand to filter records based on brand.

string

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are ADDRESS, AMENITYCATEGORYSETS, CAPACITIES, CAPACITYREQUIREMENTS, DYNAMICFIELDS, IMAGES, ROOMS, VIDEOS, TRANSLATIONS. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

startDate
optional

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Query

resourceIds
optional

List of resourceIds to fetch the details.

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeDetail

500

Error occurred while fetching AccommodationTypeUnitDetail.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/details
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationKind" : {
      "accommodationkindId" : 1,
      "code" : "string",
      "isWorkOrderObject" : true,
      "name" : "string",
      "translations" : [ {
        "accommodationkindId" : 1,
        "description" : "string",
        "i18nAccommodationkindId" : 1,
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "accommodationTypeKindCode" : "string",
    "accotypeBarrier" : 1,
    "accotypeDoorlock" : 1,
    "accotypeKindId" : 1,
    "address" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "amenityCategorySets" : [ {
      "categories" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityCategoryId" : 1,
        "amenityGroups" : [ {
          "amenities" : [ { } ],
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "identifier" : "string",
          "managerId" : 1,
          "metric" : { },
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "code" : "string",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "priority" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      } ],
      "code" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "brandId" : 1,
    "capacities" : [ {
      "capacity" : 1,
      "capacityId" : 1,
      "endDate" : "01-01-2023",
      "managerId" : 1,
      "startDate" : "01-01-2023",
      "subject" : {
        "controlAccess" : true,
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "includeInTotal" : true,
        "maxAge" : 1,
        "reportGroupSubjectId" : 1,
        "subjectCategoryId" : 1,
        "subjectId" : 1,
        "subjectOrder" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "type" : "string"
      },
      "subjectId" : 1
    } ],
    "capacityRequirements" : [ {
      "managerId" : 1,
      "required" : 1,
      "subject" : [ {
        "controlAccess" : true,
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "includeInTotal" : true,
        "maxAge" : 1,
        "reportGroupSubjectId" : 1,
        "subjectCategoryId" : 1,
        "subjectId" : 1,
        "subjectOrder" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "type" : "string"
      } ]
    } ],
    "checkinTime" : {
      "hour" : 1,
      "minute" : 1,
      "nano" : 1,
      "second" : 1
    },
    "checkoutTime" : {
      "hour" : 1,
      "minute" : 1,
      "nano" : 1,
      "second" : 1
    },
    "code" : "string",
    "dynamicFields" : [ {
      "code" : "string",
      "eventmanagerId" : 1,
      "fieldId" : 1,
      "translations" : [ {
        "description" : "string",
        "fieldId" : 1,
        "i18nFieldId" : 1,
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "text" : "string"
      } ],
      "type" : "string"
    } ],
    "earlyCheckinTime" : {
      "hour" : 1,
      "minute" : 1,
      "nano" : 1,
      "second" : 1
    },
    "hasObjects" : true,
    "i18n" : [ {
      "accotypeKind" : "string",
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "images" : [ {
      "endDate" : "01-01-2023",
      "fileName" : "string",
      "hostType" : "string",
      "imageId" : 1,
      "imageManagerId" : 1,
      "imageManagerIds" : [ "integer" ],
      "imageOrientation" : "string",
      "imageType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "mimeType" : "string",
      "modifiedDate" : "01-01-2023T11:23:45Z",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "tags" : [ {
        "name" : "string",
        "tagId" : 1
      } ],
      "thumbnailUrl" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "uploadDate" : "01-01-2023T11:23:45Z",
      "url" : "string",
      "version" : 1
    } ],
    "lateCheckoutTime" : {
      "hour" : 1,
      "minute" : 1,
      "nano" : 1,
      "second" : 1
    },
    "ledgerGroupId" : 1,
    "ledgerId" : 1,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "numberOfPersons" : 1,
    "origin" : "string",
    "originId" : "string",
    "parentId" : 1,
    "path" : "string",
    "powerplayGroupId" : 1,
    "previousPmsId" : "string",
    "priority" : 1,
    "qualityLevelId" : 1,
    "resortId" : 1,
    "resourceGroup" : {
      "code" : "string",
      "groupId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string"
      } ]
    },
    "resourceId" : 1,
    "resourcegroupId" : 1,
    "rooms" : [ {
      "amenities" : [ {
        "amenityLinkId" : 1,
        "numberValue" : 1,
        "textValue" : "string"
      } ],
      "code" : "string",
      "lowestLevel" : true,
      "name" : "string",
      "parentId" : 1,
      "roomId" : 1,
      "roomManagerId" : 1,
      "roomType" : {
        "code" : "string",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "roomTypeId" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      },
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "translations" : [ {
      "accotypeKind" : "string",
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "videos" : [ {
      "endDate" : "01-01-2023",
      "hostType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageCode" : "string",
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "thumbnailUrl" : "string",
      "url" : "string",
      "videoId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.17. Gets accommodation Type Detail

GET /maxxton/v1/accommodationtypes/{resourceId}/details
Description

Gets a detailed decription of the particular resource accommodationtypes.

Parameters
Type Name Description Schema

Path

resourceId
required

resourceId to fetch accommodationtypedetail

integer (int64)

Query

endDate
optional

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Query

returnWorkOrderTypes
optional

boolean

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are ADDRESS, AMENITYCATEGORYSETS, CAPACITIES, CAPACITYREQUIREMENTS, DYNAMICFIELDS, IMAGES, ROOMS, VIDEOS, TRANSLATIONS. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

startDate
optional

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

AccommodationTypeDetail

500

Error occurred while fetching AccommodationTypeDetail.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/details
Example HTTP response
Response 200
{
  "accommodationKind" : {
    "accommodationkindId" : 1,
    "code" : "string",
    "isWorkOrderObject" : true,
    "name" : "string",
    "translations" : [ {
      "accommodationkindId" : 1,
      "description" : "string",
      "i18nAccommodationkindId" : 1,
      "languageId" : 1,
      "name" : "string"
    } ]
  },
  "accommodationTypeKindCode" : "string",
  "accotypeBarrier" : 1,
  "accotypeDoorlock" : 1,
  "accotypeKindId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityCategorySets" : [ {
    "categories" : [ {
      "amenities" : [ {
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "identifier" : "string",
        "imageManagerId" : 1,
        "images" : [ {
          "endDate" : "01-01-2023",
          "fileName" : "string",
          "hostType" : "string",
          "imageId" : 1,
          "imageManagerId" : 1,
          "imageManagerIds" : [ "integer" ],
          "imageOrientation" : "string",
          "imageType" : "string",
          "isActive" : true,
          "isUploaded" : true,
          "isWebPresentation" : true,
          "mediaLanguageId" : 1,
          "mediaType" : "string",
          "mimeType" : "string",
          "modifiedDate" : "01-01-2023T11:23:45Z",
          "sequenceNumber" : 1,
          "startDate" : "01-01-2023",
          "tags" : [ { } ],
          "thumbnailUrl" : "string",
          "translations" : [ { } ],
          "uploadDate" : "01-01-2023T11:23:45Z",
          "url" : "string",
          "version" : 1
        } ],
        "managerId" : 1,
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityCategoryId" : 1,
      "amenityGroups" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "identifier" : "string",
        "managerId" : 1,
        "metric" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "priority" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "archivedFrom" : "01-01-2023",
  "brand" : "string",
  "brandId" : 1,
  "capacities" : [ {
    "capacity" : 1,
    "capacityId" : 1,
    "endDate" : "01-01-2023",
    "managerId" : 1,
    "startDate" : "01-01-2023",
    "subject" : {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    },
    "subjectId" : 1
  } ],
  "capacityRequirements" : [ {
    "managerId" : 1,
    "required" : 1,
    "subject" : [ {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ]
  } ],
  "checkinTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "checkoutTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "code" : "string",
  "dynamicFields" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "earlyCheckinTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "hasObjects" : true,
  "i18n" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "resourceId" : 1,
    "shortDescription" : "string"
  } ],
  "images" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "lateCheckoutTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "ledgerGroupId" : 1,
  "ledgerId" : 1,
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "numberOfPersons" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "path" : "string",
  "powerplayGroupId" : 1,
  "previousPmsId" : "string",
  "priority" : 1,
  "qualityLevelId" : 1,
  "resortId" : 1,
  "resourceGroup" : {
    "code" : "string",
    "groupId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ]
  },
  "resourceId" : 1,
  "resourcegroupId" : 1,
  "rooms" : [ {
    "amenities" : [ {
      "amenityLinkId" : 1,
      "numberValue" : 1,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "name" : "string",
    "parentId" : 1,
    "roomId" : 1,
    "roomManagerId" : 1,
    "roomType" : {
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "roomTypeId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "resourceId" : 1,
    "shortDescription" : "string"
  } ],
  "videos" : [ {
    "endDate" : "01-01-2023",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 1
  } ]
}

5.1.18. Gets accommodation type additions

GET /maxxton/v1/accommodationtypes/{resourceId}/additions
Description

Gets a page with AccommodationType additions for a particular resource. The record can be filtered based on resource addition object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

resourceId of accommodation for which additions are to be fetched

integer (int64)

Query

type
optional

type to filter records based on the type on the resource addition

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResourceAddition

500

Error occurred while fetching accommodation type additions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "additionFast" : true,
    "additionId" : 1,
    "additionResourceId" : 1,
    "addonType" : "string",
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "mandatoryResource" : true,
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "maxTotalQuantity" : 1,
    "priceCompare" : true,
    "resortArticle" : true,
    "resourceId" : 1,
    "resourceMoment" : [ "string" ],
    "supplierAdditionId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.19. Gets accommodationType representations

GET /maxxton/v1/accommodationtypes/{resourceId}/representations
Description

Gets a page with accommodationType representations for a resource. The records can be filtered based on representation object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
visible:true,
bookable:true)

Path

resourceId
required

resourceId of accommodation for which representations are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRepresentation

500

Error occurred while fetching accommodation type representations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/representations
Example HTTP response
Response 200
{
  "content" : [ {
    "bookable" : true,
    "distributionChannelIds" : [ "integer" ],
    "representationId" : 1,
    "resourceId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "i18nRepresentationId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "representationId" : 1,
      "shortDescription" : "string"
    } ],
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.20. Gets accommodationTypes additions

GET /maxxton/v1/accommodationtypes/additions
Description

Get a page with accommodation types additions.Additions are defining recommended goods during the booking process(upselling). The products are linked to the accommodation where they may be booked. The data can be filtered based on resource addition object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Query

type
optional

type to filter records based on the type on the resource addition

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResourceAddition

500

Error occurred while fetching accommodation types additions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "additionFast" : true,
    "additionId" : 1,
    "additionResourceId" : 1,
    "addonType" : "string",
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "mandatoryResource" : true,
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "maxTotalQuantity" : 1,
    "priceCompare" : true,
    "resortArticle" : true,
    "resourceId" : 1,
    "resourceMoment" : [ "string" ],
    "supplierAdditionId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.21. Gets accommodationtype rates

GET /maxxton/v1/accommodationtypes/{resourceId}/rates
Description

Gets a page with rates of accommodation of a particular resource.The records can be filtered based on rate object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rateId:0,
value:0.0,
remark:String,
qrvType:String,
priority:0,
bookdateFrom:String(date),
bookdateTo:String(date),
usageDurationFrom:0,
usageDurationTo:0,
cashflowmanagerId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

Resource id for which Rates are to be fetched

integer (int64)

Query

rateTypeIds
optional

RateTypeIds to filter accommodation type Rates.

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRate

500

Error occurred while fetching accommodation type rates.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rates
Example HTTP response
Response 200
{
  "content" : [ {
    "bookdateFrom" : "01-01-2023T11:23:45Z",
    "bookdateTo" : "01-01-2023T11:23:45Z",
    "daysOfWeek" : [ "string" ],
    "duration" : 1,
    "maxDeviation" : 1,
    "maxDuration" : 1,
    "maxDurationMinutes" : 1,
    "minDeviation" : 1,
    "minDuration" : 1,
    "minDurationMinutes" : 1,
    "priority" : 1,
    "qrvType" : "string",
    "qrvValues" : [ {
      "minQuantity" : 1,
      "value" : 1
    } ],
    "quantifier" : "string",
    "rateId" : 1,
    "rateTypeIds" : [ "integer" ],
    "rateTypes" : [ {
      "rateTypeId" : 1
    } ],
    "remark" : "string",
    "resourceId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "usageDowList" : [ "string" ],
    "usageDurationFrom" : 1,
    "usageDurationTo" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023",
    "value" : 1,
    "valueType" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.22. Gets all accommodation types

GET /maxxton/v1/accommodationtypes
Description

Gets a page with accommodation types. The records can be filtered based on accommodation type object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
ledgerGroupId:0,
type:String,
code:String,
resortId:0,
parentId:0,
path:String,
hasObjects:true,
dependsOnLedgerGroup:true,
priority:0,
numberOfPersons:0,
nrOfBedrooms:0.0,
nrOfBathrooms:0.0,
accotypeKindId:0,
archivedFrom:String(date),
ledgerId:0,
brand:String,
origin:String,
originId:String,
powerplayGroupId:0,
groupId:0,
qualityLevelId:0,
previousPmsId:String,
linkedWithSupplier:true)

Query

countryCode
optional

Country code to filter accommodation types.

string

Query

returnWorkOrderTypes
optional

boolean

Query

brand
optional

brand to filter records based on brand.

string

Query

resourceIds
optional

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationType

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching AccommodationTypes.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationTypeKindCode" : "string",
    "accotypeAddressmanagerId" : 1,
    "accotypeBarrier" : 1,
    "accotypeDoorlock" : 1,
    "accotypeKindId" : 1,
    "address" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "amenityManagerId" : 1,
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "brandId" : 1,
    "capacityManagerId" : 1,
    "cashflowManagerId" : 1,
    "code" : "string",
    "dependsOnLedgerGroup" : true,
    "description" : "string",
    "groupId" : 1,
    "hasObjects" : true,
    "i18n" : [ {
      "accotypeKind" : "string",
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "ledgerGroupId" : 1,
    "ledgerId" : 1,
    "name" : "string",
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "numberOfPersons" : 1,
    "origin" : "string",
    "originId" : "string",
    "parentId" : 1,
    "path" : "string",
    "powerplayGroupId" : 1,
    "previousPmsId" : "string",
    "priority" : 1,
    "qualityLevelId" : 1,
    "realRentabilityManagerId" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "resourceManagerId" : 1,
    "shortDescription" : "string",
    "supplierOrigin" : "string",
    "translations" : [ {
      "accotypeKind" : "string",
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.23. Gets allotments for Resource

GET /maxxton/v1/accommodationtypes/{resourceId}/allotments
Description

Gets allotments for Resource of a specific resourceId. The records can be filtered based on allotment object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentId:0,
distributionChannelId:0,
resourceId:0,
name:String,
description:String,
type:String,
exceedLimit:0,
expirePeriod:0,
amount:0,
modified:String(date),
isEnactive:true)

Path

resourceId
required

Resource id for which to fetch Allotments

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAllotment

500

Error occurred while fetching Allotments.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/allotments
Example HTTP response
Response 200
{
  "content" : [ {
    "allotmentId" : 1,
    "amount" : 1,
    "description" : "string",
    "distributionChannelId" : 1,
    "exceedLimit" : 1,
    "expirePeriod" : 1,
    "hasObjects" : true,
    "isEnactive" : true,
    "modified" : "01-01-2023",
    "name" : "string",
    "periods" : [ {
      "endDate" : "01-01-2023",
      "quantity" : 1,
      "startDate" : "01-01-2023",
      "unitIds" : [ "integer" ]
    } ],
    "resourceId" : 1,
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.24. Gets allotments releases of a specific resource

GET /maxxton/v1/accommodationtypes/{resourceId}/allotments/releases
Description

Gets allotment releases for a resource with particular resource id.The records can be fetched based on allotment release object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentReleaseId:0,
distributionChannelId:0,
name:String,
startDate:String(date),
endDate:String(date),
releasePeriod:0,
releaseDate:String(date),
performedDate:String(date),
resourceId:0,
resortId:0,
isEnactive:true)

Path

resourceId
required

Resource id for which to fetch Allotment releases

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAllotmentRelease

500

Error occurred while fetching Allotment releases.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/allotments/releases
Example HTTP response
Response 200
{
  "content" : [ {
    "allotmentReleaseId" : 1,
    "distributionChannelId" : 1,
    "endDate" : "01-01-2023",
    "isEnactive" : true,
    "name" : "string",
    "performedDate" : "01-01-2023",
    "releaseDate" : "01-01-2023",
    "releasePeriod" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.25. Gets amenity links page

GET /maxxton/v1/accommodationtypes/amenitylinks
Description

Gets a page with amenity links. The records can be filtered based on accommodation type amenity link object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
accommodationTypeId:0,
amenityLinkId:0,
type:String,
visible:true,
preferenceExtraId:0,
numberValue:0.0,
textValue:String,
startDate:String(date),
endDate:String(date),
amenityId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeAmenityLink

500

Error occurred while fetching Amenity links.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationTypeId" : 1,
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "code" : "string",
    "endDate" : "01-01-2023",
    "numberValue" : 1,
    "preferenceExtraId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.26. Gets amenity links page for a resource

GET /maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
Description

Gets a page with amenity links to a particular resource.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityLinkId:0,
type:String,
visible:true,
preferenceExtraId:0,
numberValue:0.0,
textValue:String,
startDate:String(date),
endDate:String(date),
amenityId:0)

Path

resourceId
required

resourceId

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAmenityLink

500

Error occurred while fetching Amenity links.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "code" : "string",
    "endDate" : "01-01-2023",
    "numberValue" : 1,
    "preferenceExtraId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.27. Gets an accommodation Type on a specific resource id.

GET /maxxton/v1/accommodationtypes/{resourceId}
Description

Gets accommodation types based on its resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id to fetch accommodationtype

integer (int64)

Query

returnWorkOrderTypes
optional

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

AccommodationType

500

Error occurred while fetching AccommodationType.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}
Example HTTP response
Response 200
{
  "accommodationTypeKindCode" : "string",
  "accotypeAddressmanagerId" : 1,
  "accotypeBarrier" : 1,
  "accotypeDoorlock" : 1,
  "accotypeKindId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "brand" : "string",
  "brandId" : 1,
  "capacityManagerId" : 1,
  "cashflowManagerId" : 1,
  "code" : "string",
  "dependsOnLedgerGroup" : true,
  "description" : "string",
  "groupId" : 1,
  "hasObjects" : true,
  "i18n" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "resourceId" : 1,
    "shortDescription" : "string"
  } ],
  "ledgerGroupId" : 1,
  "ledgerId" : 1,
  "name" : "string",
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "numberOfPersons" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "path" : "string",
  "powerplayGroupId" : 1,
  "previousPmsId" : "string",
  "priority" : 1,
  "qualityLevelId" : 1,
  "realRentabilityManagerId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "resourceManagerId" : 1,
  "shortDescription" : "string",
  "supplierOrigin" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "resourceId" : 1,
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

5.1.28. Gets an accommodationType budget of a resource.

GET /maxxton/v1/accommodationtypes/{resourceId}/budgets
Description

Get the daily budget for the specific accommodation type based on id.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
budgetId:0,
resourceId:0,
originalBudget:0.0,
modifiedBudget:0.0,
budgetDate:String(date))

Path

resourceId
required

resourceId of accommodation type for which the budget needs to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResourceBudget

500

Error occurred while fetching accommodation type budget.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/budgets
Example HTTP response
Response 200
{
  "content" : [ {
    "budgetDate" : "01-01-2023",
    "budgetId" : 1,
    "modifiedBudget" : 1,
    "originalBudget" : 1,
    "resourceId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.29. Gets cost prices for all accommodationtype

GET /maxxton/v1/accommodationtypes/costprices
Description

Gets a page with Cost prices. The records can be filtered based on Cost price object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
costPriceId:0,
resourceId:0,
arrivalDateFrom:String(date),
arrivalDateTo:String(date),
bookDateFrom:String(date),
bookDateTo:String(date),
duration:0,
minDuration:0,
maxDuration:0,
value:0.0,
currencyId:0,
valueType:String,
usageDowList:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeCostPrice

500

Error occurred while fetching cost prices

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/costprices
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "costPriceId" : 1,
    "currencyCode" : "string",
    "currencyId" : 1,
    "duration" : 1,
    "maxDuration" : 1,
    "minDuration" : 1,
    "resourceId" : 1,
    "usageDowList" : [ "string" ],
    "value" : 1,
    "valueType" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.30. Gets dynamic fields for a particular resource

GET /maxxton/v1/accommodationtypes/{resourceId}/dynamicfields
Description

Gets a page with dynamic fields to a specific resource. The records can be filtered based on the DynamicField object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fieldId:0,
code:String,
type:String)

Path

resourceId
required

Resource id for which dynamic fieilds are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDynamicField

500

Error occurred while fetching resource dynamic fields.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/dynamicfields
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.31. Gets images for a particular resource

GET /maxxton/v1/accommodationtypes/{resourceId}/images
Description

Gets a page with images to a specific resource. The records can be filtered based on the image object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileName:String,
imageId:0,
startDate:String(date),
endDate:String(date),
mimeType:String,
version:0,
url:String,
uploadDate:String(date),
imageType:String,
imageOrientation:String,
modifiedDate:String(date))

Path

resourceId
required

Resource id for which images are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImage

500

Error occurred while fetching resource images.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/images
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.32. Gets implies linked to a particular resource

GET /maxxton/v1/accommodationtypes/{resourceId}/implies
Description

Gets a page with resource implies. Implies are the extras that can be linked to the special.The records can be filtered based on the implies object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

Resource id for which implies are to be fetched

integer (int64)

Query

parentImplies
optional

Get a parent implies or resource implies

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

500

Error occurred while fetching resource implies.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.33. Gets priorities for particular resourceid.

GET /maxxton/v1/accommodationtypes/{resourceId}/priorities
Description

Get priorites for the specific accommodation type based on resourceid.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
accommodationtypePriorityId:0,
resourceId:0,
fiscalYear:String,
fiscalyearId:0,
reservationFrom:String(date),
reservationTo:String(date),
useContractPriority:true,
useVsi:true,
useOccupation:true,
useTargetAmount:true,
usePlanboardFitting:true,
useQuestionnaire:true,
prioritySequence:String)

Path

resourceId
required

resourceId of accommodation type for which the priorities needs to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypePriority

500

Error occurred while fetching accommodation type priority.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/priorities
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationtypePriorityId" : 1,
    "fiscalYear" : {
      "arrivalLimit" : "01-01-2023",
      "departureLimit" : "01-01-2023",
      "financiallyClosed" : true,
      "fiscalYear" : 1,
      "fiscalYearId" : 1
    },
    "fiscalyearId" : 1,
    "prioritySequence" : "string",
    "reservationFrom" : "01-01-2023",
    "reservationTo" : "01-01-2023",
    "resourceId" : 1,
    "useContractPriority" : true,
    "useOccupation" : true,
    "usePlanboardFitting" : true,
    "useQuestionnaire" : true,
    "useTargetAmount" : true,
    "useVsi" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.34. Gets the List of applicable preference fee for the accommodationType.

GET /maxxton/v1/accommodationtypes/availability/preferences
Description

Gets the list of applicable preference fee for the accommodationtypes.

Parameters
Type Name Description Schema

Query

distributionChannelCode
optional

distributionChannelCode for which addons are to be fetched

string

Query

resourceId
required

Resource id for which addons are to be fetched

integer (int64)

Query

reservationCategoryCode
optional

reservationCategoryCode for which addons are to be fetched.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

< AccommodationTypePreference
> array

500

Error occurred while fetching preference fee.

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability/preferences
Example HTTP response
Response 200
[ {
  "preferenceTypes" : [ "string" ],
  "prices" : [ {
    "appliedPerSubject" : true,
    "price" : 1,
    "priceArrivalDateFrom" : "01-01-2023",
    "priceArrivalDateTo" : "01-01-2023",
    "priceBookDateFrom" : "01-01-2023T11:23:45Z",
    "priceBookDateTo" : "01-01-2023T11:23:45Z",
    "subjectIds" : [ "integer" ],
    "subjectPrices" : [ {
      "minQuantity" : 1,
      "price" : 1,
      "subjectIds" : [ "integer" ]
    } ]
  } ],
  "resortId" : 1,
  "resourceId" : 1
} ]

5.1.35. Gets the Page of Quality Levels

GET /maxxton/v1/accommodationtypes/qualitylevels
Description

Gets the Page of Quality Levels.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
qualityLevelId:0,
code:String,
archivedFrom:String(date),
priority:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageQualityLevel

500

Error occurred while fetching Quality levels

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/qualitylevels
Example HTTP response
Response 200
{
  "content" : [ {
    "archivedFrom" : "01-01-2023",
    "code" : "string",
    "priority" : 1,
    "qualityLevelId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.36. Gets the Page of target amount for a particular resourceId,accommodationPriorityId.

GET /maxxton/v1/accommodationtypes/{resourceId}/priorities/{accommodationtypePriorityId}/targetAmounts
Description

Gets a page with target amount. The records can be filtered based on target amount object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceTargetAmountId:0,
resourceId:0,
contractTypeId:0,
rentAssuranceBase:0,
accommodationtypePriorityId:0,
maxMaintenanceFund:0.0,
maxFundPerInvReservation:0.0,
ownerId:0,
maxFundPerInvForMaterial:0.0,
maxFundPerInvForWorktime:0.0,
maxFundPerWorkorder:0.0)

Path

resourceId
required

resourceId for which target amount are to be fetched.

integer (int64)

Path

accommodationtypePriorityId
required

accommodationTypePriorityId for which target amount are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageTargetAmount

500

Error occurred while fetching target amount.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/priorities/{accommodationtypePriorityId}/targetAmounts
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationtypePriorityId" : 1,
    "contractTypeId" : 1,
    "fiscalYear" : {
      "arrivalLimit" : "01-01-2023",
      "departureLimit" : "01-01-2023",
      "financiallyClosed" : true,
      "fiscalYear" : 1,
      "fiscalYearId" : 1
    },
    "fiscalyearId" : 1,
    "maxFundPerInvForMaterial" : 1,
    "maxFundPerInvForWorktime" : 1,
    "maxFundPerInvReservation" : 1,
    "maxFundPerWorkorder" : 1,
    "maxMaintenanceFund" : 1,
    "ownerId" : 1,
    "rentAssuranceBase" : 1,
    "resourceId" : 1,
    "resourceTargetAmountId" : 1,
    "targetAmount" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.37. Gets the page of available addons for the accommodationType.

GET /maxxton/v1/accommodationtypes/availability/additions
Description

This endpoint is used to fetch all the available implies along with available prices.

Parameters
Type Name Description Schema

Query

distributionChannelCode
optional

distributionChannelCode for which addons are to be fetched

string

Query

resourceId
required

Resource id for which addons are to be fetched

integer (int64)

Query

advancedCalculation
optional

Flag for calculating the relative rate configuration for all the addons if configured. enabling this flag will give you the information about the percentage price and the resources that particular price depends on.
on setting this flag as true the fields dependsOnAddon,dependsOnOffer and dependsOnAccommodationType will be populated as true or false, if true the list of depending Ids can found in the corresponding arrays of offerIds and addonIds. if the field dependsOnAddon/dependsOnOffer is true but there is no id in the array this signifies that price depends on all the addons/offers.

boolean

Query

reservationCategoryCode
optional

reservationCategoryCode for which addons are to be fetched.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeAddon

500

Error occurred while fetching prices of resource

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "maxQuantity" : 1,
    "minQuantity" : 1,
    "prices" : [ {
      "addonIds" : [ "integer" ],
      "appliedPerSubject" : true,
      "daysOfWeek" : [ "string" ],
      "dependsOnAccommodationtypes" : true,
      "dependsOnAddon" : true,
      "dependsOnOffer" : true,
      "duration" : 1,
      "maxQuantity" : 1,
      "minQuantity" : 1,
      "offerIds" : [ "integer" ],
      "perDay" : "string",
      "percentagePrice" : true,
      "price" : 1,
      "priceArrivalDateFrom" : "01-01-2023",
      "priceArrivalDateTo" : "01-01-2023",
      "subjectIds" : [ "integer" ],
      "subjectPrices" : [ {
        "minQuantity" : 1,
        "price" : 1,
        "subjectIds" : [ "integer" ]
      } ]
    } ],
    "resortId" : 1,
    "resourceId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "resourceId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.38. Gets the page of available implies for the accommodationType.

GET /maxxton/v1/accommodationtypes/availability/implies
Description

This endpoint is used to fetch all the available implies along with available prices.

Parameters
Type Name Description Schema

Query

distributionChannelCode
optional

DistributionChannelCode for which implies are to be fetched

string

Query

resourceId
required

Resource id for which implies are to be fetched

integer (int64)

Query

advancedCalculation
optional

Flag for calculating the relative rate configuration for all the implies if configured. enabling this flag will give you the information about the percentage price and the resources that particular price depends on.
on setting this flag as true the fields dependsOnAddon,dependsOnOffer and dependsOnAccommodationType will be populated as true or false, if true the list of depending Ids can found in the corresponding arrays of offerIds and addonIds.if the field dependsOnAddon/dependsOnOffer is true but there is no id in the array this signifies that price depends on all the addons/offers.

boolean

Query

reservationCategoryCode
required

reservationCategoryCode for which implies are to be fetched.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccommodationTypeImply

500

Error occurred while fetching cost prices of resource

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : true,
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "included" : true,
    "maxQuantity" : 1,
    "minQuantity" : 1,
    "prices" : [ {
      "addonIds" : [ "integer" ],
      "appliedPerSubject" : true,
      "daysOfWeek" : [ "string" ],
      "dependsOnAccommodationtypes" : true,
      "dependsOnAddon" : true,
      "dependsOnOffer" : true,
      "duration" : 1,
      "included" : true,
      "maxNights" : 1,
      "maxQuantity" : 1,
      "minNights" : 1,
      "minQuantity" : 1,
      "offerIds" : [ "integer" ],
      "perDay" : "string",
      "percentagePrice" : true,
      "price" : 1,
      "priceArrivalDateFrom" : "01-01-2023",
      "priceArrivalDateTo" : "01-01-2023",
      "subjectIds" : [ "integer" ],
      "subjectPrices" : [ {
        "minQuantity" : 1,
        "price" : 1,
        "subjectIds" : [ "integer" ]
      } ]
    } ],
    "required" : true,
    "resortId" : 1,
    "resourceId" : 1,
    "stayDate" : [ "string" ],
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.39. Gets videos for accommodation type

GET /maxxton/v1/accommodationtypes/{resourceId}/videos
Description

Gets a page with videos to a specific resource. The records can be filtered based on the video object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
videoId:0,
startDate:String(date),
endDate:String(date),
url:String,
isUploaded:true,
mediaType:String,
hostType:String,
isActive:true,
isWebPresentation:true,
thumbnailUrl:String)

Path

resourceId
required

Resource id for which videos are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageVideo

500

Error occurred while fetching resource videos.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/videos
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.1.40. Insert accommodation rate

POST /maxxton/v1/accommodationtypes/{resourceId}/rates
Description

Inserts the accommodation rate type. The details are to be mentioned in the request body. The rates cannot be inserted for derived rate option.x-allow-past-price : This header is passed in the request to allow the user to pass past book dates. The user can pass "true" as the value of the header if past book dates are provided in the request and if the value of this header is "false" the user will not be able to pass book dates that lie in the past. Rates in the past can only be inserted for accommodation types that currently have no rates at all or in case no reservations have been made for the particular accommodation type yet.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which resource rate will inserted

integer (int64)

Body

requestBody
required

Cashflowrule
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while insert resource rate.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rates
Request body
{
  "arrivalDateFrom" : "01-01-2023",
  "arrivalDateTo" : "01-01-2023",
  "bookdateFrom" : "01-01-2023T11:23:45Z",
  "bookdateTo" : "01-01-2023T11:23:45Z",
  "cashflowruleId" : 1,
  "daysOfWeek" : [ "string" ],
  "duration" : 1,
  "maxDeviation" : 1,
  "maxDuration" : 1,
  "maxUnit" : 1,
  "minDeviation" : 1,
  "minDuration" : 1,
  "minUnit" : 1,
  "priority" : 1,
  "quantifier" : "string",
  "rateLevelId" : 1,
  "rateOptionId" : 1,
  "rateTypeIds" : [ "integer" ],
  "remark" : "string",
  "repeatable" : 1,
  "resourceId" : 1,
  "status" : 1,
  "stay" : 1,
  "translations" : [ {
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "usageDowList" : [ "string" ],
  "usageDurationFrom" : 1,
  "usageDurationTo" : 1,
  "usageUnitFrom" : 1,
  "usageUnitTo" : 1,
  "validFrom" : "01-01-2023",
  "validTo" : "01-01-2023",
  "value" : 1,
  "valueType" : "string"
}
Example HTTP response

5.1.41. Search accommodationtypes based on provided criteria

POST /maxxton/v1/accommodationtypes/search
Description

The above endpoint is used to search through the availability of the whole inventory based on all accommodation types, this can be filtered by providing request criteria. For example: arrival date , duration , resort , accommodation type , amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals , departures , resorts and amenities as per the criteria passed in the request. If "Includeallprices" field is passed as true in the request, it will provide 10 records in the response this is only possible for one specific resourceId, if it is provided as false, then only the first record is displayed in the response.
In case of prebooking, the prices returned would be null.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.
The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It’s up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay. See below diagram for an explanation on how the alternative stays work:
DateMarginFlowDiagram role="text-center"

Parameters
Type Name Description Schema

Body

requestBody
required

SearchRequestFilter

Query

defaultSelection
optional

single possible value - nearest_arrival [First available arrival if no arrival date is provided based on todays date, by default sort is based on cheapest_price]

string

Query

sort
optional

Sort parameter is used to sort the response in ascending or descending order on the basis of offer price, offer price inclusive and priority. In order to sort the response in ascending order of offer price 'offer_price_asc' is used and to sort in descending order the value of sort that should be passed is 'offer_price_desc' similarly offer_price_inclusive_asc and offer_price_inclusive_desc can be used to sort on offer price inclusive like wise priority_asc and priority_desc can be used to sort on priority.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

ResourceAvailabilityResponse

400

  1. Either offerCode or voucherCode should be passed

  2. The dateMargin parameter cannot be used in combination with includeAllPrices parameter

  3. The includeAllPrices parameter cannot be used without a resourceId.

No Content

500

Error occurred while fetching accommodationTypes

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/search
Request body
{
  "accommodationKindIds" : [ "integer" ],
  "amenityIds" : [ "integer" ],
  "arrivalDate" : "01-01-2023",
  "dateMargin" : 1,
  "dateMarginMethod" : "string",
  "distributionChannelId" : 1,
  "duration" : 1,
  "filterOptions" : [ "string" ],
  "includeAllPrices" : true,
  "includeFilterOptionCounts" : true,
  "maxNrOfBathrooms" : 1,
  "maxNrOfBedrooms" : 1,
  "minNrOfBathrooms" : 1,
  "minNrOfBedrooms" : 1,
  "offerCode" : "string",
  "offerId" : 1,
  "petQuantity" : 1,
  "qualityLevelIds" : [ "integer" ],
  "redeemableLoyaltyPoints" : 1,
  "regionId" : 1,
  "resortIds" : [ "integer" ],
  "resourceIds" : [ "integer" ],
  "subjects" : {
    "persons" : [ {
      "maxAge" : "string",
      "quantity" : 1
    } ]
  },
  "voucherCode" : "string"
}
Example HTTP response
Response 200
{
  "filterOptionsResult" : {
    "accommodationKinds" : [ "object" ],
    "amenities" : [ "object" ],
    "arrivals" : [ "string" ],
    "departures" : [ "string" ],
    "qualityLevels" : [ "integer" ],
    "resorts" : [ "object" ]
  },
  "result" : {
    "content" : [ {
      "accommodationKindId" : 1,
      "arrivalDate" : "01-01-2023",
      "basePrice" : 1,
      "basePriceInclusive" : 1,
      "departureDate" : "01-01-2023",
      "duration" : 1,
      "freeLoyaltyDuration" : 1,
      "loyaltyPrice" : 1,
      "loyaltyPriceInclusive" : 1,
      "nrOfBathrooms" : 1,
      "nrOfBedrooms" : 1,
      "offerCode" : "string",
      "offerName" : "string",
      "offerPrice" : 1,
      "offerPriceInclusive" : 1,
      "priority" : 1,
      "qualityLevelId" : 1,
      "rateTypeId" : 1,
      "rating" : 1,
      "referencePrice" : 1,
      "referencePriceInclusive" : 1,
      "requiredLoyaltyPoints" : 1,
      "resortId" : 1,
      "resourceId" : 1,
      "totalCapacity" : 1,
      "units" : [ "integer" ]
    } ],
    "empty" : true,
    "first" : true,
    "last" : true,
    "number" : 1,
    "numberOfElements" : 1,
    "size" : 1,
    "sort" : {
      "empty" : true,
      "sorted" : true,
      "unsorted" : true
    },
    "totalElements" : 1,
    "totalPages" : 1
  }
}

5.1.42. Update/insert accommodation dynamic field

PUT /maxxton/v1/accommodationtypes/{resourceId}/dynamicfields/{fieldId}
Description

The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for accommodation type, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the accommodation type, then the text field will be modified

Parameters
Type Name Description Schema

Path

resourceId
required

resourceId to fetch accommodationtypedetail

integer (int64)

Body

requestBody
required

< DynamicFieldDataCriteria
> array

Path

fieldId
required

fieldId to fetch dynamic field

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while fetching updating/inserting the accommodation dynamic fields.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/dynamicfields/{fieldId}
Request body
[ {
  "language" : "string",
  "text" : "string"
} ]
Example HTTP response

5.1.43. Updates an accommodation type on a specific resource id.

PUT /maxxton/v1/accommodationtypes/{resourceId}
Description

Updates accommodation types based on its resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id to update accommodationtype

integer (int64)

Body

requestBody
required

Body to update accommodationType

UpdateAccommodationTypeRequest
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while fetching AccommodationType.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}
Request body
{
  "accotypeKindId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "brandId" : 1,
  "checkinTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "checkoutTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "code" : "string",
  "earlyCheckinTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "lateCheckoutTime" : {
    "hour" : 1,
    "minute" : 1,
    "nano" : 1,
    "second" : 1
  },
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "priority" : 1,
  "resortId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ]
}
Example HTTP response

5.2. AddOn

Extras and products that can be booked with an accommodation type

5.2.1. Get implies of add-ons

GET /maxxton/v1/add-ons/implies
Description

Get page with implies of add-ons.The records can be filtered based on implies object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

500

Error occurred while fetching implies of add-ons.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.2. Gets Add-on additions by addition resource id

GET /maxxton/v1/add-ons/{additionResourceId}/additions
Description

Gets a page with add-ons additions.The additions of an add-on will provide all accommodation types where the add-on is applicable to.The records can be filtered based on resource addition object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
bookDateFrom:String(date),
bookDateTo:String(date),
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Path

additionResourceId
required

resourceId of add-on for which additions are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageTemporaryResourceAddition

500

Error occurred while fetching add-ons additions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/{additionResourceId}/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "additionFast" : true,
    "additionId" : 1,
    "additionResourceId" : 1,
    "addonType" : "string",
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "mandatoryResource" : true,
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "maxTotalQuantity" : 1,
    "priceCompare" : true,
    "resortArticle" : true,
    "resourceId" : 1,
    "resourceMoment" : [ "string" ],
    "supplierAdditionId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.3. Gets Add-ons additions

GET /maxxton/v1/add-ons/additions
Description

Gets a page with add-ons additions. The records can be filtered based on resource addition object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
bookDateFrom:String(date),
bookDateTo:String(date),
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageTemporaryResourceAddition

500

Error occurred while fetching add-ons additions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "additionFast" : true,
    "additionId" : 1,
    "additionResourceId" : 1,
    "addonType" : "string",
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "mandatoryResource" : true,
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "maxTotalQuantity" : 1,
    "priceCompare" : true,
    "resortArticle" : true,
    "resourceId" : 1,
    "resourceMoment" : [ "string" ],
    "supplierAdditionId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.4. Gets a page with add-ons

GET /maxxton/v1/add-ons
Description

Gets page with add-ons.The records can be filtered based on add-on object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
code:String,
resortId:0,
parentId:0,
path:String,
cashflowManagerId:0,
allowPriceOverride:true,
source:String,
showNilPriceOnBill:true,
powerplaygroupId:0,
allowMovingToMainBill:true,
archivedFrom:String(date),
specialPriority:0,
type:String,
resortArticle:true,
customizable:true,
showDatesOnInternet:true,
allowToAddInCiCo:true,
implicationManagerId:0,
ledgerId:0,
ledgerGroupId:0,
dependsOnLedgerGroup:true,
dependencyMask:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAddOn_Detail

500

Error occurred while fetching add-ons.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons
Example HTTP response
Response 200
{
  "content" : [ {
    "addonType" : "string",
    "adjustment" : true,
    "allowMovingToMainBill" : true,
    "allowPriceOverride" : true,
    "allowToAddInCiCo" : true,
    "archivedFrom" : "01-01-2023",
    "autoValidate" : true,
    "autoValidateValue" : 1,
    "cancelCompensation" : true,
    "cancelPremium" : true,
    "cashArticle" : true,
    "cashflowManagerId" : 1,
    "code" : "string",
    "commission" : true,
    "commissionVatIncluded" : true,
    "correction" : true,
    "customizable" : true,
    "dayAddon" : true,
    "dependencyMask" : "string",
    "dependsOnLedgerGroup" : true,
    "description" : "string",
    "earlyCheckin" : true,
    "excludePriceCache" : true,
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "shortDescription" : "string"
    } ],
    "implicationManagerId" : 1,
    "invoiceArticle" : true,
    "ledgerGroupId" : 1,
    "ledgerId" : 1,
    "maxQuantity" : 1,
    "name" : "string",
    "ownerArticle" : true,
    "parentId" : 1,
    "path" : "string",
    "perDay" : true,
    "powerplaygroupId" : 1,
    "repaymentVoucher" : true,
    "reservationArticle" : true,
    "resortArticle" : true,
    "resortId" : 1,
    "resourceId" : 1,
    "searchCode" : "string",
    "shortDescription" : "string",
    "showDatesOnInternet" : true,
    "showNilPriceOnBill" : true,
    "source" : "string",
    "specialPriority" : 1,
    "stayArticle" : true,
    "stockType" : "string",
    "tax" : true,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "vatCommission" : true,
    "warrant" : true,
    "withholdingArticle" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.5. Gets add-ons for specific resource id

GET /maxxton/v1/add-ons/{resourceId}
Description

Gets add-ons by resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

AddOn_Detail

500

Error occurred while fetching add-ons for the given resource id.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}
Example HTTP response
Response 200
{
  "addonType" : "string",
  "adjustment" : true,
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToAddInCiCo" : true,
  "archivedFrom" : "01-01-2023",
  "autoValidate" : true,
  "autoValidateValue" : 1,
  "cancelCompensation" : true,
  "cancelPremium" : true,
  "cashArticle" : true,
  "cashflowManagerId" : 1,
  "code" : "string",
  "commission" : true,
  "commissionVatIncluded" : true,
  "correction" : true,
  "customizable" : true,
  "dayAddon" : true,
  "dependencyMask" : "string",
  "dependsOnLedgerGroup" : true,
  "description" : "string",
  "earlyCheckin" : true,
  "excludePriceCache" : true,
  "i18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "implicationManagerId" : 1,
  "invoiceArticle" : true,
  "ledgerGroupId" : 1,
  "ledgerId" : 1,
  "maxQuantity" : 1,
  "name" : "string",
  "ownerArticle" : true,
  "parentId" : 1,
  "path" : "string",
  "perDay" : true,
  "powerplaygroupId" : 1,
  "repaymentVoucher" : true,
  "reservationArticle" : true,
  "resortArticle" : true,
  "resortId" : 1,
  "resourceId" : 1,
  "searchCode" : "string",
  "shortDescription" : "string",
  "showDatesOnInternet" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "specialPriority" : 1,
  "stayArticle" : true,
  "stockType" : "string",
  "tax" : true,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "vatCommission" : true,
  "warrant" : true,
  "withholdingArticle" : true
}

5.2.6. Gets dynamic fields for a particular addon

GET /maxxton/v1/add-ons/{resourceId}/dynamicfields
Description

Gets a page with dynamic fields to a specific addon. The records can be filtered based on the DynamicField object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fieldId:0,
code:String,
type:String)

Path

resourceId
required

Resource id of addon for which dynamic fields are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDynamicField

500

Error occurred while fetching addon dynamic fields.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/dynamicfields
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.7. Gets images for a particular addon

GET /maxxton/v1/add-ons/{resourceId}/images
Description

Gets a page with images to a specific addon. The records can be filtered based on the image object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileName:String,
imageId:0,
startDate:String(date),
endDate:String(date),
mimeType:String,
version:0,
url:String,
uploadDate:String(date),
imageType:String,
imageOrientation:String,
modifiedDate:String(date))

Path

resourceId
required

Resource id of add-on for which images are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImage

404

add-ons is not found.

No Content

500

Error occurred while fetching addon images.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/images
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.8. Gets implies of add-ons

GET /maxxton/v1/add-ons/{resourceId}/implies
Description

Gets implies of add-ons.The records can be filtered based on implies object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

ResourceId of offer for which the implies needs to be fetched.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

500

Error occurred while fetching implies of add-ons.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.2.9. Update/insert addon dynamic field

PUT /maxxton/v1/add-ons/{resourceId}/dynamicfields/{fieldId}
Description

The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for addon, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the addon, then the text field will be modified

Parameters
Type Name Description Schema

Path

resourceId
required

resourceId to update or insert dynamic field

integer (int64)

Body

requestBody
required

< DynamicFieldDataCriteria
> array

Path

fieldId
required

fieldId to update dynamic field

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors.

No Content

500

Error occurred while fetching updating/inserting the addon dynamic fields.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/dynamicfields/{fieldId}
Request body
[ {
  "language" : "string",
  "text" : "string"
} ]
Example HTTP response

5.3. AdminOrganisation

List of AdminOrganisation

5.3.1. Gets a page with revenue distribution journal of admin organisation

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}/journals
Description
Gets a page with revenue distribution journal  of admin organisation. The records can be filtered based on the RevenueDistributionJournal object.
Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
description:String,
journalType:String,
journalNumber:String,
journalPeriodNumber:0,
ledgerNumber:String,
costCenter:String,
costUnit:String,
secondLedgerNumber:String,
debitVatIncludedDistributionChannelCurrency:String,
creditVatIncludedDistributionChannelCurrency:String,
debitVatExcludedDistributionChannelCurrency:String,
creditVatExcludedDistributionChannelCurrency:String,
debitVatIncluded:String,
creditVatIncluded:String,
debitVatExcluded:String,
creditVatExcluded:String,
exchangeValue:0,
distributionChannelCurrencyCode:String,
distributionChannelCurrencyId:0,
adminCurrencyCode:String,
adminCurrencyId:0,
adminOrganistationCurrency:String,
distributionchannelCurrency:String,
revenueDistributionJournalId:0)

Path

adminOrganisationId
required

Id of the admin organisation for which revenue distribution journals has to be fetched

integer (int64)

Path

revenueDistributionId
required

revenue distribution id for which revenue distribution journals has to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRevenueDistributionJournal

500

Error occurred while fethcing revenue distribution journals of admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}/journals
Example HTTP response
Response 200
{
  "content" : [ {
    "adminCurrencyCode" : "string",
    "adminCurrencyId" : 1,
    "adminOrganisationId" : 1,
    "adminOrganistationCurrency" : {
      "creditVatExcluded" : 1,
      "creditVatIncluded" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "debitVatExcluded" : 1,
      "debitVatIncluded" : 1
    },
    "costCenter" : "string",
    "costUnit" : "string",
    "creditVatExcluded" : 1,
    "creditVatExcludedDistributionChannelCurrency" : 1,
    "creditVatIncluded" : 1,
    "creditVatIncludedDistributionChannelCurrency" : 1,
    "debitVatExcluded" : 1,
    "debitVatExcludedDistributionChannelCurrency" : 1,
    "debitVatIncluded" : 1,
    "debitVatIncludedDistributionChannelCurrency" : 1,
    "description" : "string",
    "distributionChannelCurrencyCode" : "string",
    "distributionChannelCurrencyId" : 1,
    "distributionchannelCurrency" : {
      "creditVatExcluded" : 1,
      "creditVatIncluded" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "debitVatExcluded" : 1,
      "debitVatIncluded" : 1,
      "exchangeRate" : 1
    },
    "exchangeValue" : 1,
    "journalNumber" : "string",
    "journalPeriodNumber" : 1,
    "journalType" : "string",
    "ledgerNumber" : "string",
    "revenueDistributionId" : 1,
    "revenueDistributionJournalId" : 1,
    "secondLedgerNumber" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.2. Create new admin organisation

POST /maxxton/v1/adminorganisations
Parameters
Type Name Description Schema

Body

requestBody
required

CreateAdminOrganisationRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

AdminOrganisation

500

Error occurred while creating admin organisation.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations
Request body
{
  "code" : "string",
  "currencyId" : 1,
  "description" : "string",
  "name" : "string",
  "origin" : "string",
  "originId" : "string"
}
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "code" : "string",
  "currencyCode" : "string",
  "currencyId" : 1,
  "description" : "string",
  "journalId" : 1,
  "name" : "string",
  "origin" : "string",
  "originId" : "string"
}

5.3.3. Gets a page with Accounts of an admin organisation

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/accounts
Description

Gets a page with Accounts of an admin organisation. The records can be filtered based on the account object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
accountId:0,
name:String,
currencyId:0,
currencyCode:String,
bankAccount:String)

Path

adminOrganisationId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAccount

500

Error occurred while fetching accounts of the admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/accounts
Example HTTP response
Response 200
{
  "content" : [ {
    "accountId" : 1,
    "bankAccount" : {
      "bankAccountName" : "string",
      "code" : "string",
      "currencyCode" : "string",
      "name" : "string",
      "paymentMethodDefinition" : {
        "brandName" : "string",
        "code" : "string",
        "name" : "string"
      }
    },
    "currencyCode" : "string",
    "currencyId" : 1,
    "name" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.4. Gets a page with admin organisations

GET /maxxton/v1/adminorganisations
Description

Gets a page with admin organisations. The records can be filtered based on the adminorganisation object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
adminOrganisationId:0,
name:String,
description:String,
code:String,
currencyId:0,
currencyCode:String,
origin:String,
originId:String,
journalId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAdminOrganisation

500

Error occurred while fetching admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : 1,
    "code" : "string",
    "currencyCode" : "string",
    "currencyId" : 1,
    "description" : "string",
    "journalId" : 1,
    "name" : "string",
    "origin" : "string",
    "originId" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.5. Gets a page with financial transactions

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions
Description

Gets a page with financial transactions.The records can be filtered based on the FinancialTransactionReport object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
financialTransactionReportId:0,
reportNumber:0,
creationDate:String(date),
status:String,
companyId:0)

Path

adminOrganisationId
required

Id of the admin organisation for which financial transactions has to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageFinancialTransactionReport

500

Error occurred while fetching financial transactions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : 1,
    "companyId" : 1,
    "creationDate" : "01-01-2023T11:23:45Z",
    "financialTransactionReportId" : 1,
    "reportNumber" : 1,
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.6. Gets a page with financial transactions journal report of admin organisation

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}/journals
Description

Gets a page with financial transactions journal report of admin organisation. The records can be filtered based on the FinancialTransactionJournalsReport object.
The field statementHeader in the response denotes the start of a statement.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
status:String,
description:String,
journalType:String,
journalNumber:String,
journalPeriodNumber:String,
statementNumber:String,
statementDate:String(date),
ledgerNumber:String,
costCenter:String,
costUnit:String,
secondLedgerNumber:String,
debitVatIncluded:String,
creditVatIncluded:String,
debitVatExcluded:String,
creditVatExcluded:String,
debitVatIncludedAccCurr:String,
creditVatIncludedAccCurr:String,
debitVatExcludedAccCurr:String,
creditVatExcludedAccCurr:String,
accountCurrencyId:0,
exchangeValue:0,
accountId:0,
accountCurrencyCode:String,
adminCurrencyCode:String,
adminCurrencyId:0,
adminOrganistationCurrency:String,
accountCurrency:String,
statementHeader:true,
financialTransactionReportJournalId:0)

Path

adminOrganisationId
required

Id of the admin organisation for which financial transactions journals report has to be fetched

integer (int64)

Path

financialTransactionReportId
required

Financial transaction report id for which financial transactions journals report has to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageFinancialTransactionJournalsReport

500

Error occurred while fetching financial transaction journals report of admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}/journals
Example HTTP response
Response 200
{
  "content" : [ {
    "accountCurrency" : {
      "creditVatExcluded" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "debitVatExcluded" : 1,
      "debitVatIncluded" : 1,
      "exchangeRate" : 1,
      "getcreditVatIncluded" : 1
    },
    "accountCurrencyCode" : "string",
    "accountCurrencyId" : 1,
    "accountId" : 1,
    "adminCurrencyCode" : "string",
    "adminCurrencyId" : 1,
    "adminOrganisationId" : 1,
    "adminOrganistationCurrency" : {
      "creditVatExcluded" : 1,
      "creditVatIncluded" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "debitVatExcluded" : 1,
      "debitVatIncluded" : 1
    },
    "costCenter" : "string",
    "costUnit" : "string",
    "creditVatExcluded" : 1,
    "creditVatExcludedAccCurr" : 1,
    "creditVatIncluded" : 1,
    "creditVatIncludedAccCurr" : 1,
    "debitVatExcluded" : 1,
    "debitVatExcludedAccCurr" : 1,
    "debitVatIncluded" : 1,
    "debitVatIncludedAccCurr" : 1,
    "description" : "string",
    "exchangeValue" : 1,
    "financialTransactionReportId" : 1,
    "financialTransactionReportJournalId" : 1,
    "journalNumber" : "string",
    "journalPeriodNumber" : "string",
    "journalType" : "string",
    "ledgerNumber" : "string",
    "secondLedgerNumber" : "string",
    "statementDate" : "01-01-2023",
    "statementHeader" : true,
    "statementNumber" : "string",
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.7. Gets a page with owner financial transaction journals details of admin organisation

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals/entries
Description

Detailed journal entries of the owner financial transaction report. All details from this endpoint summed will be the total journal entry. Based on the settlementId and settlementEntryId the owner settlement and it’s entries can be retrieved. The records can be filtered based on the OwnerFinancialTransactionJournalsDetailReport object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
settlementId:0,
settlementEntryId:0,
ledgerId:0,
ledgerNumber:String,
ledgerName:String,
costCenterId:0,
costCenterNumber:String,
costCenterName:String,
costUnitId:0,
costUnitNumber:String,
costUnitName:String,
secondLedgerId:0,
secondLedgerNumber:String,
secondLedgerName:String,
ownerCurrencyId:0)

Path

adminOrganisationId
required

Id of the admin organisation for which owner financial transactions journals report has to be fetched

integer (int64)

Path

ownerFinancialTransactionReportId
required

Financial transaction report id for which owner financial transactions journals report has to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerFinancialTransactionJournalsDetails

500

Error occurred while fethcing owner financial transaction journals report details of admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals/entries
Example HTTP response
Response 200
{
  "content" : [ {
    "costCenterId" : 1,
    "costCenterName" : "string",
    "costCenterNumber" : "string",
    "costUnitId" : 1,
    "costUnitName" : "string",
    "costUnitNumber" : "string",
    "creditVatExcluded" : 1,
    "creditVatIncluded" : 1,
    "debitVatExcluded" : 1,
    "debitVatIncluded" : 1,
    "ledgerId" : 1,
    "ledgerName" : "string",
    "ledgerNumber" : "string",
    "ownerCurrencyId" : 1,
    "ownerFinancialTransactionReportId" : 1,
    "secondLedgerId" : 1,
    "secondLedgerName" : "string",
    "secondLedgerNumber" : "string",
    "settlementEntryId" : 1,
    "settlementId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.8. Gets a page with owner financial transactions

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions
Description

Gets a page with owner financial transactions.The records can be filtered based on the OwnerFinancialTransaction object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerFinancialTransactionReportId:0,
reportNumber:0,
creationDate:String(date),
bookDate:String(date),
status:String)

Path

adminOrganisationId
required

Id of the admin organisation for which owner financial transactions has to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerFinancialTransaction

500

Error occurred while fetching owner financial transactions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions
Example HTTP response
Response 200
{
  "content" : [ {
    "bookDate" : "01-01-2023",
    "creationDate" : "01-01-2023T11:23:45Z",
    "ownerFinancialTransactionReportId" : 1,
    "reportNumber" : 1,
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.9. Gets a page with owner financial transactions journal report of admin organisation

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals
Description

Gets a page with owner financial transactions journal report of admin organisation. The records can be filtered based on the OwnerFinancialTransactionJournalsReport object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
status:String,
description:String,
journalType:String,
journalNumber:String,
journalPeriodNumber:0,
statementNumber:String,
statementDate:String(date),
ledgerNumber:String,
costCenter:String,
costUnit:String,
secondLedgerNumber:String,
debitVatIncluded:String,
creditVatIncluded:String,
debitVatExcluded:String,
creditVatExcluded:String,
debitVatIncludedInAdminOrganisationCurrency:String,
creditVatIncludedInAdminOrganisationCurrency:String,
debitVatExcludedInAdminOrganisationCurrency:String,
creditVatExcludedInAdminOrganisationCurrency:String,
ownerCurrencyId:0,
ownerCrrencyCode:String,
exchangeValue:0,
accountId:0,
adminOrganisationCurrencyId:0,
adminOrganisationCurrencyCode:String,
adminOrganisationCurrency:String,
ownerCurrency:String)

Path

adminOrganisationId
required

Id of the admin organisation for which owner financial transactions journals report has to be fetched

integer (int64)

Path

ownerFinancialTransactionReportId
required

Financial transaction report id for which owner financial transactions journals report has to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerFinancialTransactionJournalsReport

500

Error occurred while fethcing owner financial transaction journals report of admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals
Example HTTP response
Response 200
{
  "content" : [ {
    "accountId" : 1,
    "adminOrganisationCurrency" : {
      "creditVatExcluded" : 1,
      "creditVatIncluded" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "debitVatExcluded" : 1,
      "debitVatIncluded" : 1
    },
    "adminOrganisationCurrencyCode" : "string",
    "adminOrganisationCurrencyId" : 1,
    "costCenter" : "string",
    "costUnit" : "string",
    "creditVatExcluded" : 1,
    "creditVatExcludedInAdminOrganisationCurrency" : 1,
    "creditVatIncluded" : 1,
    "creditVatIncludedInAdminOrganisationCurrency" : 1,
    "debitVatExcluded" : 1,
    "debitVatExcludedInAdminOrganisationCurrency" : 1,
    "debitVatIncluded" : 1,
    "debitVatIncludedInAdminOrganisationCurrency" : 1,
    "description" : "string",
    "exchangeValue" : 1,
    "journalNumber" : "string",
    "journalPeriodNumber" : 1,
    "journalType" : "string",
    "ledgerNumber" : "string",
    "ownerCrrencyCode" : "string",
    "ownerCurrency" : {
      "creditVatExcluded" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "debitVatExcluded" : 1,
      "debitVatIncluded" : 1,
      "exchangeRate" : 1,
      "getcreditVatIncluded" : 1
    },
    "ownerCurrencyId" : 1,
    "secondLedgerNumber" : "string",
    "statementDate" : "01-01-2023",
    "statementNumber" : "string",
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.10. Gets a page with revenue distributions of an admin organisation

GET /maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions
Description

Gets a page with revenue distributions of an admin organisation. The records can be filtered based on the RevenueDistribution object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
revenueDistributionId:0,
revenueDistributionNumber:0,
creationDate:String(date),
adminOrganisationId:0,
status:String,
bookDate:String(date))

Path

adminOrganisationId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRevenueDistribution

500

Error occurred while fetching revenue distributions of the admin organisations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : 1,
    "bookDate" : "01-01-2023T11:23:45Z",
    "creationDate" : "01-01-2023T11:23:45Z",
    "revenueDistributionId" : 1,
    "revenueDistributionNumber" : 1,
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.3.11. Update existing admin organisation

PUT /maxxton/v1/adminorganisations/{adminOrganisationId}
Parameters
Type Name Description Schema

Path

adminOrganisationId
required

integer (int64)

Body

requestBody
required

UpdateAdminOrganisationRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

UpdateAdminOrganisationRequest

500

Error occurred while updating admin organisation.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}
Request body
{
  "code" : "string",
  "currencyId" : 1,
  "description" : "string",
  "name" : "string",
  "origin" : "string",
  "originId" : "string"
}
Example HTTP response
Response 200
{
  "code" : "string",
  "currencyId" : 1,
  "description" : "string",
  "name" : "string",
  "origin" : "string",
  "originId" : "string"
}

5.3.12. Update’s the revenue distribution of specific admin organisation id and revenue distribution id

PUT /maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}
Description

Updates the revenue distribution of specific admin organisation id and revenue distribution id

Parameters
Type Name Description Schema

Path

adminOrganisationId
required

Id of the admin organisation for which revenue distribution has to be updated

integer (int64)

Body

requestBody
required

Body to update revenue distribution

UpdateRevenueDistributionRequest

Path

revenueDistributionId
required

Revenue distribution id for which revenue distribution has to be updated

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

RevenueDistribution

500

Error occurred while updating revenue distribution.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}
Request body
{
  "status" : "string"
}
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "bookDate" : "01-01-2023T11:23:45Z",
  "creationDate" : "01-01-2023T11:23:45Z",
  "revenueDistributionId" : 1,
  "revenueDistributionNumber" : 1,
  "status" : "string"
}

5.3.13. Updates the owner financial transactions for specific admin organisation id and owner financial transaction id

PUT /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionId}
Description

Updates the owner financial transactions for specific admin organisation id and owner financial transaction id

Parameters
Type Name Description Schema

Path

adminOrganisationId
required

Id of the admin organisation for which owner financial transactions has to be updated

integer (int64)

Path

ownerFinancialTransactionId
required

Id of the owner financial transaction for which owner financial transactions has to be updated

integer (int64)

Body

requestBody
required

Body of the owner financial transaction to be updated

UpdateOwnerFinancialTransactionRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

OwnerFinancialTransaction

500

Error occurred while updating owner financial transactions.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionId}
Request body
{
  "status" : "string"
}
Example HTTP response
Response 200
{
  "bookDate" : "01-01-2023",
  "creationDate" : "01-01-2023T11:23:45Z",
  "ownerFinancialTransactionReportId" : 1,
  "reportNumber" : 1,
  "status" : "string"
}

5.3.14. update’s the financial transactions report of specific admin organisation id and financial transaction report id

PUT /maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}
Description

updates financial transactions report of specific admin organisation id and financial transaction report id

Parameters
Type Name Description Schema

Path

adminOrganisationId
required

Id of the admin organisation for which financial transactions has to be fetched

integer (int64)

Path

financialTransactionReportId
required

Financial transaction report id for which financial transactions has to be fetched

integer (int64)

Body

requestBody
required

Body to update financial transaction report

UpdateFinancialReportRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

FinancialTransactionReport

500

Error occurred while updating financial transactions.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}
Request body
{
  "status" : "string"
}
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "companyId" : 1,
  "creationDate" : "01-01-2023T11:23:45Z",
  "financialTransactionReportId" : 1,
  "reportNumber" : 1,
  "status" : "string"
}

5.4. Allotment

Guaranteed availability for a specific distribution channel

5.4.1. Get allotment releases

GET /maxxton/v1/allotments/releases
Description

Allotment releases are rules which needs to be combined with allotment to release the allotment so it will be available to other distribution channels again. This can be done partially or totally. The allotment rules will not be removed in case it is released because of this it should be combined with the allotment call.<r>The difference between removing allotment and releasing allotment is that when you remove the allotment its gone, when it is released it can reduce the allotment or completely removeit. If there are 4 units available in allotment, 2 are released. That would mean 2 units are still available from allotment.It also supports pageable.The allotment release is active when the performedDate is not null and enactive is false. isEnactive is true when the allotment release is removed.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentReleaseId:0,
distributionChannelId:0,
name:String,
startDate:String(date),
endDate:String(date),
releasePeriod:0,
releaseDate:String(date),
performedDate:String(date),
resourceId:0,
resortId:0,
isEnactive:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAllotmentRelease

204

No allotment releases found for given criteria.

No Content

500

Error occurred while fetching allotment releases

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/allotments/releases
Example HTTP response
Response 200
{
  "content" : [ {
    "allotmentReleaseId" : 1,
    "distributionChannelId" : 1,
    "endDate" : "01-01-2023",
    "isEnactive" : true,
    "name" : "string",
    "performedDate" : "01-01-2023",
    "releaseDate" : "01-01-2023",
    "releasePeriod" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.4.2. Get allotments

GET /maxxton/v1/allotments
Description

Gets a page with allotments. The allotment is active when not removed(isEnactive false) and no allotment release rules are valid(allotment can be released partially). A distribution channel is only allowed to book from allotment or the usual reservability not both.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentId:0,
distributionChannelId:0,
resourceId:0,
name:String,
description:String,
type:String,
exceedLimit:0,
expirePeriod:0,
amount:0,
modified:String(date),
isEnactive:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAllotment

204

No allotments found for given criteria.

No Content

500

Error occurred while fetching allotments

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/allotments
Example HTTP response
Response 200
{
  "content" : [ {
    "allotmentId" : 1,
    "amount" : 1,
    "description" : "string",
    "distributionChannelId" : 1,
    "exceedLimit" : 1,
    "expirePeriod" : 1,
    "hasObjects" : true,
    "isEnactive" : true,
    "modified" : "01-01-2023",
    "name" : "string",
    "periods" : [ {
      "endDate" : "01-01-2023",
      "quantity" : 1,
      "startDate" : "01-01-2023",
      "unitIds" : [ "integer" ]
    } ],
    "resourceId" : 1,
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.5. Amenity

Features or facilities available on a resort or an accommodation type

5.5.1. Add new amenities

POST /maxxton/v1/amenities
Description

Adds new amenities.

Parameters
Type Name Description Schema

Body

requestBody
required

Request body to create new amenity.

CreateAmenity
Responses
Code Description Schema

200

The request is completed successfully without any errors

AmenityResponse

500

Error occurred while adding amenities.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/amenities
Request body
{
  "amenityCategoryIds" : [ "integer" ],
  "amenityStandardCode" : "string",
  "childAmenityIds" : [ "integer" ],
  "code" : "string",
  "linkedAmenityId" : 1,
  "numberMaximum" : 1,
  "numberMinimum" : 1,
  "origin" : "string",
  "originId" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ],
  "type" : "string"
}
Example HTTP response
Response 200
{
  "amenityCategoryIds" : [ "integer" ],
  "amenityId" : 1,
  "amenityStandardCode" : "string",
  "childAmenityIds" : [ "integer" ],
  "code" : "string",
  "linkedAmenityId" : 1,
  "numberMaximum" : 1,
  "numberMinimum" : 1,
  "origin" : "string",
  "originId" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "type" : "string"
}

5.5.2. Gets a page with Amenities

GET /maxxton/v1/amenities
Description

Gets a page with amenities.The records can be filtered based on amenity object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityId:0,
type:String,
identifier:String,
listMulti:true,
numberMinimum:0,
numberMaximum:0,
percentageDiscountPriority:0,
source:String,
standardCodeAmenityId:0,
linkedAmenityId:0,
parentAmenityId:0,
archivedFrom:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAmenity

500

Error occurred while fetching Amenities.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/amenities
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityCategoryIds" : [ "integer" ],
    "amenityId" : 1,
    "archivedFrom" : "01-01-2023",
    "categories" : [ {
      "amenityCategoryId" : 1,
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "isInternalUse" : true,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "endDate" : "01-01-2023",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "identifier" : "string",
    "linkedAmenityId" : 1,
    "listMulti" : true,
    "metric" : {
      "code" : "string",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "metricId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "metricDetail" : {
      "code" : "string",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "metricId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "numberMaximum" : 1,
    "numberMinimum" : 1,
    "parentAmenityId" : 1,
    "percentageDiscountPriority" : 1,
    "source" : "string",
    "standardCodeAmenityId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.5.3. Gets a page with amenity categories

GET /maxxton/v1/amenities/categories
Description

Gets a page with amenity categories.The records can be filtered based on category set object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityCategorySetId:0,
code:String,
priority:0)

Query

returnSections
optional

To return only the selected sections in the response, use the constant string IMAGES. This can reduce the response body size and improve the performance of the call.

< string > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCategorySet

500

Error occurred while fetching amenity categories.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/amenities/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityCategories" : [ {
      "amenityCategoryId" : 1,
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "isInternalUse" : true,
      "priority" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "amenityCategorySetId" : 1,
    "code" : "string",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "imageManagerId" : 1,
    "images" : [ {
      "endDate" : "01-01-2023",
      "fileName" : "string",
      "hostType" : "string",
      "imageId" : 1,
      "imageManagerId" : 1,
      "imageManagerIds" : [ "integer" ],
      "imageOrientation" : "string",
      "imageType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "mimeType" : "string",
      "modifiedDate" : "01-01-2023T11:23:45Z",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "tags" : [ {
        "name" : "string",
        "tagId" : 1
      } ],
      "thumbnailUrl" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "uploadDate" : "01-01-2023T11:23:45Z",
      "url" : "string",
      "version" : 1
    } ],
    "isInternalUse" : true,
    "parentId" : 1,
    "priority" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.5.4. Gets a page with amenity categories

GET /maxxton/v1/amenities/details
Description

Gets a page with amenity categories.The records can be filtered based on category set object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityCategorySetId:0,
code:String,
priority:0)

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are IMAGES. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAmenityTreeDetail

500

Error occurred while fetching amenity categories.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/amenities/details
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityCategories" : [ {
      "amenities" : [ {
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "identifier" : "string",
        "imageManagerId" : 1,
        "images" : [ {
          "endDate" : "01-01-2023",
          "fileName" : "string",
          "hostType" : "string",
          "imageId" : 1,
          "imageManagerId" : 1,
          "imageManagerIds" : [ "integer" ],
          "imageOrientation" : "string",
          "imageType" : "string",
          "isActive" : true,
          "isUploaded" : true,
          "isWebPresentation" : true,
          "mediaLanguageId" : 1,
          "mediaType" : "string",
          "mimeType" : "string",
          "modifiedDate" : "01-01-2023T11:23:45Z",
          "sequenceNumber" : 1,
          "startDate" : "01-01-2023",
          "tags" : [ { } ],
          "thumbnailUrl" : "string",
          "translations" : [ { } ],
          "uploadDate" : "01-01-2023T11:23:45Z",
          "url" : "string",
          "version" : 1
        } ],
        "managerId" : 1,
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityCategoryId" : 1,
      "amenityGroups" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "identifier" : "string",
        "managerId" : 1,
        "metric" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "priority" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "amenityCategorySetId" : 1,
    "code" : "string",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "isInternalUse" : true,
    "parentId" : 1,
    "priority" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.6. Authentication

Authentication

5.6.1. Login

POST /maxxton/v1/authenticate
Description

Returns generated access token. This can be used in further calls to authenticate by adding this to the header parameters with key: Authorization and value: {token_type} {access_token}.Concern or scope can be used for passing the concern parameter but scope is preferred as it is fully oauth2 compatible. Either of the two parameters i.e Concern or Scope is mandatory.

Parameters
Type Name Description Schema

Query

grant_type
required

GrantType which is used to authenticate (client_credentials etc)

string

Query

scope
required

scope of authorization.Contains a concern parameter to make it compatible with oauth2 standard.

string

Query

client_secret
required

This is the API key provided by Maxxton as part of API credentials.

string

Query

client_id
required

This is the maxxton login name provided by Maxxton as part of API credentials.

string

Query

concern
optional

Concern code where you want to login(3 digits), alias for scope(deprecated)

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

AuthorizationResponse

500

Error occurred while processing.

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/authenticate
Example HTTP response
Response 200
{
  "access_token" : "string",
  "expires_in" : 1,
  "jti" : "string",
  "scope" : "string",
  "token_type" : "string"
}

5.7. Brands

Different labels used for marketing of an accommodation type

5.7.1. Get brands

GET /maxxton/v1/brands
Description

Gets a page with brands. The records can be filtered based on the brand object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
brandId:0,
defaultBrand:true,
name:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageBrand

500

Error occurred while fetching brands.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/brands
Example HTTP response
Response 200
{
  "content" : [ {
    "brandId" : 1,
    "defaultBrand" : true,
    "name" : "string",
    "reservationCategoryId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.7.2. Gets an brand of a specific brand id.

GET /maxxton/v1/brands/{brandId}
Description

Gets brand based on Brand Id

Parameters
Type Name Description Schema

Path

brandId
required

Brand id to fetch brand

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Brand

500

Error occurred while fetching Brand.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/brands/{brandId}
Example HTTP response
Response 200
{
  "brandId" : 1,
  "defaultBrand" : true,
  "name" : "string",
  "reservationCategoryId" : 1
}

5.8. Cash Clearance

Informations related to cash reservations and company.

5.8.1. Get a company on a specific company id.

GET /maxxton/v1/companies/{companyId}
Description

Get a company based on its company id

Parameters
Type Name Description Schema

Path

companyId
required

Company id to fetch particular company

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Company

500

Error occurred while fetching specific company.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/companies/{companyId}
Example HTTP response
Response 200
{
  "adminOrganisationId" : "string",
  "companyId" : 1,
  "companyNumber" : "string",
  "currencyId" : 1,
  "description" : "string",
  "name" : "string"
}

5.8.2. Gets all cashaccounts.

GET /maxxton/v1/cashreservations/accounts
Description

Gets a page of all cashaccounts, records can be filtered based on fields on cashaccount object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
accountId:0,
name:String,
description:String,
companyId:0,
accountType:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCashAccount

500

Error occurred while fetching cashaccount

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/cashreservations/accounts
Example HTTP response
Response 200
{
  "content" : [ {
    "accountId" : 1,
    "accountType" : "string",
    "companyId" : 1,
    "description" : "string",
    "name" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.8.3. Gets all cashclearance.

GET /maxxton/v1/cashreservations/clearance
Description

Gets a page of all cashclearance, records can be filtered based on fields on cashclearance object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
cashClearanceId:0,
reportNumber:0,
creationDate:String(date),
companyId:0,
employeeId:0,
totalValueAmount:0.0,
totalCardAmount:0.0,
startBalanceNextDay:0.0,
tillAmountNextDay:0.0,
safeWithdrawalAmount:0.0,
safeDepositAmount:0.0,
receivedAmount:0.0,
totalMutationAmount:0.0,
cashDifference:0.0,
reasonCashDifference:String,
currencyId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCashClearance

500

Error occurred while fetching cashclearance

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/cashreservations/clearance
Example HTTP response
Response 200
{
  "content" : [ {
    "cashClearanceId" : 1,
    "cashDifference" : 1,
    "companyId" : 1,
    "creationDate" : "01-01-2023T11:23:45Z",
    "currencyId" : 1,
    "employeeId" : 1,
    "reasonCashDifference" : "string",
    "receivedAmount" : 1,
    "reportNumber" : 1,
    "safeDepositAmount" : 1,
    "safeWithdrawalAmount" : 1,
    "startBalanceNextDay" : 1,
    "tillAmountNextDay" : 1,
    "totalCardAmount" : 1,
    "totalMutationAmount" : 1,
    "totalValueAmount" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.8.4. Gets all companies.

GET /maxxton/v1/companies
Description

Gets a page of all companies, records can be filtered based on fields on country object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
companyId:0,
companyNumber:String,
name:String,
description:String,
adminOrganisationId:String,
currencyId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCompany

500

Error occurred while fetching companies

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/companies
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : "string",
    "companyId" : 1,
    "companyNumber" : "string",
    "currencyId" : 1,
    "description" : "string",
    "name" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.9. Contracts

Formal legal agreement between the owner and the resort

5.9.1. Creats a new Contract

POST /maxxton/v1/contracts
Description

Gets a newly created Contract

Parameters
Type Name Description Schema

Body

requestBody
required

Request Body for new contract.

Contract
Responses
Code Description Schema

200

The request is completed successfully without any errors

Contract

500

Error occurred while fetching contract.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts
Request body
{
  "code" : "string",
  "contractId" : 1,
  "contractRenewalReminder" : "01-01-2023",
  "contractTypeId" : 1,
  "endDate" : "01-01-2023",
  "name" : "string",
  "origin" : "string",
  "originId" : "string",
  "ownerId" : 1,
  "poolOwnerId" : 1,
  "rentAssurance" : 1,
  "resourceId" : 1,
  "startDate" : "01-01-2023",
  "targetAmount" : 1,
  "unitId" : 1
}
Example HTTP response
Response 200
{
  "code" : "string",
  "contractId" : 1,
  "contractRenewalReminder" : "01-01-2023",
  "contractTypeId" : 1,
  "endDate" : "01-01-2023",
  "name" : "string",
  "origin" : "string",
  "originId" : "string",
  "ownerId" : 1,
  "poolOwnerId" : 1,
  "rentAssurance" : 1,
  "resourceId" : 1,
  "startDate" : "01-01-2023",
  "targetAmount" : 1,
  "unitId" : 1
}

5.9.2. Gets a Contract by contract id

GET /maxxton/v1/contracts/{contractId}
Description

Gets a Contract associated with the contractId

Parameters
Type Name Description Schema

Path

contractId
required

Contract Id to fetch contract.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Contract

500

Error occurred while fetching contract.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts/{contractId}
Example HTTP response
Response 200
{
  "code" : "string",
  "contractId" : 1,
  "contractRenewalReminder" : "01-01-2023",
  "contractTypeId" : 1,
  "endDate" : "01-01-2023",
  "name" : "string",
  "origin" : "string",
  "originId" : "string",
  "ownerId" : 1,
  "poolOwnerId" : 1,
  "rentAssurance" : 1,
  "resourceId" : 1,
  "startDate" : "01-01-2023",
  "targetAmount" : 1,
  "unitId" : 1
}

5.9.3. Gets a page with Contracts

GET /maxxton/v1/contracts
Description

Gets a Page of Contracts. The records can be filtered based on contract object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contractId:0,
code:String,
name:String,
ownerId:0,
unitId:0,
startDate:String(date),
endDate:String(date),
contractTypeId:0,
resourceId:0,
poolOwnerId:0,
origin:String,
originId:String,
rentAssurance:0.0,
contractRenewalReminder:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageContract

500

Error occurred while fetching contracts.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "contractId" : 1,
    "contractRenewalReminder" : "01-01-2023",
    "contractTypeId" : 1,
    "endDate" : "01-01-2023",
    "name" : "string",
    "origin" : "string",
    "originId" : "string",
    "ownerId" : 1,
    "poolOwnerId" : 1,
    "rentAssurance" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "targetAmount" : 1,
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.9.4. Gets a page with contract rules

GET /maxxton/v1/contracts/types/rules
Description

Gets a Page of Contract Rules. These records can be filtered based on contract rule object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contractRuleId:0,
contractTypeId:0,
archivedFrom:String(date),
arrivalDateEnd:String(date),
arrivalDateStart:String(date),
baseSumIncludingTax:true,
beneficiary:String,
calculateAbsolutePerNight:true,
calculationSource:String,
commissionOnly:true,
commissionInculdingTax:true,
commissionTaxRate:0,
departureDateStart:String(date),
departureDateEnd:String(date),
introducerInOwnObject:true,
ledgerId:0,
name:String,
ownerSpecific:true,
priority:0,
purchaseLedgerId:0,
purchaseSecondLedgerId:0,
reservationDateStart:String(date),
reservationDateEnd:String(date),
resourceType:String,
resourceTypeSelected:true,
resourceBeneficiary:true,
resourceId:0,
secondLedgerId:0,
settlementOwnerId:0,
settlementOwnerResortId:0,
stayDateFrom:String(date),
stayDateTo:String(date),
substractDistributionChannelCommission:true,
substractDistributionChannelIncludingTax:true,
taxSumInCommission:0,
time:0,
type:String,
unit:String,
value:0,
vatForPrivateOwner:true,
ownerVatRateExclude:0,
ledgerGroupId:0,
purchaseLedgerGroupId:0,
dependsOnLedgerGroup:true,
valueOnStayBasis:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageContractRule

500

Error occurred while fetching contract Rules.

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts/types/rules
Example HTTP response
Response 200
{
  "content" : [ {
    "archivedFrom" : "01-01-2023",
    "arrivalDateEnd" : "01-01-2023",
    "arrivalDateStart" : "01-01-2023",
    "baseSumIncludingTax" : true,
    "beneficiary" : "string",
    "calculateAbsolutePerNight" : true,
    "calculationSource" : "string",
    "commissionInculdingTax" : true,
    "commissionOnly" : true,
    "commissionTaxrate" : 1,
    "contractRuleId" : 1,
    "contractTypeId" : 1,
    "departureDateEnd" : "01-01-2023T11:23:45Z",
    "departureDateStart" : "01-01-2023T11:23:45Z",
    "dependsOnLedgerGroup" : true,
    "introducerInOwnObject" : true,
    "ledgerGroupId" : 1,
    "ledgerId" : 1,
    "name" : "string",
    "ownerSpecific" : true,
    "ownerVatRateExclude" : 1,
    "owners" : [ {
      "accountNr" : "string",
      "alternateName" : "string",
      "attentionOf" : "string",
      "bicSwift" : "string",
      "birthCountryId" : 1,
      "birthDate" : "01-01-2023",
      "birthPlace" : "string",
      "company" : true,
      "companyIdentificationNumber" : "string",
      "companyName" : "string",
      "dac7OwnerVerified" : true,
      "emailAllowed" : true,
      "firstName" : "string",
      "fiscalTypes" : [ {
        "endDate" : "01-01-2023",
        "fiscalType" : "string",
        "fiscalVat" : "string",
        "ownerFiscalTypeId" : 1,
        "startDate" : "01-01-2023"
      } ],
      "ibanNumber" : "string",
      "languageId" : 1,
      "lastName" : "string",
      "mailAddress" : {
        "accuracy" : "string",
        "address1" : "string",
        "address2" : "string",
        "address3" : "string",
        "addressId" : 1,
        "altContactPerson" : "string",
        "alternateContactPerson" : "string",
        "boxNumber" : "string",
        "city" : "string",
        "country" : {
          "code" : "string",
          "countryId" : 1,
          "default" : true,
          "defaultLanguageId" : 1,
          "priority" : 1,
          "shortName" : "string",
          "translations" : [ { } ]
        },
        "countryId" : 1,
        "dateBegin" : "01-01-2023",
        "dateEnd" : "01-01-2023",
        "district" : "string",
        "email" : "string",
        "exposeLocation" : true,
        "fax" : "string",
        "houseNumber" : "string",
        "houseNumberSuffix" : "string",
        "latitude" : 1,
        "longitude" : 1,
        "mobilePhone" : "string",
        "mobilePhone2" : "string",
        "municipality" : "string",
        "poBox" : "string",
        "poBoxCity" : "string",
        "poBoxZipcode" : "string",
        "privatePhone" : "string",
        "stateId" : 1,
        "workPhone" : "string",
        "zipCode" : "string"
      },
      "mailAddressManagerId" : 1,
      "mailAllowed" : true,
      "middle" : "string",
      "origin" : "string",
      "originId" : "string",
      "owner" : true,
      "ownerGroupId" : 1,
      "ownerId" : 1,
      "ownerPool" : "string",
      "ownerType" : "string",
      "questionnaireUnsubscribed" : true,
      "sendMethodId" : 1,
      "sex" : "string",
      "sharedOwnerShips" : [ {
        "ownerId" : 1,
        "realOwnerId" : 1
      } ],
      "socialSecurityNumber" : "string",
      "socialSecurityNumberIssuingCountryId" : 1,
      "taxNumber" : "string",
      "taxNumberIssuingCountryId" : 1,
      "titleId" : 1
    } ],
    "priority" : 1,
    "purchaseLedgerGroupId" : 1,
    "purchaseLedgerId" : 1,
    "purchaseSecondLedgerId" : 1,
    "reservationDateEnd" : "01-01-2023",
    "reservationDateStart" : "01-01-2023",
    "resort" : [ {
      "contractRuleResortId" : 1,
      "contractruleId" : 1,
      "resortId" : 1
    } ],
    "resourceBeneficiary" : true,
    "resourceId" : 1,
    "resourceType" : "string",
    "resourceTypeSelected" : true,
    "secondLedgerId" : 1,
    "settlementOwnerId" : 1,
    "settlementOwnerResortId" : 1,
    "stayDateFrom" : "01-01-2023",
    "stayDateTo" : "01-01-2023",
    "substractDistributionChannelCommission" : true,
    "substractDistributionChannelIncludingTax" : true,
    "taxSumInCommission" : 1,
    "time" : 1,
    "type" : "string",
    "unit" : "string",
    "validity" : {
      "arrivalDateFrom" : "01-01-2023",
      "arrivalDateTo" : "01-01-2023",
      "departureDateFrom" : "01-01-2023",
      "departureDateTo" : "01-01-2023",
      "distributionChannelIds" : [ "integer" ],
      "ownerIds" : [ "integer" ],
      "reservationCategoryIds" : [ "integer" ],
      "reservationDateFrom" : "01-01-2023",
      "reservationDateTo" : "01-01-2023",
      "resortIds" : [ "integer" ],
      "stayDateFrom" : "01-01-2023",
      "stayDateTo" : "01-01-2023"
    },
    "value" : 1,
    "valueOnStayBasis" : true,
    "vatForPrivateOwner" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.9.5. Gets a page with contract types

GET /maxxton/v1/contracts/types
Description

Gets a Page of Contract Types. The records can be filtered based on contract type object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contractTypeId:0,
code:String,
remark:String,
settlementMethod:String,
settlementPct:0,
redirectionMinAmount:0,
contractKind:String,
priority:0,
round:true,
ownUsageAllowed:true,
archivedFrom:String(date),
resourceGroupId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageContractType

500

Error occurred while fetching contract Types.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts/types
Example HTTP response
Response 200
{
  "content" : [ {
    "archivedFrom" : "01-01-2023",
    "code" : "string",
    "contractKind" : "string",
    "contractTypeId" : 1,
    "i18n" : [ {
      "contractTypeId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "nonRentable" : true,
    "ownUsageAllowed" : true,
    "priority" : 1,
    "redirectionMinAmount" : 1,
    "remark" : "string",
    "resourceGroupId" : 1,
    "round" : true,
    "settlementMethod" : "string",
    "settlementPct" : 1,
    "translations" : [ {
      "contractTypeId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.9.6. delete a Contract

DELETE /maxxton/v1/contracts/{contractId}
Description

Delete a Contract associated with the contractId

Parameters
Type Name Description Schema

Path

contractId
required

Contract Id to delete contract.

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

404

Exception occurred while deleting contract.

No Content

500

Error occurred while deleting contract.

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts/{contractId}
Example HTTP response

5.9.7. updates a Contract

PUT /maxxton/v1/contracts/{contractId}
Description

Updates a Contract associated with the contractId

Parameters
Type Name Description Schema

Body

requestBody
required

Request Body for update contract.

UpdateContractRequest

Path

contractId
required

Contract Id to fetch contract.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Contract

500

Error occurred while fetching contract.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/contracts/{contractId}
Request body
{
  "code" : "string",
  "contractId" : 1,
  "contractTypeId" : 1,
  "endDate" : "01-01-2023",
  "name" : "string",
  "origin" : "string",
  "originId" : "string",
  "ownerId" : 1,
  "poolOwnerId" : 1,
  "rentAssurance" : 1,
  "resourceId" : 1,
  "startDate" : "01-01-2023",
  "targetAmount" : 1,
  "unitId" : 1
}
Example HTTP response
Response 200
{
  "code" : "string",
  "contractId" : 1,
  "contractRenewalReminder" : "01-01-2023",
  "contractTypeId" : 1,
  "endDate" : "01-01-2023",
  "name" : "string",
  "origin" : "string",
  "originId" : "string",
  "ownerId" : 1,
  "poolOwnerId" : 1,
  "rentAssurance" : 1,
  "resourceId" : 1,
  "startDate" : "01-01-2023",
  "targetAmount" : 1,
  "unitId" : 1
}

5.10. Countries

List of countries.

5.10.1. Gets all countries.

GET /maxxton/v1/countries
Description

Gets a list of all countries, records can be filtered based on fields on country object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
countryId:0,
priority:0,
code:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< Country
> array

500

Error occurred while fetching countries

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/countries
Example HTTP response
Response 200
[ {
  "code" : "string",
  "countryId" : 1,
  "default" : true,
  "defaultLanguageId" : 1,
  "priority" : 1,
  "shortName" : "string",
  "translations" : [ {
    "i18nCountryId" : 1,
    "language" : "string",
    "languageId" : 1,
    "longName" : "string",
    "name" : "string"
  } ]
} ]

5.10.2. Gets all states.

GET /maxxton/v1/countries/states
Description

Gets a page of all states, records can be filtered based on fields on state object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
stateId:0,
code:String,
countryId:0,
name:String,
description:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageState

500

Error occurred while fetching countries

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/countries/states
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "countryId" : 1,
    "description" : "string",
    "name" : "string",
    "stateId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.11. Currency

List of currencies

5.11.1. Gets a page with currencies

GET /maxxton/v1/currencies
Description

Gets a page with currencies.The records can be filtered based on the currency object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
currencyId:0,
code:String,
name:String,
symbol:String,
currencyLanguage:String,
currencyCountry:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCurrency

500

Error occurred while fetching currencies.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/currencies
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "currencyCountry" : "string",
    "currencyId" : 1,
    "currencyLanguage" : "string",
    "name" : "string",
    "symbol" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.11.2. Gets the details of specific currency

GET /maxxton/v1/currencies/{currencyId}
Description

Gets details of the currency associated with a particular currencyId.

Parameters
Type Name Description Schema

Path

currencyId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Currency

500

Error occurred while fetching details for specific currency.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/currencies/{currencyId}
Example HTTP response
Response 200
{
  "code" : "string",
  "currencyCountry" : "string",
  "currencyId" : 1,
  "currencyLanguage" : "string",
  "name" : "string",
  "symbol" : "string"
}

5.12. Customer Status

Statuses given to customers as per customer’s reservation history

5.12.1. Gets customers' status

GET /maxxton/v1/customerstatus
Description

Gets a page with customers' status. The records can be filtered based on customerstatus object and entities in customercluster which is present in customerstatus object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCustomerStatus_Detail

500

Error occurred while fetching customers' status

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customerstatus
Example HTTP response
Response 200
{
  "content" : [ {
    "customerClusters" : [ {
      "categoryId" : 1,
      "clusterId" : 1,
      "code" : "string",
      "description" : "string",
      "name" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "customerId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.12.2. Gets customerstatus categories

GET /maxxton/v1/customerstatus/categories
Description

Gets customerstatus categories. The records can be filtered based on CustomerClusterCategory objects. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
categoryId:0,
updateMode:String,
manualOverrideAllowed:true,
code:String,
enableManualEndDate:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCustomerClusterCategory_Basic

500

Error occurred while fetching customerstatus categories

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customerstatus/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "categoryId" : 1,
    "code" : "string",
    "customerCluster" : [ {
      "badgeColor" : "string",
      "clusterId" : 1,
      "code" : "string",
      "description" : "string",
      "evaluate" : true,
      "iconName" : "string",
      "maxDays" : 1,
      "maxReservations" : 1,
      "minDays" : 1,
      "minReservations" : 1,
      "name" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "enableManualEndDate" : true,
    "manualOverrideAllowed" : true,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "updateMode" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13. Customers

Guest who can book reservations

5.13.1. Adds a new Customer

POST /maxxton/v1/customers
Description

Adds a new Customer. The details are to be added in request body.
Note: The country field in mailAddress is not allowed while adding a customer. Email id field in the customer address entity is also used as customer login

Parameters
Type Name Description Schema

Body

requestBody
required

A customer object to be added

Customer
Responses
Code Description Schema

200

The request is completed successfully without any errors

Customer

500

Error occurred while creating customers

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers
Request body
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "companyName" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "customerGroupId" : 1,
  "customerId" : 1,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "language" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "login" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "phoneCallAllowed" : true,
  "previousPmsId" : 1,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "01-01-2023",
  "socialSecurityNumber" : "string",
  "textMsgAllowed" : true,
  "titleId" : 1
}
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "companyName" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "customerGroupId" : 1,
  "customerId" : 1,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "language" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "login" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "phoneCallAllowed" : true,
  "previousPmsId" : 1,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "01-01-2023",
  "socialSecurityNumber" : "string",
  "textMsgAllowed" : true,
  "titleId" : 1
}

5.13.2. Authenticate a customer

POST /maxxton/v1/customers/login
Description

Authenticate a customer based on login credentials and return customer details if the customer credentials are authentic.

Parameters
Type Name Description Schema

Body

requestBody
required

Login credentials of the customer to be authenticated.

CustomerCredential
Responses
Code Description Schema

200

The request is completed successfully without any errors

CustomerLogin

401

Invalid credentials.

No Content

500

Error occurred while authenticating this customer

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/login
Request body
{
  "login" : "string",
  "password" : "string"
}
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "companyName" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "customerGroupId" : 1,
  "customerId" : 1,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "language" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "login" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "passwordModifiedDate" : "01-01-2023T11:23:45Z",
  "phoneCallAllowed" : true,
  "previousPmsId" : 1,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "01-01-2023",
  "socialSecurityNumber" : "string",
  "textMsgAllowed" : true,
  "titleId" : 1
}

5.13.3. Create customer memo

POST /maxxton/v1/customers/{customerId}/memos
Description

Create customer memo

Parameters
Type Name Description Schema

Body

requestBody
required

Request body for customer memo.

MemoRequest

Path

customerId
required

Customer id to fetch files associated with the customer

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Memo

401

Invalid credentials.

No Content

500

Error occurred while creating customer memo

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/memos
Request body
{
  "memoCategoryId" : 1,
  "onCheckin" : true,
  "onInvoice" : true,
  "sensitive" : true,
  "text" : "string"
}
Example HTTP response
Response 200
{
  "content" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "employeeId" : 1,
  "memoCategoryId" : 1,
  "memoId" : 1,
  "predefinedMemoId" : 1
}

5.13.4. Get a single Customer by customer id

GET /maxxton/v1/customers/{customerId}
Description

Gets the details of the customer specified to a particular id passed in the endpoint.

Parameters
Type Name Description Schema

Path

customerId
required

An Id of customer to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Customer

404

No customer found for given customer id.

No Content

500

Error occurred while fetching this customer

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "companyName" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "customerGroupId" : 1,
  "customerId" : 1,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "language" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "login" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "phoneCallAllowed" : true,
  "previousPmsId" : 1,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "01-01-2023",
  "socialSecurityNumber" : "string",
  "textMsgAllowed" : true,
  "titleId" : 1
}

5.13.5. Get all customer titles.

GET /maxxton/v1/titles
Description

Get list of all customer titles, records can be filtered based on fields of customer title object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
titleId:0,
code:String,
priority:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

CustomerTitle

500

Error occurred while fetching customer titles

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/titles
Example HTTP response
Response 200
{
  "code" : "string",
  "priority" : 1,
  "titleId" : 1,
  "translations" : [ {
    "language" : "string",
    "languageId" : 1,
    "title" : "string"
  } ]
}

5.13.6. Get memos for a specific customer

GET /maxxton/v1/customers/{customerId}/memos
Description

Gets the memos of the customer specified to a particular id passed in the endpoint.The records can be filtered based on memo object. In order to filter creationDate the format of date passed should be: YYYY-MM-DDThh:mm:ss. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoId:0,
employeeId:0,
content:String,
creationDate:String(date),
predefinedMemoId:0)

Path

customerId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageMemo

404

No customer found for given customer id.

No Content

500

Error occurred while fetching memo for this customer

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/memos
Example HTTP response
Response 200
{
  "content" : [ {
    "content" : "string",
    "creationDate" : "01-01-2023T11:23:45Z",
    "employeeId" : 1,
    "memoCategoryId" : 1,
    "memoId" : 1,
    "predefinedMemoId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13.7. Get status for a specific customer

GET /maxxton/v1/customers/{customerId}/customerstatus
Description

Gets the status of the customer specified to a particular id passed in the endpoint.

Parameters
Type Name Description Schema

Path

customerId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

CustomerStatus

404

No customer found for given customer id.

No Content

500

Error occurred while fetching this customer

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/customerstatus
Example HTTP response
Response 200
{
  "customerClusters" : [ {
    "categoryId" : 1,
    "clusterId" : 1,
    "code" : "string",
    "description" : "string",
    "name" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "customerId" : 1
}

5.13.8. Get the generated hash and provides link

GET /maxxton/v1/customers/{customerId}/files/{fileId}
Description

Get the generated hash for specific file which has information related to file

Parameters
Type Name Description Schema

Path

customerId
required

Customer id to fetch files associated with the customer

integer (int64)

Path

fileId
required

file id to fetch a specific file

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

DocumentUrl

404

No document found for specific file id.

No Content

500

Error occured while generating hash

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/files/{fileId}
Example HTTP response
Response 200
{
  "downloadLink" : "string"
}

5.13.9. Gets a page of customer phone calls

GET /maxxton/v1/customers/phonecalls
Description

Gets a page with customerPhonecalls. The records can be filtered based on customerPhoneCall object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerPhoneCallId:0,
type:String,
customerId:0,
employeeId:0,
startTime:String(date),
endTime:String(date),
phoneNumber:String,
memoCategoryId:0,
note:String,
resortId:0)

Query

employeeGroupId
optional

customer phone calls will be returned based on the employeeGroupId

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCustomerPhoneCall

500

Error occurred while fetching customer phone calls

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/phonecalls
Example HTTP response
Response 200
{
  "content" : [ {
    "customerId" : 1,
    "customerPhoneCallId" : 1,
    "employeeId" : 1,
    "endTime" : "01-01-2023T11:23:45Z",
    "memoCategoryId" : 1,
    "note" : "string",
    "phoneNumber" : "string",
    "resortId" : 1,
    "startTime" : "01-01-2023T11:23:45Z",
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13.10. Gets all files

GET /maxxton/v1/customers/{customerId}/files
Description

Get a page with files associated with a customer.The records are filtered based on filebase object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileId:0,
name:String,
fileName:String,
fileSize:0,
fileType:String,
uploadDate:String(date),
endDate:String(date),
shortDescription:String,
validFrom:String(date),
validTo:String(date))

Path

customerId
required

Customer id for which the files are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDocumentBase

404

No customer or files found for given customer id.

No Content

500

Error occurred while fetching files

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/files
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileId" : 1,
    "fileName" : "string",
    "fileSize" : 1,
    "fileType" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "uploadDate" : "01-01-2023",
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13.11. Gets customers

GET /maxxton/v1/customers
Description

Gets a page with customers. The records can be filtered based on customer object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerGroupId:0,
titleId:0,
firstName:String,
middle:String,
lastName:String,
alternateName:String,
emailAllowed:true,
mailAllowed:true,
phoneCallAllowed:true,
textMsgAllowed:true,
signatureDate:String(date),
socialSecurityNumber:String,
sex:String,
languageId:0,
ibanNumber:String,
bicSwift:String,
birthDate:String(date),
companyName:String,
login:String,
previousPmsId:0,
creationDate:String(date))

Query

email
optional

Filter customer’s on email id

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCustomer

500

Error occurred while fetching customers

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers
Example HTTP response
Response 200
{
  "content" : [ {
    "alternateName" : "string",
    "bicSwift" : "string",
    "birthDate" : "01-01-2023",
    "companyName" : "string",
    "creationDate" : "01-01-2023T11:23:45Z",
    "customerGroupId" : 1,
    "customerId" : 1,
    "emailAllowed" : true,
    "firstName" : "string",
    "ibanNumber" : "string",
    "language" : "string",
    "languageId" : 1,
    "lastName" : "string",
    "login" : "string",
    "mailAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAllowed" : true,
    "middle" : "string",
    "owner" : true,
    "phoneCallAllowed" : true,
    "previousPmsId" : 1,
    "questionnaireUnsubscribed" : true,
    "sex" : "string",
    "signatureDate" : "01-01-2023",
    "socialSecurityNumber" : "string",
    "textMsgAllowed" : true,
    "titleId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13.12. Gets history associated with customers

GET /maxxton/v1/customers/{customerId}/communications
Description

Get a page with communication call done with a client associated with a customer on reservation basis.The records are filtered based on communication object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerCommunicationId:0,
sendDate:String(date),
sendingType:String,
reservationId:0,
message:String,
senderEmail:String,
subject:String)

Path

customerId
required

Customer id for which the communication calls are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCommunication

404

No customer or customer communication found for given customer id.

No Content

500

Error occurred while fetching customer communication calls

MaxxtonException
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/communications
Example HTTP response
Response 200
{
  "content" : [ {
    "attachments" : [ {
      "endDate" : "01-01-2023T11:23:45Z",
      "fileId" : 1,
      "fileName" : "string",
      "fileSize" : 1,
      "fileType" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "uploadDate" : "01-01-2023T11:23:45Z",
      "validFrom" : "01-01-2023T11:23:45Z",
      "validTo" : "01-01-2023T11:23:45Z"
    } ],
    "customerCommunicationId" : 1,
    "message" : "string",
    "report" : {
      "reportCode" : "string"
    },
    "reportCode" : "string",
    "reportType" : "string",
    "reportUrl" : [ {
      "reportType" : "string"
    } ],
    "reportUrls" : [ {
      "reportType" : "string"
    } ],
    "reservationId" : 1,
    "sendDate" : "01-01-2023T11:23:45Z",
    "senderEmail" : "string",
    "sendingType" : "string",
    "staticAttachments" : [ {
      "endDate" : "01-01-2023T11:23:45Z",
      "fileId" : 1,
      "fileName" : "string",
      "fileSize" : 1,
      "fileType" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "uploadDate" : "01-01-2023T11:23:45Z",
      "validFrom" : "01-01-2023T11:23:45Z",
      "validTo" : "01-01-2023T11:23:45Z"
    } ],
    "subject" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13.13. Update customer details

PUT /maxxton/v1/customers/{customerId}
Description

Update an existing customer based on given details.
Note: Some of the fields of customer entity are restricted fields based on access rights. So, such fields data will be masked as \* in GET customer endpoints, if your login client id doesn’t have access to those fields. The fields which are not masked in the response to GET customer endpoints, could only can be modified using this endpoint.

Parameters
Type Name Description Schema

Body

requestBody
required

Request body to specify the modifications needed for a customer.

CustomerUpdate

Path

customerId
required

Customer id to fetch files associated with the customer

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Customer

404

No customer found for given customer id.

No Content

500

Error occurred while updating details for this customer

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}
Request body
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "language" : "string",
  "lastName" : "string",
  "mailAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryCode" : "string",
    "district" : "string",
    "email" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "phoneCallAllowed" : true,
  "sex" : "string",
  "textMsgAllowed" : true,
  "titleId" : 1
}
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "companyName" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "customerGroupId" : 1,
  "customerId" : 1,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "language" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "login" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "phoneCallAllowed" : true,
  "previousPmsId" : 1,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "01-01-2023",
  "socialSecurityNumber" : "string",
  "textMsgAllowed" : true,
  "titleId" : 1
}

5.13.14. retrieve Customer balance

GET /maxxton/v1/customers/{customerId}/loyalty
Description

Gets the balance of the customer specified to a particular id passed in the endpoint.

Parameters
Type Name Description Schema

Path

customerId
required

Customer id for which the Customer Loyalty balance to be fetched

integer (int64)

Query

returnTransaction
required

Transaction will be return if this is true.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

CustomerLoyaltyBalance

404

No customer found for given customer id.

No Content

500

Error occurred while fetching this customer

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/loyalty
Example HTTP response
Response 200
{
  "activePoints" : 1,
  "customerId" : 1,
  "expiredPoints" : 1,
  "pendingPoints" : 1,
  "spentPoints" : 1,
  "transactions" : [ {
    "activationDate" : "01-01-2023",
    "customerId" : 1,
    "employeeId" : 1,
    "expirationDate" : "01-01-2023",
    "originalPoints" : 1,
    "remainingPoints" : 1,
    "remark" : "string",
    "reservationId" : 1,
    "reservedResourceId" : 1,
    "transactionDate" : "01-01-2023T11:23:45Z",
    "transactionId" : 1,
    "transactionType" : "string"
  } ]
}

5.13.15. retrieve loyalty transactions

GET /maxxton/v1/customers/loyalty/transactions
Description

Gets the loyalty transactions. The records can be filtered based on the Transaction object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
transactionId:0,
transactionType:String,
transactionDate:String(date),
activationDate:String(date),
expirationDate:String(date),
reservationId:0,
originalPoints:0,
remainingPoints:0,
remark:String,
employeeId:0,
customerId:0,
reservedResourceId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageTransaction

500

Error occurred while fetching customer loyalty transaction

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/loyalty/transactions
Example HTTP response
Response 200
{
  "content" : [ {
    "activationDate" : "01-01-2023",
    "customerId" : 1,
    "employeeId" : 1,
    "expirationDate" : "01-01-2023",
    "originalPoints" : 1,
    "remainingPoints" : 1,
    "remark" : "string",
    "reservationId" : 1,
    "reservedResourceId" : 1,
    "transactionDate" : "01-01-2023T11:23:45Z",
    "transactionId" : 1,
    "transactionType" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.13.16. updates the customer credentials

PUT /maxxton/v1/customers/{customerId}/credentials
Description

This endpoint can update password of a customer in Maxxton based on the customerId and the login field. The /maxxton/v1/customers/login can be used to check if this login is correct and can be used to authenticate a user in an external system. There is no user session management available. The password can be changed in this call. The password can not be fetched from the API because of security reasons. In case the password field is kept empty the existing value will be kept.

Parameters
Type Name Description Schema

Body

requestBody
required

Login credentials of the customer to be updated.

CustomerCredential

Path

customerId
required

Customer id to fetch files associated with the customer

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while updating this customer credentials

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/credentials
Request body
{
  "login" : "string",
  "password" : "string"
}
Example HTTP response

5.14. DistributionChannels

Channel through which reservations can be booked

5.14.1. Gets a page of resorts

GET /maxxton/v1/distributionchannels/{distributionChannelId}/resorts
Description

This endpoint returns the resorts applicable to specific distribution channel.

Parameters
Type Name Description Schema

Path

distributionChannelId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResortDC

500

Error occurred while fetching the resorts

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/distributionchannels/{distributionChannelId}/resorts
Example HTTP response
Response 200
{
  "content" : [ {
    "archivedFrom" : "01-01-2023",
    "code" : "string",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "parentId" : 1,
    "resortId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.14.2. Gets a page with distribution channels

GET /maxxton/v1/distributionchannels
Description

Get a page with distribution channels. The records can be filtered based on distribution channel object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
distributionChannelId:0,
code:String,
name:String,
representationSetParentId:0,
allotmentOnly:true,
activeStartDate:String(date),
activeEndDate:String(date),
type:String,
parentId:0,
resellerId:0,
showAgentBill:0,
brandId:0,
currencyId:0,
archivedFrom:String(date),
allotmentSetting:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDistributionChannel_Id

204

No distributionChannels found for given criteria.

No Content

500

Error occurred while fetching these distributionChannels

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/distributionchannels
Example HTTP response
Response 200
{
  "content" : [ {
    "activeEndDate" : "01-01-2023",
    "activeStartDate" : "01-01-2023",
    "allotmentOnly" : true,
    "allotmentSetting" : "string",
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "brandId" : 1,
    "code" : "string",
    "communicationPermission" : "string",
    "currencyCode" : "string",
    "currencyId" : 1,
    "customerRequiredFieldsSetId" : 1,
    "distributionChannelId" : 1,
    "inheritedType" : "string",
    "invoiceAddress" : {
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "invoiceaddressManagerId" : 1,
    "mailAddress" : {
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAddressManagerId" : 1,
    "name" : "string",
    "parentId" : 1,
    "representationSetParentId" : 1,
    "resellerId" : 1,
    "showAgentBill" : 1,
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.14.3. Gets a single distributionChannel

GET /maxxton/v1/distributionchannels/{distributionChannelId}
Description

This endpoint returns the specific distribution channel including mail, invoice address and currency.

Parameters
Type Name Description Schema

Path

distributionChannelId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

DistributionChannel_Id

404

No distributionChannel found for given distributionChannel id.

No Content

500

Error occurred while fetching this distributionChannel

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/distributionchannels/{distributionChannelId}
Example HTTP response
Response 200
{
  "activeEndDate" : "01-01-2023",
  "activeStartDate" : "01-01-2023",
  "allotmentOnly" : true,
  "allotmentSetting" : "string",
  "archivedFrom" : "01-01-2023",
  "brand" : "string",
  "brandId" : 1,
  "code" : "string",
  "communicationPermission" : "string",
  "currencyCode" : "string",
  "currencyId" : 1,
  "customerRequiredFieldsSetId" : 1,
  "distributionChannelId" : 1,
  "inheritedType" : "string",
  "invoiceAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "invoiceaddressManagerId" : 1,
  "mailAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "name" : "string",
  "parentId" : 1,
  "representationSetParentId" : 1,
  "resellerId" : 1,
  "showAgentBill" : 1,
  "type" : "string"
}

5.14.4. Gets page of distributionchannel’s payent methods

GET /maxxton/v1/distributionchannels/{distributionchannelId}/paymentmethods
Description

Get payment methods for distributionchannel based on distributionchannelId.

Parameters
Type Name Description Schema

Path

distributionchannelId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePaymentMethod

500

Error occurred while fetching payment methods for the given distributionchannel

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/distributionchannels/{distributionchannelId}/paymentmethods
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "maxDaysBetweenBookAndArrivalDate" : 1,
    "minDaysBeforeArrival" : 1,
    "paymentMethod" : "string",
    "paymentProvider" : "string",
    "paymentType" : "string",
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.14.5. Gets page of payment methods of all distributionChannels

GET /maxxton/v1/distributionchannels/paymentmethods
Description

Get payment methods for all distributionchannels.
Maximum page size for this endpoint is 10.

Parameters
Type Name Description Schema

Query

distributionChannelCode
optional

distributionChannelCode to filter records.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDCPaymentMethod

500

Error occurred while fetching payment methods

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/distributionchannels/paymentmethods
Example HTTP response
Response 200
{
  "content" : [ {
    "distributionChannelCode" : "string",
    "paymentMethods" : [ {
      "code" : "string",
      "maxDaysBetweenBookAndArrivalDate" : 1,
      "minDaysBeforeArrival" : 1,
      "paymentMethod" : "string",
      "paymentProvider" : "string",
      "paymentType" : "string",
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.15. Employee

Employees

5.15.1. Create a new employee

POST /maxxton/v1/employees
Description

Create a new employee with the details

Parameters
Type Name Description Schema

Body

requestBody
required

EmployeeCreateRequest
Responses
Code Description Schema

200

OK

EmployeeResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/employees
Request body
{
  "adminorganisationIds" : [ "integer" ],
  "cashAccountIds" : [ "integer" ],
  "clientType" : "string",
  "distributionchannelCode" : "string",
  "email" : "string",
  "employeeGroupId" : 1,
  "firstName" : "string",
  "lastName" : "string",
  "locale" : "string",
  "login" : "string",
  "middleName" : "string",
  "offDuty" : "01-01-2023",
  "onDuty" : "01-01-2023",
  "permissionGroupIds" : [ "integer" ],
  "privacyAccessLevel" : "string",
  "privacyDbAccessLevel" : "string",
  "reservationcategoryCode" : "string",
  "resortIds" : [ "integer" ],
  "sectorIds" : [ "integer" ],
  "sex" : "string",
  "type" : "string",
  "unifiedInboxIds" : [ "integer" ]
}
Example HTTP response
Response 200
{
  "adminorganisationIds" : [ "integer" ],
  "cashAccountIds" : [ "integer" ],
  "clientType" : "string",
  "distributionchannelId" : 1,
  "empEmailId" : "string",
  "employeeId" : 1,
  "firstName" : "string",
  "groupId" : 1,
  "lastName" : "string",
  "locale" : "string",
  "login" : "string",
  "middleName" : "string",
  "offDuty" : "01-01-2023",
  "onDuty" : "01-01-2023",
  "permissionGroupIds" : [ "integer" ],
  "privacyAccessLevel" : "string",
  "privacyDbAccessLevel" : "string",
  "reservationcategoryId" : 1,
  "resortIds" : [ "integer" ],
  "sectorIds" : [ "integer" ],
  "sex" : "string",
  "type" : "string",
  "unifiedInboxIds" : [ "integer" ]
}

5.15.2. Gets the details of employees

GET /maxxton/v1/employees
Description

Gets the details of all employess.

Parameters
Type Name Description Schema

Query

employeeIds
required

List of employee Ids to fetch in response

< integer > array
Responses
Code Description Schema

200

OK

PageEmployee
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/employees
Example HTTP response
Response 200
{
  "content" : [ {
    "clientGroupId" : 1,
    "empEmailId" : "string",
    "employeeGroup" : {
      "code" : "string",
      "description" : "string",
      "employeeGroupId" : 1,
      "name" : "string"
    },
    "employeeId" : 1,
    "firstName" : "string",
    "lastName" : "string",
    "middleName" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.15.3. Update an existing employee

PUT /maxxton/v1/employees/{employeeId}
Description

Update an existing employee

Parameters
Type Name Description Schema

Body

requestBody
required

EmployeeUpdateRequest

Path

employeeId
required

Id of the employee that needs to be updated

integer (int64)
Responses
Code Description Schema

200

OK

EmployeeResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/employees/{employeeId}
Request body
{
  "adminorganisationIds" : [ "integer" ],
  "cashAccountIds" : [ "integer" ],
  "distributionchannelCode" : "string",
  "email" : "string",
  "employeeGroupId" : 1,
  "firstName" : "string",
  "lastName" : "string",
  "locale" : "string",
  "login" : "string",
  "middleName" : "string",
  "offDuty" : "01-01-2023",
  "onDuty" : "01-01-2023",
  "permissionGroupIds" : [ "integer" ],
  "privacyAccessLevel" : "string",
  "privacyDbAccessLevel" : "string",
  "reservationcategoryCode" : "string",
  "resortIds" : [ "integer" ],
  "sectorIds" : [ "integer" ],
  "sex" : "string",
  "type" : "string",
  "unifiedInboxIds" : [ "integer" ]
}
Example HTTP response
Response 200
{
  "adminorganisationIds" : [ "integer" ],
  "cashAccountIds" : [ "integer" ],
  "clientType" : "string",
  "distributionchannelId" : 1,
  "empEmailId" : "string",
  "employeeId" : 1,
  "firstName" : "string",
  "groupId" : 1,
  "lastName" : "string",
  "locale" : "string",
  "login" : "string",
  "middleName" : "string",
  "offDuty" : "01-01-2023",
  "onDuty" : "01-01-2023",
  "permissionGroupIds" : [ "integer" ],
  "privacyAccessLevel" : "string",
  "privacyDbAccessLevel" : "string",
  "reservationcategoryId" : 1,
  "resortIds" : [ "integer" ],
  "sectorIds" : [ "integer" ],
  "sex" : "string",
  "type" : "string",
  "unifiedInboxIds" : [ "integer" ]
}

5.16. Events

Events occurred in the system due to modifications of the entities

5.16.1. Gets page of events

GET /maxxton/v1/events
Description

Gets a page of events. Any change done to any of the data will trigger notifications. The notification is checked for the type of event and logged as an event along with entity id, event id and timestamps. The response of the above event endpoint can be filtered on the basis of criteria for e.g eventId , entityId , entityType etc., in combination with below mentioned parameters. For instance, /maxxton/v1/events?filter=type:UNIT_EVENT&modifiedAfter=2019-03-01T01:00:00.000

Parameters
Type Name Description Schema

Query

modifiedAfter
optional

modifiedAfter parameter will set a limit on the delta events so it will return all changes which occured on the environment after the provided date. If this parameter is not passed then the request will consider no start date limit and return everything available. However the delta events are only kept for 7 days. The parameter should be provided in UTC timezone with the following dateformat: yyyy-MM-dd’T’HH:mm:ss.SSS (for example: modifiedAfter:2018-10-18T10:00:00.000)

string (date-time)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
eventId:0,
entityId:0,
entityType:String,
entityAction:String,
eventTimestamp:String(date),
type:String,
oldEntityId:0)

Query

modifiedBefore
optional

modifiedBefore parameter will set a limit on the delta events so it will return all changes which occured on the environment before the provided date. If this parameter is not passed then the request will consider no end date limit and return everything available. However the delta events are only kept for 7 days. The parameter should be provided in UTC timezone with the following dateformat: yyyy-MM-dd’T’HH:mm:ss.SSS (for example: modifiedBefore:2018-10-18T10:00:00.000)

string (date-time)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageEvent

500

Error occurred while fetching events.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/events
Example HTTP response
Response 200
{
  "content" : [ {
    "entityAction" : "string",
    "entityId" : 1,
    "entityType" : "string",
    "eventId" : 1,
    "eventTimestamp" : "01-01-2023T11:23:45Z",
    "oldEntityId" : 1,
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.17. Facilities

Different labels used for facilities

5.17.1. Get facilities

GET /maxxton/v1/facilities
Description

Gets a page with facilities. The records can be filtered based on the facility object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
facilityId:0,
code:String,
internalUse:true,
resortId:0,
priority:0,
openingTimes:String)

Query

returnOpeningTimes
optional

Returns Facility opening times. By default, this request param is false, and should be used in the request opening times are expected. If this parameter is requested, only 10 facilities per page will be returned.

boolean

Query

size
optional

integer (int32)

Query

openingTimeFrom
optional

The opening times of the facilities can be limited by requesting a start date. This will work only when returnOpeningTimes=true, and must be passed along with openingDateTo. The difference between openingTimeFrom and openingDateTo should not be greater than 31 days.

string (date)

Query

openingTimeTo
optional

The opening times of the facilities can be limited by requesting an end date. This will work only when returnOpeningTimes=true, and must be passed along with openingTimeFrom. The difference between openingTimeFrom and openingDateTo should not be greater than 31 days.

string (date)

Query

returnUnpublished
optional

This will return unpublished Facility opening times.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageFacility

500

Error occurred while fetching facilities.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/facilities
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "facilityId" : 1,
    "internalUse" : true,
    "openingTimes" : [ {
      "date" : "01-01-2023",
      "day" : "01-01-2023",
      "endTime" : "01-01-2023T11:23:45Z",
      "managerId" : 1,
      "openingComment" : "string",
      "openingTimeId" : 1,
      "published" : true,
      "startTime" : "01-01-2023T11:23:45Z",
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "openingComment" : "string"
      } ]
    } ],
    "priority" : 1,
    "resortId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.17.2. Gets an facility of a specific facility id.

GET /maxxton/v1/facilities/{facilityId}
Description

Gets facility based on Facility Id

Parameters
Type Name Description Schema

Path

facilityId
required

Facility id to fetch facility

integer (int64)

Query

returnOpeningTimes
optional

Returns Facility opening times. By default, this request param is false, and should be used in the request opening times are expected.

boolean

Query

openingTimeFrom
optional

The opening times of the facilities can be limited by requesting a start date. This will work only when returnOpeningTimes=true, and must be passed along with openingDateTo. The maximum time between openingTimeFrom and openingDateTo is one month.

string (date)

Query

openingTimeTo
optional

The opening times of the facilities can be limited by requesting an end date. This will work only when returnOpeningTimes=true, and must be passed along with openingTimeFrom. The maximum time between openingTimeFrom and openingDateTo is one month.

string (date)

Query

returnUnpublished
optional

This will return unpublished Facility opening times.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

Facility

500

Error occurred while fetching Facility.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/facilities/{facilityId}
Example HTTP response
Response 200
{
  "code" : "string",
  "facilityId" : 1,
  "internalUse" : true,
  "openingTimes" : [ {
    "date" : "01-01-2023",
    "day" : "01-01-2023",
    "endTime" : "01-01-2023T11:23:45Z",
    "managerId" : 1,
    "openingComment" : "string",
    "openingTimeId" : 1,
    "published" : true,
    "startTime" : "01-01-2023T11:23:45Z",
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "openingComment" : "string"
    } ]
  } ],
  "priority" : 1,
  "resortId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ]
}

5.18. Groups

Grouping different kind of entities

5.18.1. Get a page with Groups

GET /maxxton/v1/groups
Description

Get a page with Groups. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
groupId:0,
code:String,
type:String,
parentId:0,
priority:0,
resortId:0)

Query

type
optional

Specify the Group type criteria. To get the "linkedIds" it’s mandatory to provide the type parameter in the request.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageGroup

204

No Groups found for given criteria.

No Content

500

Error occurred while fetching these Groups

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/groups
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "groupId" : 1,
    "linkedIds" : [ "integer" ],
    "parentId" : 1,
    "priority" : 1,
    "resortId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.18.2. Gets an Group for a specific groupId

GET /maxxton/v1/groups/{groupId}
Description

Gets an Groups based on specific groupId.

Parameters
Type Name Description Schema

Path

groupId
required

group id to fetch group

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Group

500

Error occurred while fetching the Group

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/groups/{groupId}
Example HTTP response
Response 200
{
  "code" : "string",
  "groupId" : 1,
  "linkedIds" : [ "integer" ],
  "parentId" : 1,
  "priority" : 1,
  "resortId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

5.19. Housekeeping

Information related to housekeeping

5.19.1. Gets a Page of housekeeping details

GET /maxxton/v1/housekeeping
Description

Gets a Page of housekeeping details.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resortId:0,
resourceId:0,
unitId:0,
executionDate:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageHousekeeping

500

Error occurred while fetching housekeeping details.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/housekeeping
Example HTTP response
Response 200
{
  "content" : [ {
    "executionDate" : "01-01-2023",
    "executionMoment" : "string",
    "resortId" : 1,
    "resourceId" : 1,
    "sector" : {
      "name" : "string",
      "sectorId" : 1
    },
    "tasks" : [ {
      "assignee" : "string",
      "duration" : 1,
      "employeeId" : 1,
      "planningId" : 1,
      "remark" : "string",
      "status" : "string",
      "taskId" : 1
    } ],
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.19.2. Gets a Page of housekeeping tasks

GET /maxxton/v1/housekeeping/tasks
Description

Gets a Page of housekeeping tasks.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
taskId:0,
code:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageHousekeepingTask

500

Error occurred while fetching housekeeping tasks.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/housekeeping/tasks
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "taskId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.20. Icals

Icals

5.20.1. Gets a ical link for single unit.

GET /maxxton/v1/units/{unitId}/icals/links
Description

Gets a link to download the specific unit ical file.

Parameters
Type Name Description Schema

Path

unitId
required

Unit id of the unit

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

IcalUrl

500

Error occurred while fetching the ical link.

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/icals/links
Example HTTP response
Response 200
{
  "downloadLink" : "string"
}

5.21. Infotexts

Information related to all the infotexts.

5.21.1. Gets a page with infotexts.

POST /maxxton/v1/infotexts/search
Description

Gets a page with infotexts.

Parameters
Type Name Description Schema

Body

requestBody
required

SearchInfoTextRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageSearchInfoTextResponse

500

Error occurred while searching infotexts

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/infotexts/search
Request body
{
  "addonIds" : [ "integer" ],
  "amenityIds" : [ "integer" ],
  "arrivalDate" : "01-01-2023",
  "departureDate" : "01-01-2023",
  "distributionChannelId" : 1,
  "infotextCategoryId" : 1,
  "offerIds" : [ "integer" ],
  "reservationCategoryId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "showMomentId" : 1,
  "subjectIds" : [ "integer" ],
  "unitIds" : [ "integer" ]
}
Example HTTP response
Response 200
{
  "content" : [ {
    "content" : "string",
    "infoTextId" : 1,
    "name" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.21.2. Gets a page with show moments.

GET /maxxton/v1/infotexts/showmoments
Description

Gets a page with show moments. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
momentId:0,
name:String,
description:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageShowMoment

500

Error occurred while fetching show moments.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/infotexts/showmoments
Example HTTP response
Response 200
{
  "content" : [ {
    "description" : "string",
    "momentId" : 1,
    "name" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.22. Languages

Available languages in the system

5.22.1. Gets languages

GET /maxxton/v1/languages
Description

Gets List of languages. The records can be filtered based on the language object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
languageId:String,
shortName:String,
defaultLanguage:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< Language
> array

500

Error occurred while fetching languages.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/languages
Example HTTP response
Response 200
[ {
  "defaultLanguage" : true,
  "languageId" : "string",
  "shortName" : "string"
} ]

5.23. Ledgers

Ledgers

5.23.1. Gets LedgerGroup for specific ledgerGroupId

GET /maxxton/v1/ledgers/groups/{ledgerGroupId}
Description

Gets LedgerGroup by LedgerGroup id

Parameters
Type Name Description Schema

Path

ledgerGroupId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

LedgerGroup

500

Error occurred while fetching ledger for the given ledger group id.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/ledgers/groups/{ledgerGroupId}
Example HTTP response
Response 200
{
  "code" : "string",
  "ledgerGroupId" : 1,
  "resortsGroups" : [ {
    "costCenter" : {
      "costCenterId" : 1,
      "costCenterNumber" : "string",
      "description" : "string",
      "name" : "string"
    },
    "costCenterDependsResort" : true,
    "costCenterId" : 1,
    "costUnitId" : 1,
    "costcenterDependsonResortRc" : true,
    "costcenterDependsonWorkorder" : true,
    "ledgerId" : 1,
    "resortgroupId" : 1,
    "resortgroupPriority" : 1,
    "secondLedgerId" : 1
  } ],
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ]
}

5.23.2. Gets Ledger for specific ledger id

GET /maxxton/v1/ledgers/{ledgerId}
Description

Gets ledger by ledger id.

Parameters
Type Name Description Schema

Path

ledgerId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Ledger

500

Error occurred while fetching ledger for the given ledger id.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/ledgers/{ledgerId}
Example HTTP response
Response 200
{
  "description" : "string",
  "ledgerId" : 1,
  "ledgerNumber" : "string",
  "name" : "string"
}

5.23.3. Gets a page with ledger groups

GET /maxxton/v1/ledgers/groups
Description

Gets page with ledgers. The records can be filtered based on ledger object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ledgerGroupId:0,
code:String,
translations:String,
resortsGroups:String)

Query

returnResortGroups
optional

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageLedgerGroup

500

Error occurred while fetching ledger groups.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/ledgers/groups
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "ledgerGroupId" : 1,
    "resortsGroups" : [ {
      "costCenter" : {
        "costCenterId" : 1,
        "costCenterNumber" : "string",
        "description" : "string",
        "name" : "string"
      },
      "costCenterDependsResort" : true,
      "costCenterId" : 1,
      "costUnitId" : 1,
      "costcenterDependsonResortRc" : true,
      "costcenterDependsonWorkorder" : true,
      "ledgerId" : 1,
      "resortgroupId" : 1,
      "resortgroupPriority" : 1,
      "secondLedgerId" : 1
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.23.4. Gets a page with ledgers

GET /maxxton/v1/ledgers
Description

Gets page with ledgers.The records can be filtered based on ledger object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ledgerId:0,
description:String,
ledgerNumber:String,
name:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageLedger

500

Error occurred while fetching resorts.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/ledgers
Example HTTP response
Response 200
{
  "content" : [ {
    "description" : "string",
    "ledgerId" : 1,
    "ledgerNumber" : "string",
    "name" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.24. Locks

Locks

5.24.1. Gets configured lock reasons

GET /maxxton/v1/locks/reasons
Description

Gets a page with all configured lock reasons. The records can be filtered based on the resourceLockReason object.It also supports pageable

Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResourceLockReason

500

Error occurred while fetching lock reasons.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/locks/reasons
Example HTTP response
Response 200
{
  "content" : [ {
    "reasonId" : 1,
    "translations" : [ {
      "description" : "string",
      "langauge" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.25. Memos

Informative text on different entities

5.25.1. Gets a page with memo categories

GET /maxxton/v1/memos/categories
Description

Gets a page with memo categories. The records can be filtered based on memo category object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoCategoryId:0,
code:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageMemoCategory

500

Error occurred while fetching memo categories

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/memos/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "memoCategoryId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26. Offer

Discounts or special offers on accommodations

5.26.1. Add addition of offers

POST /maxxton/v1/offers/{resourceId}/additions
Description

Add addition of offers by an addition resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

Addition resource id of offer, which is an addition on a resource specified by resourceId in the request body.

integer (int64)

Body

requestBody
required

TemporaryResourceAddition
Responses
Code Description Schema

200

The request is completed successfully without any errors

TemporaryResourceAddition

500

Error occurred while fetching addition.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/additions
Request body
{
  "additionFast" : true,
  "additionId" : 1,
  "additionResourceId" : 1,
  "addonType" : "string",
  "bookDateFrom" : "01-01-2023T11:23:45Z",
  "bookDateTo" : "01-01-2023T11:23:45Z",
  "i18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "mandatoryResource" : true,
  "maxQuantity" : 1,
  "maxReservable" : 1,
  "maxTotalQuantity" : 1,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 1,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 1,
  "validFrom" : "01-01-2023",
  "validTo" : "01-01-2023"
}
Example HTTP response
Response 200
{
  "additionFast" : true,
  "additionId" : 1,
  "additionResourceId" : 1,
  "addonType" : "string",
  "bookDateFrom" : "01-01-2023T11:23:45Z",
  "bookDateTo" : "01-01-2023T11:23:45Z",
  "i18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "mandatoryResource" : true,
  "maxQuantity" : 1,
  "maxReservable" : 1,
  "maxTotalQuantity" : 1,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 1,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 1,
  "validFrom" : "01-01-2023",
  "validTo" : "01-01-2023"
}

5.26.2. Add contract type of offers

POST /maxxton/v1/offers/{resourceId}/contracttypes
Description

When we add the contract type on offer, that offer will only bookable from that unit which have same contract type configuration.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which contract type will add for offers

integer (int64)

Body

requestBody
required

OfferContractType
Responses
Code Description Schema

200

The request is completed successfully without any errors

OfferContractType

500

Error occurred while adding contract type on offer

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/contracttypes
Request body
{
  "contracttypeId" : 1,
  "resourceId" : 1
}
Example HTTP response
Response 200
{
  "contracttypeId" : 1,
  "resourceId" : 1
}

5.26.3. Add rentability for offers

POST /maxxton/v1/offers/{resourceId}/rentability
Description

Rentability defines a specific period in which the offer is rentable.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which rentability will be added for offers

integer (int64)

Body

requestBody
required

RentabilityDetail
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while adding rentability.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/rentability
Request body
{
  "bookdateFrom" : "01-01-2023T11:23:45Z",
  "bookdateTo" : "01-01-2023T11:23:45Z",
  "dateBegin" : "01-01-2023",
  "dateEnd" : "01-01-2023",
  "dayMax" : 1,
  "dayMin" : 1,
  "daysOfWeek" : [ "string" ],
  "isArrival" : true,
  "isDeparture" : true,
  "isTemporary" : 1,
  "managerId" : 1,
  "maxDeviationArrDepDate" : 1,
  "maxTimeAfterBookDate" : 1,
  "minDeviationArrDepDate" : 1,
  "minTimeAfterBookDate" : 1
}
Example HTTP response

5.26.4. Create a new offer

POST /maxxton/v1/offers
Description

The endpoint can be used to reserve/book offer i.e special or product

Parameters
Type Name Description Schema

Body

requestBody
required

Offer_Detail
Responses
Code Description Schema

200

The request is completed successfully without any errors

Offer_Detail

500

Error occurred while creating offer

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers
Request body
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "01-01-2023",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 1,
  "offerType" : "string",
  "parentId" : 1,
  "path" : "string",
  "poolWeightage" : 1,
  "powerplaygroupId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "01-01-2023",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 1,
  "offerType" : "string",
  "parentId" : 1,
  "path" : "string",
  "poolWeightage" : 1,
  "powerplaygroupId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

5.26.5. Create representations of offer

POST /maxxton/v1/offers/{resourceId}/representations
Description

Create representations of offer to a specific resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

resourceId of offer for which the representations will be create.

integer (int64)

Body

requestBody
required

Representation
Responses
Code Description Schema

200

The request is completed successfully without any errors

Representation

500

Error occurred while creating representations.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/representations
Request body
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "representationId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "representationId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}

5.26.6. Delete a contract type

DELETE /maxxton/v1/offers/{resourceId}/contracttypes/{contracttypeId}
Description

Delete a contract type of offer based on offer id and contract type id

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id of offer

integer (int64)

Path

contracttypeId
required

contracttype id which want to delete

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

contract type is deleted without any error.

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/contracttypes/{contracttypeId}
Example HTTP response

5.26.7. Get Offer rates

GET /maxxton/v1/offers/{resourceId}/rates
Description

Gets a page with offer rates. The records can be filtered based on rate object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rateId:0,
value:0.0,
remark:String,
qrvType:String,
priority:0,
bookdateFrom:String(date),
bookdateTo:String(date),
usageDurationFrom:0,
usageDurationTo:0,
cashflowmanagerId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

Resource id for which Rates are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRateResource

500

Error occurred while fetching offer rates.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/rates
Example HTTP response
Response 200
{
  "content" : [ {
    "applicableTo" : [ {
      "accommodationKindId" : 1,
      "resourceId" : 1,
      "resourceType" : "string"
    } ],
    "bookdateFrom" : "01-01-2023T11:23:45Z",
    "bookdateTo" : "01-01-2023T11:23:45Z",
    "daysOfWeek" : [ "string" ],
    "duration" : 1,
    "maxDeviation" : 1,
    "maxDuration" : 1,
    "maxDurationMinutes" : 1,
    "minDeviation" : 1,
    "minDuration" : 1,
    "minDurationMinutes" : 1,
    "priority" : 1,
    "qrvType" : "string",
    "qrvValues" : [ {
      "minQuantity" : 1,
      "value" : 1
    } ],
    "quantifier" : "string",
    "rateId" : 1,
    "rateTypeIds" : [ "integer" ],
    "rateTypes" : [ {
      "rateTypeId" : 1
    } ],
    "remark" : "string",
    "resourceId" : 1,
    "resources" : [ {
      "accommodationKindId" : 1,
      "resourceId" : 1,
      "resourceType" : "string"
    } ],
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "usageDowList" : [ "string" ],
    "usageDurationFrom" : 1,
    "usageDurationTo" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023",
    "value" : 1,
    "valueType" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.8. Get a page with offers available.

GET /maxxton/v1/offers
Description

Gets a page with offers associated with resource id. The records can be filtered bassed on offer object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
code:String,
resortId:0,
parentId:0,
path:String,
lowestLevel:true,
allowPriceOverride:true,
source:String,
showNilPriceOnBill:true,
powerplaygroupId:0,
allowMovingToMainBill:true,
archivedFrom:String(date),
offerType:String,
offerPolicy:String,
offerPriority:0,
autovalidateValue:0,
type:String,
poolWeightage:0,
customizableResource:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOffer_Detail

500

Error occurred while fetching Specials

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers
Example HTTP response
Response 200
{
  "content" : [ {
    "allowMovingToMainBill" : true,
    "allowPriceOverride" : true,
    "allowToPublish" : true,
    "archivedFrom" : "01-01-2023",
    "autovalidate" : true,
    "code" : "string",
    "customizableResource" : true,
    "excludePriceCache" : true,
    "lowestLevel" : true,
    "offerExactPeriodOnly" : true,
    "offerPolicy" : "string",
    "offerPriority" : 1,
    "offerType" : "string",
    "parentId" : 1,
    "path" : "string",
    "poolWeightage" : 1,
    "powerplaygroupId" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "searchCode" : "string",
    "secretOffer" : true,
    "showNilPriceOnBill" : true,
    "source" : "string",
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.9. Get addition of offer

GET /maxxton/v1/offers/{resourceId}/additions
Description

Get addition of offer. The records can be filtered based on resource addition object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
bookDateFrom:String(date),
bookDateTo:String(date),
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

ResourceId for which offer want to get additions

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageTemporaryResourceAddition

500

Error occurred while fetching addtion.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "additionFast" : true,
    "additionId" : 1,
    "additionResourceId" : 1,
    "addonType" : "string",
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "mandatoryResource" : true,
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "maxTotalQuantity" : 1,
    "priceCompare" : true,
    "resortArticle" : true,
    "resourceId" : 1,
    "resourceMoment" : [ "string" ],
    "supplierAdditionId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.10. Get implies of offer

GET /maxxton/v1/offers/implies
Description

Gets a page with implies of offer. The records can be filtered based on implies object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching implies.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.11. Get implies of offer

GET /maxxton/v1/offers/{resourceId}/implies
Description

Implies are the mandatory resources which can be booked, the optional resources can be retrieved through the additions call.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Path

resourceId
required

ResourceId of offer for which the implies needs to be fetched.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

500

Error occurred while fetching implies.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.12. Get offer to a specific resource id

GET /maxxton/v1/offers/{resourceId}
Description

Get offer associated with a specific resouce id.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id to fetched offer

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Offer_Detail

500

Error occurred while fetching Offer

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "01-01-2023",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 1,
  "offerType" : "string",
  "parentId" : 1,
  "path" : "string",
  "poolWeightage" : 1,
  "powerplaygroupId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

5.26.13. Get offers contracttype

GET /maxxton/v1/offers/{resourceId}/contracttypes
Description

Gets a page with contract types related to a particular resource id. The records can be filtered based on offer contract types.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contracttypeId:0,
resourceId:0)

Path

resourceId
required

Resource id of offer which want to fetch contract types

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOfferContractType

500

Error occurred while getting contract types for offer

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/contracttypes
Example HTTP response
Response 200
{
  "content" : [ {
    "contracttypeId" : 1,
    "resourceId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.14. Get representations of offer

GET /maxxton/v1/offers/{resourceId}/representations
Description

Get representations of offer by a specific resource id. The records can be filtered based on representation object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
visible:true,
bookable:true)

Path

resourceId
required

ResourceId of offer for which the representations needs to be fetched.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRepresentation

500

Error occurred while fetching representations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/representations
Example HTTP response
Response 200
{
  "content" : [ {
    "bookable" : true,
    "distributionChannelIds" : [ "integer" ],
    "representationId" : 1,
    "resourceId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "i18nRepresentationId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "representationId" : 1,
      "shortDescription" : "string"
    } ],
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.15. Gets Offers additions

GET /maxxton/v1/offers/additions
Description

Gets a page with offers additions. The records can be filtered based on resource addition object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
bookDateFrom:String(date),
bookDateTo:String(date),
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageTemporaryResourceAddition

500

Error occurred while fetching offers additions.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "additionFast" : true,
    "additionId" : 1,
    "additionResourceId" : 1,
    "addonType" : "string",
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "i18n" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "mandatoryResource" : true,
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "maxTotalQuantity" : 1,
    "priceCompare" : true,
    "resortArticle" : true,
    "resourceId" : 1,
    "resourceMoment" : [ "string" ],
    "supplierAdditionId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.26.16. Insert the offer rate

POST /maxxton/v1/offers/{resourceId}/rates
Description

The offer rates can be inserted by a particular resource id and cashflow rules.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which Offer rates will insert

integer (int64)

Body

requestBody
required

Cashflowrule
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while fetching Offer rates.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/rates
Request body
{
  "arrivalDateFrom" : "01-01-2023",
  "arrivalDateTo" : "01-01-2023",
  "bookdateFrom" : "01-01-2023T11:23:45Z",
  "bookdateTo" : "01-01-2023T11:23:45Z",
  "cashflowruleId" : 1,
  "daysOfWeek" : [ "string" ],
  "duration" : 1,
  "maxDeviation" : 1,
  "maxDuration" : 1,
  "maxUnit" : 1,
  "minDeviation" : 1,
  "minDuration" : 1,
  "minUnit" : 1,
  "priority" : 1,
  "quantifier" : "string",
  "rateLevelId" : 1,
  "rateOptionId" : 1,
  "rateTypeIds" : [ "integer" ],
  "remark" : "string",
  "repeatable" : 1,
  "resourceId" : 1,
  "status" : 1,
  "stay" : 1,
  "translations" : [ {
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "usageDowList" : [ "string" ],
  "usageDurationFrom" : 1,
  "usageDurationTo" : 1,
  "usageUnitFrom" : 1,
  "usageUnitTo" : 1,
  "validFrom" : "01-01-2023",
  "validTo" : "01-01-2023",
  "value" : 1,
  "valueType" : "string"
}
Example HTTP response

5.26.17. Update a offer

PUT /maxxton/v1/offers/{resourceId}
Description

The offer to a specific resource id can be updated.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id of offer which want to update

integer (int64)

Body

requestBody
required

Offer_Detail
Responses
Code Description Schema

200

The request is completed successfully without any errors

Offer_Detail

500

Error occurred while creating offer

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}
Request body
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "01-01-2023",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 1,
  "offerType" : "string",
  "parentId" : 1,
  "path" : "string",
  "poolWeightage" : 1,
  "powerplaygroupId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "01-01-2023",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 1,
  "offerType" : "string",
  "parentId" : 1,
  "path" : "string",
  "poolWeightage" : 1,
  "powerplaygroupId" : 1,
  "resortId" : 1,
  "resourceId" : 1,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

5.26.18. Update addition of offers

PUT /maxxton/v1/offers/{additionResourceId}/additions/{additionId}
Description

Update addition details of a resource by addition resource id and addition id.

Parameters
Type Name Description Schema

Path

additionResourceId
required

The resource on which the offer is applicable as an addition and needs to be modified.

integer (int64)

Body

requestBody
required

The resource on which the offer is applicable as an addition.

TemporaryResourceAddition

Path

additionId
required

Addition id which is going to be updated

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

ResourceAdditionRequest

500

Error occurred while fetching addtion.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/offers/{additionResourceId}/additions/{additionId}
Request body
{
  "additionFast" : true,
  "additionId" : 1,
  "additionResourceId" : 1,
  "addonType" : "string",
  "bookDateFrom" : "01-01-2023T11:23:45Z",
  "bookDateTo" : "01-01-2023T11:23:45Z",
  "i18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "mandatoryResource" : true,
  "maxQuantity" : 1,
  "maxReservable" : 1,
  "maxTotalQuantity" : 1,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 1,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 1,
  "validFrom" : "01-01-2023",
  "validTo" : "01-01-2023"
}
Example HTTP response
Response 200
{
  "additionFast" : true,
  "additionId" : 1,
  "additionResourceId" : 1,
  "addonType" : "string",
  "bookDateFrom" : "01-01-2023T11:23:45Z",
  "bookDateTo" : "01-01-2023T11:23:45Z",
  "mandatoryResource" : true,
  "maxQuantity" : 1,
  "maxReservable" : 1,
  "maxTotalQuantity" : 1,
  "priceCompare" : true,
  "resourceId" : 1,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 1,
  "validFrom" : "01-01-2023",
  "validTo" : "01-01-2023"
}

5.27. Operations

Operations

5.27.1. Get Images

GET /maxxton/v1/operations/{issueIncidentId}/images
Description

Images added during resolving the tasks .The records can be filtered based on Images object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileName:String,
imageId:0,
startDate:String(date),
endDate:String(date),
mimeType:String,
version:0,
uploadDate:String(date),
imageType:String,
imageOrientation:String,
modifiedDate:String(date))

Path

issueIncidentId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImages

500

Error occurred while fetching Image

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/operations/{issueIncidentId}/images
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageOrientation" : "string",
    "imageType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.27.2. Gets periodical tasks

GET /maxxton/v1/operations/periodicalTasks
Description

All configured periodical tasks which can be used in operation management. The records can be filtered based on PeriodicalTask object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
issueTaskConfigId:0,
code:String,
comments:String,
scheduleType:String,
individualWorkorder:true)

Query

resortIds
optional

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePeriodicalTask

500

Error occurred while fetching Periodical tasks

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/operations/periodicalTasks
Example HTTP response
Response 200
{
  "content" : [ {
    "areaId" : 1,
    "areas" : [ {
      "areaId" : 1,
      "i18nArea" : [ {
        "areaId" : 1,
        "description" : "string",
        "description2" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "translations" : [ {
        "areaId" : 1,
        "description" : "string",
        "description2" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "comments" : "string",
    "i18nArea" : [ {
      "areaId" : 1,
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "i18nIssueCategory" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "i18nIssueItem" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "individualWorkorder" : true,
    "issueCategories" : {
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "issueItem" : {
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "issueTaskConfigId" : 1,
    "issueTaskSchedules" : [ {
      "resortId" : 1,
      "scheduleType" : "string",
      "schedules" : [ {
        "endDayOfWeek" : 1,
        "endExecOnFinalDayOfMonth" : true,
        "endMonthOfYear" : 1,
        "endSpecificDayOfMonth" : 1,
        "issueTaskScheduleId" : 1,
        "numberOfDaysAfterLastExecDate" : 1,
        "numberOfYearsAfterLastExecDate" : 1,
        "startDayOfWeek" : 1,
        "startExecOnFinalDayOfMonth" : true,
        "startMonthOfYear" : 1,
        "startSpecificDayOfMonth" : 1
      } ]
    } ],
    "resortIds" : [ "integer" ],
    "scheduleType" : "string",
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "workOrderTaskConfigurationResorts" : [ {
      "resortId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.27.3. Gets tasks

GET /maxxton/v1/operations/tasks
Description

Tasks created based on periodical tasks which can be executed on the resort. The records can be filtered based on tasks object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
issueIncidentId:0,
resortId:0,
reportedWorkOrder:String,
reportedBy:String,
onHoldReason:String,
workTime:0,
priority:0,
status:String,
employeeId:0,
reportedDate:String(date),
workTimeAddedDateTime:String(date),
type:String,
issueTaskConfigId:0,
expectedStartDate:String(date),
expectedEndDate:String(date),
resourceId:0,
modifiedDate:String(date),
parentId:0,
referenceNumber:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOperationTask

500

Error occurred while fetching tasks

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/operations/tasks
Example HTTP response
Response 200
{
  "content" : [ {
    "employeeId" : 1,
    "expectedEndDate" : "01-01-2023",
    "expectedStartDate" : "01-01-2023",
    "imageManagerId" : 1,
    "issueIncidentId" : 1,
    "issueTaskConfigId" : 1,
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "onHoldReason" : "string",
    "parentId" : 1,
    "priority" : 1,
    "referenceNumber" : 1,
    "reportedBy" : "string",
    "reportedDate" : "01-01-2023T11:23:45Z",
    "reportedWorkOrder" : "string",
    "resortId" : 1,
    "resourceId" : 1,
    "status" : "string",
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "workTime" : 1,
    "workTimeAddedDateTime" : "01-01-2023T11:23:45Z"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28. Owners

Someone who owns an accommodation

5.28.1. Authenticate a owner

POST /maxxton/v1/owners/login
Description

Authenticate a owner based on login credentials and return owner details if the owner credentials are authentic.

Parameters
Type Name Description Schema

Body

requestBody
required

Login credentials of the owner to be authenticated.

CustomerCredential
Responses
Code Description Schema

200

The request is completed successfully without any errors

Owner

401

Invalid credentials.

No Content

500

Error occurred while authenticating this customer

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/login
Request body
{
  "login" : "string",
  "password" : "string"
}
Example HTTP response
Response 200
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthCountryId" : 1,
  "birthDate" : "01-01-2023",
  "birthPlace" : "string",
  "company" : true,
  "companyIdentificationNumber" : "string",
  "companyName" : "string",
  "dac7OwnerVerified" : true,
  "emailAllowed" : true,
  "firstName" : "string",
  "fiscalTypes" : [ {
    "endDate" : "01-01-2023",
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "ownerFiscalTypeId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "ibanNumber" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "mailAllowed" : true,
  "middle" : "string",
  "origin" : "string",
  "originId" : "string",
  "owner" : true,
  "ownerGroupId" : 1,
  "ownerId" : 1,
  "ownerPool" : "string",
  "ownerType" : "string",
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 1,
  "sex" : "string",
  "sharedOwnerShips" : [ {
    "ownerId" : 1,
    "realOwnerId" : 1
  } ],
  "socialSecurityNumber" : "string",
  "socialSecurityNumberIssuingCountryId" : 1,
  "taxNumber" : "string",
  "taxNumberIssuingCountryId" : 1,
  "titleId" : 1
}

5.28.2. Create Ownership

POST /maxxton/v1/owners/{ownerId}/units
Description

Create a link between an existing unit and an existing owner using ownership.

Parameters
Type Name Description Schema

Body

requestBody
required

A ownership object to be added.

Ownership

Path

ownerId
required

ownerId of owner

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Ownership

500

Error occurred while creating ownership

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units
Request body
{
  "endDate" : "01-01-2023",
  "isReportToAuth" : true,
  "origin" : "string",
  "originId" : "string",
  "ownershipId" : 1,
  "startDate" : "01-01-2023",
  "unitId" : 1
}
Example HTTP response
Response 200
{
  "endDate" : "01-01-2023",
  "isReportToAuth" : true,
  "origin" : "string",
  "originId" : "string",
  "ownershipId" : 1,
  "startDate" : "01-01-2023",
  "unitId" : 1
}

5.28.3. Get owner’s reservation details

GET /maxxton/v1/owners/{ownerId}/reservations/details
Description

Get owner’s reservation details. the recored can be filter based on employeeId and contractType. It also supports pageable.
This endpoint contains reservedResources in the response which might increase in future, which in result may reduce the performance of the endpoint, so allowed maximum page size to 10 to keep this endpoint stable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationId:0,
arrivalDate:String(date),
departureDate:String(date),
reservationDate:String(date),
reservationNumber:String,
status:0)

Query

contractType
optional

ContractType to filter the owner’s reservation detail

string

Query

employeeId
optional

Employee id to filter the owner reservation detail

integer (int64)

Path

ownerId
required

The id of owner whose accommodation reservations will be fetched in the response.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerUnitReservation

500

Error occurred while fetching owner’s reservation detail

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/reservations/details
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDate" : "01-01-2023",
    "categoryCode" : "string",
    "customer" : {
      "countryCode" : "string",
      "customerId" : 1,
      "firstName" : "string",
      "lastName" : "string",
      "mailAddressManagerId" : 1
    },
    "customerId" : 1,
    "departureDate" : "01-01-2023",
    "distributionChannelCode" : "string",
    "distributionChannelId" : 1,
    "duration" : 1,
    "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
    "expectedArrivalTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureTime" : "01-01-2023T11:23:45Z",
    "reservationCategoryId" : 1,
    "reservationDate" : "01-01-2023T11:23:45Z",
    "reservationId" : 1,
    "reservationNumber" : "string",
    "reservedResources" : [ {
      "addonType" : "string",
      "addons" : [ {
        "addonType" : "string",
        "code" : "string",
        "parentReservedResourceId" : 1,
        "resourceId" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "resourceId" : 1,
          "shortDescription" : "string"
        } ]
      } ],
      "endDate" : "01-01-2023",
      "ownerId" : 1,
      "rateTypeId" : 1,
      "reservedResourceId" : 1,
      "resourceId" : 1,
      "startDate" : "01-01-2023",
      "unitCode" : "string",
      "unitId" : 1
    } ],
    "status" : 1,
    "statusValue" : "string",
    "subjects" : [ {
      "maxAge" : 1,
      "quantity" : 1,
      "subjectId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.4. Get the generated hash and provides link

GET /maxxton/v1/owners/{ownerId}/files/{fileId}
Description

Get the generated hash for specific file which has information related to file

Parameters
Type Name Description Schema

Path

ownerId
required

Owner id to fetch files associated with the owner

integer (int64)

Path

fileId
required

file id to fetch a specific file

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

DocumentUrl

404

No document found for specific file id.

No Content

500

Error occured while generating hash

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/files/{fileId}
Example HTTP response
Response 200
{
  "downloadLink" : "string"
}

5.28.5. Gets a page with owner groups

GET /maxxton/v1/owners/groups
Description

Gets a page of owner groups. The records can be filtered based on ownergroup object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerGroupId:0,
name:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerGroup

500

Error occurred while fetching owner groups

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/groups
Example HTTP response
Response 200
{
  "content" : [ {
    "name" : "string",
    "ownerGroupId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.6. Gets a page with owners SettlementEntries

GET /maxxton/v1/owners/settlements/{settlementId}/entries
Description

Gets a page of Settlements Entries, The records can be filtered based on Owner SettlementEntry object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
baseLedgerId:0,
commissionSecondLedgerId:0,
resourceId:0,
reservedresourceId:0,
vatDeductionBase:0.0,
resourceRedirectionId:0,
discount:0.0,
vatDeductionBaseNow:0.0,
ownerId:0,
type:String,
fiscalVat:String,
entryId:0,
ownerAmountVatPercentage:0,
maxOwnerAmount:0.0,
reservationId:0,
totalPreviousOwnerAmounts:0.0,
baseSecondLedgerId:0,
rentAmount:0.0,
ownerBillNumber:String,
commissionCostCenterId:0,
commissionLedgerId:0,
contractRuleId:0,
blockedDays:0,
previousCommission:0.0,
invoicenumber:String,
advancePercentage:0,
excludedDays:0,
entryDate:String(date),
realOwnerId:0,
roundDifference:0.0,
settlementPercentage:0,
vatCommission:0.0,
baseCostCenterId:0,
beneficiary:String,
fiscalType:String,
previousOwnerAmount:0.0,
ownerAmountDeduction:0.0,
totalPrevVatOwnerAmounts:0.0,
ownerCurrencyId:0,
description:String,
vatPercentageDeductionBase:0,
settlementId:0,
basesumIncltax:0,
commission:0.0,
ownerAmount:0.0,
unitId:0,
contracttypeId:0,
pooldistributionId:0,
deductionBase:0.0,
resortId:0,
contraId:0,
currentDeductionBase:0.0,
deductionSettlementId:0,
vatPercentageCommission:0,
deductionBaseNow:0.0,
contractId:0,
vatOwnerAmount:0.0,
finalContractrule:true,
daysInDistribution:0,
invoiceId:0,
status:true)

Path

settlementId
required

Settlement id to fetch entries

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors.

PageOwnerSettlementEntry

500

Error occurred while fetching Settlements Entries

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/settlements/{settlementId}/entries
Example HTTP response
Response 200
{
  "content" : [ {
    "advancePercentage" : 1,
    "baseCostCenterId" : 1,
    "baseLedgerId" : 1,
    "baseSecondLedgerId" : 1,
    "basesumIncltax" : 1,
    "beneficiary" : "string",
    "blockedDays" : 1,
    "commission" : 1,
    "commissionCostCenterId" : 1,
    "commissionLedgerId" : 1,
    "commissionSecondLedgerId" : 1,
    "contraId" : 1,
    "contractId" : 1,
    "contractRuleId" : 1,
    "contracttypeId" : 1,
    "currentDeductionBase" : 1,
    "daysInDistribution" : 1,
    "deductionBase" : 1,
    "deductionBaseNow" : 1,
    "deductionSettlementId" : 1,
    "description" : "string",
    "discount" : 1,
    "distributionChannelCurrencyId" : 1,
    "entryDate" : "01-01-2023T11:23:45Z",
    "entryId" : 1,
    "excludedDays" : 1,
    "finalContractrule" : true,
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "invoiceId" : 1,
    "invoicenumber" : "string",
    "maxOwnerAmount" : 1,
    "ownerAmount" : 1,
    "ownerAmountDeduction" : 1,
    "ownerAmountVatPercentage" : 1,
    "ownerBillNumber" : "string",
    "ownerCurrencyId" : 1,
    "ownerId" : 1,
    "pooldistributionId" : 1,
    "previousCommission" : 1,
    "previousOwnerAmount" : 1,
    "realOwnerId" : 1,
    "rentAmount" : 1,
    "reservationId" : 1,
    "reservedresourceId" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "resourceRedirectionId" : 1,
    "roundDifference" : 1,
    "settlementId" : 1,
    "settlementPercentage" : 1,
    "status" : true,
    "totalPrevVatOwnerAmounts" : 1,
    "totalPreviousOwnerAmounts" : 1,
    "type" : "string",
    "unitId" : 1,
    "vatCommission" : 1,
    "vatDeductionBase" : 1,
    "vatDeductionBaseNow" : 1,
    "vatOwnerAmount" : 1,
    "vatPercentageCommission" : 1,
    "vatPercentageDeductionBase" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.7. Gets a page with owners Settlements

GET /maxxton/v1/owners/settlements
Description

Gets a page of Settlements, The records can be filtered based on Owner Settlement object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerMutationReportNumber:0,
settlementId:0,
savePreviousBalance:true,
createdAt:String(date),
isPoolSettlement:true,
adminOrganisationId:0,
madePermanentAt:String(date),
settleInvoicesUntilDate:String(date),
resortId:0,
overridePercentageDepartureDate:String(date),
settleRedirectionUntilDate:String(date),
madePermanentByEmployeeId:0,
settlementDate:String(date),
settlementNumber:0,
settlementPercentage:0,
settleReservationPaymentDepartureDate:String(date),
settlementName:String,
createdByEmployeeId:0,
invoicesReservationPaymentDepartureDate:String(date),
status:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors.

PageOwnerSettlement

500

Error occurred while fetching Owner Settlements.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/settlements
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : 1,
    "comments" : "string",
    "createdAt" : "01-01-2023T11:23:45Z",
    "createdByEmployeeId" : 1,
    "invoicesReservationPaymentDepartureDate" : "01-01-2023",
    "isPoolSettlement" : true,
    "madePermanentAt" : "01-01-2023",
    "madePermanentByEmployeeId" : 1,
    "overridePercentageDepartureDate" : "01-01-2023",
    "ownerMutationReportNumber" : 1,
    "resortId" : 1,
    "savePreviousBalance" : true,
    "settleInvoicesUntilDate" : "01-01-2023",
    "settleRedirectionUntilDate" : "01-01-2023",
    "settleReservationPaymentDepartureDate" : "01-01-2023",
    "settlementDate" : "01-01-2023T11:23:45Z",
    "settlementId" : 1,
    "settlementName" : "string",
    "settlementNumber" : 1,
    "settlementPercentage" : 1,
    "status" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.8. Gets a page with owners.

GET /maxxton/v1/owners
Description

Gets a page with owners. The records can be filtered based on owner object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
accountNr:String,
firstName:String,
lastName:String,
middle:String,
alternateName:String,
attentionOf:String,
birthDate:String(date),
languageId:0,
mailAllowed:true,
sendMethodId:0,
sex:String,
origin:String,
originId:String,
socialSecurityNumber:String,
emailAllowed:true,
titleId:0,
ibanNumber:String,
bicSwift:String,
companyName:String,
ownerGroupId:0,
ownerPool:String,
birthPlace:String,
companyIdentificationNumber:String,
socialSecurityNumberIssuingCountryId:0,
taxNumberIssuingCountryId:0,
taxNumber:String,
ownerType:String,
dac7OwnerVerified:true,
birthCountryId:0)

Query

returnFiscalType
optional

The fiscal types will be returned when the value is set to true

boolean

Query

returnSharedOwnerShips
optional

The List of shared ownerIds will be returned when the value is set to true

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwner

500

Error occurred while fetching owners

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners
Example HTTP response
Response 200
{
  "content" : [ {
    "accountNr" : "string",
    "alternateName" : "string",
    "attentionOf" : "string",
    "bicSwift" : "string",
    "birthCountryId" : 1,
    "birthDate" : "01-01-2023",
    "birthPlace" : "string",
    "company" : true,
    "companyIdentificationNumber" : "string",
    "companyName" : "string",
    "dac7OwnerVerified" : true,
    "emailAllowed" : true,
    "firstName" : "string",
    "fiscalTypes" : [ {
      "endDate" : "01-01-2023",
      "fiscalType" : "string",
      "fiscalVat" : "string",
      "ownerFiscalTypeId" : 1,
      "startDate" : "01-01-2023"
    } ],
    "ibanNumber" : "string",
    "languageId" : 1,
    "lastName" : "string",
    "mailAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAddressManagerId" : 1,
    "mailAllowed" : true,
    "middle" : "string",
    "origin" : "string",
    "originId" : "string",
    "owner" : true,
    "ownerGroupId" : 1,
    "ownerId" : 1,
    "ownerPool" : "string",
    "ownerType" : "string",
    "questionnaireUnsubscribed" : true,
    "sendMethodId" : 1,
    "sex" : "string",
    "sharedOwnerShips" : [ {
      "ownerId" : 1,
      "realOwnerId" : 1
    } ],
    "socialSecurityNumber" : "string",
    "socialSecurityNumberIssuingCountryId" : 1,
    "taxNumber" : "string",
    "taxNumberIssuingCountryId" : 1,
    "titleId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.9. Gets a page with ownerships

GET /maxxton/v1/owners/{ownerId}/units/{unitId}/ownerships
Description

Gets a page of ownerships, The records can be filtered based on ownership object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownershipId:0,
unitId:0,
startDate:String(date),
endDate:String(date),
origin:String,
originId:String)

Path

unitId
required

Unit id to fetch ownerships of the unit

integer (int64)

Path

ownerId
required

Owner id to fetch ownership of the owner

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors.

PageOwnershipResponse

500

Error occurred while fetching ownerships.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units/{unitId}/ownerships
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "origin" : "string",
    "originId" : "string",
    "ownershipId" : 1,
    "startDate" : "01-01-2023",
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.10. Gets accommodationtypes associated with the owner

GET /maxxton/v1/owners/{ownerId}/accommodationtypes
Description

Gets a page with accommodationtype associated with particular owner. The records can be filtered based on owner accommodation type object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
resourceId:0)

Query

code
optional

Code of the accommodationType

string

Path

ownerId
required

Owner id to fetch accommodationtypes of the owner

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerAccommodationType

500

Error occurred while fetching owners with accommodationtypes

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/accommodationtypes
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "accotypeKindId" : 1,
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "code" : "string",
    "dependsOnLedgerGroup" : true,
    "hasObjects" : true,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "numberOfPersons" : 1,
    "ownerId" : 1,
    "parentId" : 1,
    "path" : "string",
    "priority" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "supplierOrigin" : "string",
    "translations" : [ {
      "accotypeKind" : "string",
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.11. Gets all files

GET /maxxton/v1/owners/{ownerId}/files
Description

Get a page with files associated with an owner.The records are filtered based on filebase object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileId:0,
name:String,
fileName:String,
fileSize:0,
fileType:String,
uploadDate:String(date),
endDate:String(date),
shortDescription:String,
validFrom:String(date),
validTo:String(date))

Path

ownerId
required

Owner id for which the files are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDocumentBase

404

No owner or files found for given owner id.

No Content

500

Error occurred while fetching files

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/files
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileId" : 1,
    "fileName" : "string",
    "fileSize" : 1,
    "fileType" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "uploadDate" : "01-01-2023",
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.12. Gets an owner.

GET /maxxton/v1/owners/{ownerId}
Description

Gets information associated with specific owner. The records can be filtered based on owner object.

Parameters
Type Name Description Schema

Path

ownerId
required

An Id of owner to be fetched

integer (int64)

Query

returnSharedOwnerShips
optional

The List of shared ownerIds will be returned when the value is set to true

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

Owner

500

Error occurred while fetching owner

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}
Example HTTP response
Response 200
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthCountryId" : 1,
  "birthDate" : "01-01-2023",
  "birthPlace" : "string",
  "company" : true,
  "companyIdentificationNumber" : "string",
  "companyName" : "string",
  "dac7OwnerVerified" : true,
  "emailAllowed" : true,
  "firstName" : "string",
  "fiscalTypes" : [ {
    "endDate" : "01-01-2023",
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "ownerFiscalTypeId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "ibanNumber" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "mailAllowed" : true,
  "middle" : "string",
  "origin" : "string",
  "originId" : "string",
  "owner" : true,
  "ownerGroupId" : 1,
  "ownerId" : 1,
  "ownerPool" : "string",
  "ownerType" : "string",
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 1,
  "sex" : "string",
  "sharedOwnerShips" : [ {
    "ownerId" : 1,
    "realOwnerId" : 1
  } ],
  "socialSecurityNumber" : "string",
  "socialSecurityNumberIssuingCountryId" : 1,
  "taxNumber" : "string",
  "taxNumberIssuingCountryId" : 1,
  "titleId" : 1
}

5.28.13. Gets history associated with owner

GET /maxxton/v1/owners/{ownerId}/communications
Description

Get a page with communication call done with a client associated with an owner on reservation basis.The records are filtered based on communication object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerCommunicationId:0,
sendDate:String(date),
sendingType:String,
reservationId:0,
message:String,
senderEmail:String,
subject:String)

Path

ownerId
required

Owner id for which the communication calls are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCommunication

404

No owner or owner communication found for given owner id.

No Content

500

Error occurred while fetching owner communication calls

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/communications
Example HTTP response
Response 200
{
  "content" : [ {
    "attachments" : [ {
      "endDate" : "01-01-2023T11:23:45Z",
      "fileId" : 1,
      "fileName" : "string",
      "fileSize" : 1,
      "fileType" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "uploadDate" : "01-01-2023T11:23:45Z",
      "validFrom" : "01-01-2023T11:23:45Z",
      "validTo" : "01-01-2023T11:23:45Z"
    } ],
    "customerCommunicationId" : 1,
    "message" : "string",
    "report" : {
      "reportCode" : "string"
    },
    "reportCode" : "string",
    "reportType" : "string",
    "reportUrl" : [ {
      "reportType" : "string"
    } ],
    "reportUrls" : [ {
      "reportType" : "string"
    } ],
    "reservationId" : 1,
    "sendDate" : "01-01-2023T11:23:45Z",
    "senderEmail" : "string",
    "sendingType" : "string",
    "staticAttachments" : [ {
      "endDate" : "01-01-2023T11:23:45Z",
      "fileId" : 1,
      "fileName" : "string",
      "fileSize" : 1,
      "fileType" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "uploadDate" : "01-01-2023T11:23:45Z",
      "validFrom" : "01-01-2023T11:23:45Z",
      "validTo" : "01-01-2023T11:23:45Z"
    } ],
    "subject" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.14. Gets owner with his units

GET /maxxton/v1/ownergroups/{ownerGroupId}/units
Description

Gets a page of units associated to the owner. The records can be filtered based on owner unit object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
startDate:String(date),
endDate:String(date))

Query

resourceId
optional

ResourceId of the accommodationType to which the unit is linked

integer (int64)

Query

code
optional

Code of the unit

string

Path

ownerGroupId
required

OwnerGroup Id to fetch units of the owners

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerUnit

500

Error occurred while fetching owners with units

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/ownergroups/{ownerGroupId}/units
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "choosableOnInternet" : true,
    "cleaningStatus" : "string",
    "code" : "string",
    "endDate" : "01-01-2023",
    "excludeQuestionnaireStats" : true,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "origin" : "string",
    "originId" : "string",
    "ownerGroupId" : 1,
    "ownerId" : 1,
    "path" : "string",
    "resourceGroupId" : 1,
    "resourceId" : 1,
    "roomCode" : "string",
    "startDate" : "01-01-2023",
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "unitId" : 1
    } ],
    "unitId" : 1,
    "vsi" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.15. Gets owner with his units

GET /maxxton/v1/owners/{ownerId}/units
Description

Gets a page of units associated to the owner. The records can be filtered based on owner unit object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
startDate:String(date),
endDate:String(date))

Query

resourceId
optional

ResourceId of the accommodationType to which the unit is linked

integer (int64)

Query

code
optional

Code of the unit

string

Path

ownerId
required

Owner id to fetch units of the owner

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerUnit

500

Error occurred while fetching owners with units

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "choosableOnInternet" : true,
    "cleaningStatus" : "string",
    "code" : "string",
    "endDate" : "01-01-2023",
    "excludeQuestionnaireStats" : true,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "origin" : "string",
    "originId" : "string",
    "ownerGroupId" : 1,
    "ownerId" : 1,
    "path" : "string",
    "resourceGroupId" : 1,
    "resourceId" : 1,
    "roomCode" : "string",
    "startDate" : "01-01-2023",
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "unitId" : 1
    } ],
    "unitId" : 1,
    "vsi" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.16. Gets owners with their accommodationtype

GET /maxxton/v1/owners/accommodationtypes
Description

Gets a page with owners with their accommodationtype. The records can be filtered based on owner accommodation type object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
resourceId:0)

Query

code
optional

Code of the accommodationType

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerAccommodationType

500

Error occurred while fetching owners with accommodationtypes

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/accommodationtypes
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "accotypeKindId" : 1,
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "code" : "string",
    "dependsOnLedgerGroup" : true,
    "hasObjects" : true,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "numberOfPersons" : 1,
    "ownerId" : 1,
    "parentId" : 1,
    "path" : "string",
    "priority" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "supplierOrigin" : "string",
    "translations" : [ {
      "accotypeKind" : "string",
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "namePath" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.17. Gets owners with their units

GET /maxxton/v1/owners/units
Description

Gets a page with owners with their units. The records can be filtered based on owner unit object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
startDate:String(date),
endDate:String(date))

Query

resourceId
optional

ResourceId of the accommodationType to which the unit is linked

integer (int64)

Query

code
optional

Code of the unit

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerUnit

500

Error occurred while fetching owners with units

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/units
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "archivedFrom" : "01-01-2023",
    "brand" : "string",
    "choosableOnInternet" : true,
    "cleaningStatus" : "string",
    "code" : "string",
    "endDate" : "01-01-2023",
    "excludeQuestionnaireStats" : true,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "origin" : "string",
    "originId" : "string",
    "ownerGroupId" : 1,
    "ownerId" : 1,
    "path" : "string",
    "resourceGroupId" : 1,
    "resourceId" : 1,
    "roomCode" : "string",
    "startDate" : "01-01-2023",
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "unitId" : 1
    } ],
    "unitId" : 1,
    "vsi" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.18. Gets reservation of a specified units for an owner

GET /maxxton/v1/owners/{ownerId}/units/{unitId}/reservations
Description

Gets a page of reservations associated to a specified units for an owner. It also supports pageable.
This endpoint contains reservedResources in the response which might increase in future, which in result may reduce the performance of the endpoint, so allowed maximum page size to 10 to keep this endpoint stable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationId:0,
arrivalDate:String(date),
departureDate:String(date),
reservationDate:String(date),
reservationNumber:String,
status:0)

Path

unitId
required

Unit id to fetch reservations of the unit

integer (int64)

Path

ownerId
required

Owner id to fetch units of the owner

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageOwnerUnitReservation

500

Error occurred while fetching owners with units

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units/{unitId}/reservations
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDate" : "01-01-2023",
    "categoryCode" : "string",
    "customer" : {
      "countryCode" : "string",
      "customerId" : 1,
      "firstName" : "string",
      "lastName" : "string",
      "mailAddressManagerId" : 1
    },
    "customerId" : 1,
    "departureDate" : "01-01-2023",
    "distributionChannelCode" : "string",
    "distributionChannelId" : 1,
    "duration" : 1,
    "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
    "expectedArrivalTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureTime" : "01-01-2023T11:23:45Z",
    "reservationCategoryId" : 1,
    "reservationDate" : "01-01-2023T11:23:45Z",
    "reservationId" : 1,
    "reservationNumber" : "string",
    "reservedResources" : [ {
      "addonType" : "string",
      "addons" : [ {
        "addonType" : "string",
        "code" : "string",
        "parentReservedResourceId" : 1,
        "resourceId" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "resourceId" : 1,
          "shortDescription" : "string"
        } ]
      } ],
      "endDate" : "01-01-2023",
      "ownerId" : 1,
      "rateTypeId" : 1,
      "reservedResourceId" : 1,
      "resourceId" : 1,
      "startDate" : "01-01-2023",
      "unitCode" : "string",
      "unitId" : 1
    } ],
    "status" : 1,
    "statusValue" : "string",
    "subjects" : [ {
      "maxAge" : 1,
      "quantity" : 1,
      "subjectId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.28.19. Update owner

PUT /maxxton/v1/owners/{ownerId}
Description

Update owner of provided ownerId.

Parameters
Type Name Description Schema

Body

requestBody
required

owner with field value that needs to be update

UpdateOwnerRequest

Path

ownerId
required

ownerId of owner which needs to be update

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Owner

500

Error occurred while updating owner.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}
Request body
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "company" : true,
  "companyName" : "string",
  "emailAllowed" : true,
  "firstName" : "string",
  "fiscalTypes" : [ {
    "endDate" : "01-01-2023",
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "ownerFiscalTypeId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "ibanNumber" : "string",
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "origin" : "string",
  "originId" : "string",
  "ownerGroupId" : 1,
  "ownerPool" : "string",
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 1,
  "sex" : "string",
  "titleId" : 1
}
Example HTTP response
Response 200
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthCountryId" : 1,
  "birthDate" : "01-01-2023",
  "birthPlace" : "string",
  "company" : true,
  "companyIdentificationNumber" : "string",
  "companyName" : "string",
  "dac7OwnerVerified" : true,
  "emailAllowed" : true,
  "firstName" : "string",
  "fiscalTypes" : [ {
    "endDate" : "01-01-2023",
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "ownerFiscalTypeId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "ibanNumber" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "mailAllowed" : true,
  "middle" : "string",
  "origin" : "string",
  "originId" : "string",
  "owner" : true,
  "ownerGroupId" : 1,
  "ownerId" : 1,
  "ownerPool" : "string",
  "ownerType" : "string",
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 1,
  "sex" : "string",
  "sharedOwnerShips" : [ {
    "ownerId" : 1,
    "realOwnerId" : 1
  } ],
  "socialSecurityNumber" : "string",
  "socialSecurityNumberIssuingCountryId" : 1,
  "taxNumber" : "string",
  "taxNumberIssuingCountryId" : 1,
  "titleId" : 1
}

5.28.20. Update ownership

PUT /maxxton/v1/owners/{ownerId}/units/{unitId}
Description

Update ownership of provided ownershipId.

Parameters
Type Name Description Schema

Body

requestBody
required

ownership with field value that needs to be update

Ownership

Path

unitId
required

unitId of ownership

integer (int64)

Path

ownerId
required

ownerId of ownership

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Ownership

500

Error occurred while updating ownership.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units/{unitId}
Request body
{
  "endDate" : "01-01-2023",
  "isReportToAuth" : true,
  "origin" : "string",
  "originId" : "string",
  "ownershipId" : 1,
  "startDate" : "01-01-2023",
  "unitId" : 1
}
Example HTTP response
Response 200
{
  "endDate" : "01-01-2023",
  "isReportToAuth" : true,
  "origin" : "string",
  "originId" : "string",
  "ownershipId" : 1,
  "startDate" : "01-01-2023",
  "unitId" : 1
}

5.28.21. create owner

POST /maxxton/v1/owners
Description

Adds a new Owner. The details are to be added in request body.
Note: The country field in mailAddress is not allowed while adding a owner.

Parameters
Type Name Description Schema

Body

requestBody
required

CreateOwnerRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

Owner

500

Error occurred while creating the owner

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners
Request body
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthDate" : "01-01-2023",
  "company" : true,
  "companyName" : "string",
  "emailAllowed" : true,
  "firstName" : "string",
  "fiscalTypes" : [ {
    "endDate" : "01-01-2023",
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "ownerFiscalTypeId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "ibanNumber" : "string",
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "origin" : "string",
  "originId" : "string",
  "owner" : true,
  "ownerGroupId" : 1,
  "ownerPool" : "string",
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 1,
  "sex" : "string",
  "titleId" : 1
}
Example HTTP response
Response 200
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthCountryId" : 1,
  "birthDate" : "01-01-2023",
  "birthPlace" : "string",
  "company" : true,
  "companyIdentificationNumber" : "string",
  "companyName" : "string",
  "dac7OwnerVerified" : true,
  "emailAllowed" : true,
  "firstName" : "string",
  "fiscalTypes" : [ {
    "endDate" : "01-01-2023",
    "fiscalType" : "string",
    "fiscalVat" : "string",
    "ownerFiscalTypeId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "ibanNumber" : "string",
  "languageId" : 1,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "mailAllowed" : true,
  "middle" : "string",
  "origin" : "string",
  "originId" : "string",
  "owner" : true,
  "ownerGroupId" : 1,
  "ownerId" : 1,
  "ownerPool" : "string",
  "ownerType" : "string",
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 1,
  "sex" : "string",
  "sharedOwnerShips" : [ {
    "ownerId" : 1,
    "realOwnerId" : 1
  } ],
  "socialSecurityNumber" : "string",
  "socialSecurityNumberIssuingCountryId" : 1,
  "taxNumber" : "string",
  "taxNumberIssuingCountryId" : 1,
  "titleId" : 1
}

5.28.22. updates the customer credentials

PUT /maxxton/v1/owners/{ownerId}/credentials
Description

This endpoint can update the login and password of a owner in Maxxton. The /maxxton/v1/owners/login can be used to check if this login is correct and can be used to authenticate a user in an external system. There is no user session management available. The login and password can be changed in this call. The password can not be fetched from the API because of security reasons. In case the login field or password field is kept empty the existing value will be kept.

Parameters
Type Name Description Schema

Body

requestBody
required

Login credentials of the owner to be updated.

CustomerCredential

Path

ownerId
required

owner id to update the owner credentials

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while updating the owner credentials

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/credentials
Request body
{
  "login" : "string",
  "password" : "string"
}
Example HTTP response

5.29. Packages

Packages

5.29.1. Gets all packages items

GET /maxxton/v1/packages/items
Description

Gets a page of all packages items, records can be filtered based on fields on packages items object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
packageResourceId:0,
parentId:0,
resourceId:0,
sequence:0,
duration:0,
quantity:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePackageItem

500

Error occurred while fetching packages items

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/packages/items
Example HTTP response
Response 200
{
  "content" : [ {
    "duration" : 1,
    "packageResourceId" : 1,
    "parentId" : 1,
    "quantity" : 1,
    "resourceId" : 1,
    "sequence" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "packageItemId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.29.2. Gets all packages items by packageResourceId.

GET /maxxton/v1/packages/{packageResourceId}/items
Description

Gets a list of all packages items, records can be filtered based on fields on packages items object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
packageResourceId:0,
parentId:0,
resourceId:0,
sequence:0,
duration:0,
quantity:0)

Path

packageResourceId
required

packageResourceId to fetch particular package

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< PackageItem
> array

500

Error occurred while fetching packages items

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/packages/{packageResourceId}/items
Example HTTP response
Response 200
[ {
  "duration" : 1,
  "packageResourceId" : 1,
  "parentId" : 1,
  "quantity" : 1,
  "resourceId" : 1,
  "sequence" : 1,
  "translations" : [ {
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "packageItemId" : 1
  } ]
} ]

5.30. Payment Term Set

Informations related to payment term sets.

5.30.1. Get a page of Payment term sets

GET /maxxton/v1/paymenttermsets
Description

Get all the payment term sets.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
paymentTermSetId:0,
priority:0,
minArrivalDeviation:0,
maxArrivalDeviation:0,
validFrom:String(date),
validTo:String(date),
arrivalDateFrom:String(date),
arrivalDateTo:String(date),
minStayLength:0,
maxStayLength:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePaymentTermSet

500

Error occurred while fetching these reservations

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/paymenttermsets
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "maxArrivalDeviation" : 1,
    "maxStayLength" : 1,
    "minArrivalDeviation" : 1,
    "minStayLength" : 1,
    "nonRefundable" : true,
    "paymentTermSetId" : 1,
    "paymentTermSetType" : "string",
    "preBooking" : true,
    "priority" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.31. PointsOfInterests

PointsOfInterests

5.31.1. Gets Points Of Interest

GET /maxxton/v1/pointofinterests
Description

All configured PointsOfInterest. The records can be filtered based on PointsOfInterest object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
pointsOfInterestId:0,
code:String,
startDate:String(date),
endDate:String(date),
visibleFrom:String(date),
visibleTo:String(date),
pointsOfInterestCategoryId:0,
url:String,
priority:0,
price:String,
priceChildren:String,
priceAdult:String,
priceValuePoint:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePointsOfInterest

500

Error occurred while fetching PointOfInterests

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/pointofinterests
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "endDate" : "01-01-2023",
    "endTime" : {
      "hour" : 1,
      "minute" : 1,
      "nano" : 1,
      "second" : 1
    },
    "pointsOfInterestCategoryId" : 1,
    "pointsOfInterestId" : 1,
    "price" : "string",
    "priceAdult" : "string",
    "priceChildren" : "string",
    "priceValuePoint" : "string",
    "priority" : 1,
    "resortIds" : [ "integer" ],
    "startDate" : "01-01-2023",
    "startTime" : {
      "hour" : 1,
      "minute" : 1,
      "nano" : 1,
      "second" : 1
    },
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "headText" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "text" : "string"
    } ],
    "url" : "string",
    "visibleFrom" : "01-01-2023",
    "visibleTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.31.2. Gets Points OfInterests Categories

GET /maxxton/v1/pointofinterests/categories
Description

All configured PointOfInterestsCategories. The records can be filtered based on PointsOfInterestCategory object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
pointsOfInterestCategoryId:0,
code:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePointsOfInterestCategory

500

Error occurred while fetching PointOfInterestsCategories

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/pointofinterests/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "pointsOfInterestCategoryId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.32. PredefinedMemo

Informative text on different entities

5.32.1. Gets a page with predefined memo

GET /maxxton/v1/predefinedmemos
Description

Gets a page with predefined memo. The records can be filtered based on predefined memo object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
preDefinedMemoId:0,
memoCategoryId:0,
code:String,
priority:0,
validFrom:String(date),
validTo:String(date),
content:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePredefinedMemo

500

Error occurred while fetching memo categories

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/predefinedmemos
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "content" : "string",
    "memoCategoryId" : 1,
    "preDefinedMemoId" : 1,
    "priority" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "validFrom" : "01-01-2023T11:23:45Z",
    "validTo" : "01-01-2023T11:23:45Z"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.33. Rate Types

A group of different prices of an accommodation type

5.33.1. Gets all Rate types

GET /maxxton/v1/ratetypes
Description

Gets a page with rate types.The records can be filtered based on rate type object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rateTypeId:0,
code:String,
priority:0,
isDefault:true,
name:String,
currencyId:0,
endDate:String(date))

Query

distributionChannelCode
optional

distributionChannelCode code to filter rate types.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRateType

500

Error occurred while fetching contract Types.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/ratetypes
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "currencyCode" : "string",
    "currencyId" : 1,
    "distributionChannels" : [ {
      "bookdateFrom" : "01-01-2023T11:23:45Z",
      "bookdateTo" : "01-01-2023T11:23:45Z",
      "distributionChannelId" : 1,
      "endDate" : "01-01-2023T11:23:45Z",
      "id" : 1,
      "startDate" : "01-01-2023T11:23:45Z"
    } ],
    "endDate" : "01-01-2023T11:23:45Z",
    "isDefault" : true,
    "name" : "string",
    "priority" : 1,
    "rateTypeDchannel" : [ {
      "bookdateFrom" : "01-01-2023T11:23:45Z",
      "bookdateTo" : "01-01-2023T11:23:45Z",
      "distributionChannelId" : 1,
      "endDate" : "01-01-2023T11:23:45Z",
      "id" : 1,
      "startDate" : "01-01-2023T11:23:45Z"
    } ],
    "rateTypeId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.34. Region

Defines region on a map

5.34.1. Get a region

GET /maxxton/v1/regions/{regionId}
Description

Gets the details of region. The records can be filtered based on region object.It also supports pageable.

Parameters
Type Name Description Schema

Path

regionId
required

An Id of region to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Region

500

Error occurred while fetching region

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/regions/{regionId}
Example HTTP response
Response 200
{
  "breadCrumbs" : "string",
  "childIds" : [ "integer" ],
  "code" : "string",
  "geoShapePoints" : [ "array" ],
  "i18n" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "lowestLevel" : true,
  "name" : "string",
  "parentId" : 1,
  "priority" : 1,
  "regionId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ]
}

5.34.2. Gets regions

GET /maxxton/v1/regions
Description

Gets a page with regions. The records can be filtered based on region object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
regionId:0,
code:String,
parentId:0,
priority:0)

Query

returnGeoShapePoints
optional

The geoShapePoints will be returned when the value is set to true

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRegion

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching regions

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/regions
Example HTTP response
Response 200
{
  "content" : [ {
    "breadCrumbs" : "string",
    "childIds" : [ "integer" ],
    "code" : "string",
    "geoShapePoints" : [ "array" ],
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "lowestLevel" : true,
    "name" : "string",
    "parentId" : 1,
    "priority" : 1,
    "regionId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.35. Rentability

Possible arrival and departure days

5.35.1. Gets a page of Rentability Sets

GET /maxxton/v1/rentability/sets
Description

Gets a page with rentability sets. The records can be filtered based on rentabilityset object. It also supports a pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rentabilitySetId:0,
resortId:0,
rentabilityManagerId:0,
startDate:String(date),
endDate:String(date),
code:String,
preBooking:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRentabilitySet

500

Error occurred while fetching rentability sets.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/rentability/sets
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "endDate" : "01-01-2023",
    "preBooking" : true,
    "rentabilityManagerId" : 1,
    "rentabilitySetId" : 1,
    "resortId" : 1,
    "startDate" : "01-01-2023",
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.35.2. Gets a page of Rentability markers

GET /maxxton/v1/rentability/config
Description

Gets a page with rentability markers. Distribution channel ids and resource id is used to fetch the rentability markers. The records can be filtered based on rentability object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rentabilityId:0,
managerId:0,
dateBegin:String(date),
dateEnd:String(date),
minDeviationArrDepDate:0,
maxDeviationArrDepDate:0,
isTemporary:0,
bookDateFrom:String(date),
bookDateTo:String(date),
maxTimeAfterBookDate:0,
minTimeAfterBookDate:0,
gap:0)

Query

resourceId
optional

A resourceId to fetch rentability markers

integer (int64)

Query

distributionChannelId
optional

A distributionChannelId to fetch rentability Markers

integer (int64)

Query

resourceType
optional

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRentability

500

Error occurred while fetching rentability markers.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/rentability/config
Example HTTP response
Response 200
{
  "content" : [ {
    "bookDateFrom" : "01-01-2023T11:23:45Z",
    "bookDateTo" : "01-01-2023T11:23:45Z",
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "distributionChannelIds" : [ "integer" ],
    "gap" : 1,
    "isTemporary" : 1,
    "managerId" : 1,
    "maxDeviationArrDepDate" : 1,
    "maxTimeAfterBookDate" : 1,
    "minDeviationArrDepDate" : 1,
    "minTimeAfterBookDate" : 1,
    "rentabilityId" : 1,
    "rentabilityMarkers" : [ {
      "dowMask" : 1,
      "rentabilityMarkerId" : 1,
      "timeMax" : 1,
      "timeMin" : 1,
      "type" : "string"
    } ],
    "resourceIds" : [ "integer" ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.35.3. Gets page with rentabilities

GET /maxxton/v1/rentability/stays
Description

Gets a page with stay summaries. Distibution channel id, resource id is used to fetch stay summaries. Max arrival is a date to specify the stay summaries. Maximum duration specifies a duration in minutes which represent day(s).It also supports pageable.

Parameters
Type Name Description Schema

Query

maxArrival
optional

A maxArrival date to fetch stay summaries

string (date)

Query

resourceId
required

A resourceId to fetch stay summaries

integer (int64)

Query

distributionChannelId
required

A distributionChannelId to fetch stay summaries

integer (int64)

Query

maxDuration
optional

Max duration in days to limit records based on duration.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageStaySummary

500

Error occurred while fetching stay summaries.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/rentability/stays
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDate" : "01-01-2023",
    "duration" : 1,
    "rentabilityManagerId" : 1,
    "validFrom" : "01-01-2023T11:23:45Z",
    "validTo" : "01-01-2023T11:23:45Z"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.36. Representation

Defines accommodation type configuration valid for a distribution channel

5.36.1. Add the distribution channel to a representation

POST /maxxton/v1/representations/{representationId}/distributionchannels
Description

The representation is the link between resource(accommodationtype) and distribution channel. One resource(accommodation type) can have multiple representations and one representation can be linked to multiple distribution channel Ids. One distribution channel can only be asses to one representation per resource.

Parameters
Type Name Description Schema

Path

representationId
required

representationId for which distribution channel will be added

integer (int64)

Body

requestBody
required

RepresentationDistributionChannel
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while linking the distribution channel to a representation.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}/distributionchannels
Request body
{
  "channelId" : 1,
  "code" : "string",
  "distributionChannelId" : 1,
  "name" : "string",
  "path" : "string",
  "representationId" : 1
}
Example HTTP response

5.36.2. Delete representation

DELETE /maxxton/v1/representations/{representationId}
Description

Delete representation of a provided representation id.

Parameters
Type Name Description Schema

Path

representationId
required

id of the representation which needs to be deleted

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

representation is deleted without any error.

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}
Example HTTP response

5.36.3. Get distribution channels based on representation id

GET /maxxton/v1/representations/{representationId}/distributionchannels
Description

Gets a page with distribution channels based on representation id.The records can be filtered based on representation distribution channel object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
distributionChannelId:0,
code:String)

Path

representationId
required

representationId to fetch the distribution channels of representation

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRepresentationDistributionChannel

500

Error occurred while fetching distribution channel.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}/distributionchannels
Example HTTP response
Response 200
{
  "content" : [ {
    "channelId" : 1,
    "code" : "string",
    "distributionChannelId" : 1,
    "name" : "string",
    "path" : "string",
    "representationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.36.4. Get representation for specific representation id

GET /maxxton/v1/representations/{representationId}
Description

Gets a page with representation for specific representation id.

Parameters
Type Name Description Schema

Path

representationId
required

representationId for which representation will be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Representation

500

Error occurred while fetching representations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "representationId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}

5.36.5. Get representations

GET /maxxton/v1/representations
Description

Get a page with representations. The records can be filtered based on representation object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
visible:true,
bookable:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRepresentation

500

Error occurred while fetching representations.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations
Example HTTP response
Response 200
{
  "content" : [ {
    "bookable" : true,
    "distributionChannelIds" : [ "integer" ],
    "representationId" : 1,
    "resourceId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "i18nRepresentationId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "representationId" : 1,
      "shortDescription" : "string"
    } ],
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.36.6. Remove distribution channel link from representation

DELETE /maxxton/v1/representations/{representationId}/distributionchannels/{distributionChannelId}
Description

Remove distribution channel link from representation based on specific distribution channel id.

Parameters
Type Name Description Schema

Path

representationId
required

id of the representation which needs to be deleted

integer (int64)

Body

requestBody
required

DistributionChannelRepresentation

Path

distributionChannelId
required

id of the distribution channel which needs to be removed from representation

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

From representation distribution channel link is deleted without any error.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}/distributionchannels/{distributionChannelId}
Request body
{
  "allotment" : 1,
  "distributionChannelId" : 1,
  "distributionChannelRepresentationId" : 1,
  "distributionChannelRepresentationParentId" : 1,
  "representationId" : 1
}
Example HTTP response

5.36.7. Update representation

PUT /maxxton/v1/representations/{representationId}
Description

Update representation of provided representationId.

Parameters
Type Name Description Schema

Path

representationId
required

representationId of representation which needs to be update

integer (int64)

Body

requestBody
required

Representation
Responses
Code Description Schema

200

The request is completed successfully without any errors

Representation

500

Error occurred while updating representation.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}
Request body
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "representationId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ "integer" ],
  "representationId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "i18nRepresentationId" : 1,
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "representationId" : 1,
    "shortDescription" : "string"
  } ],
  "visible" : true
}

5.37. Resellers

Agent who are selling accommodation types

5.37.1. Gets a page holding ResellerStopSells.

GET /maxxton/v1/resellers/{resellerId}/stopsells
Description

Gets a page holding ResellerStopSells of a specific reseller id.It also supports pageable.

Parameters
Type Name Description Schema

Path

resellerId
required

resellrId to fetch ResellerStopSell

integer (int64)

Query

stopSellType
required

enumerated value of type StopSellType to fetch ResellerStopSell(s)

enum (BLOCKING,LOWERING,RESTRICTION)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResellerStopSell

500

Error occurred while fetching resellers.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resellers/{resellerId}/stopsells
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "resellerId" : 1,
    "resellerStopSellId" : 1,
    "reservableValue" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "stopSellType" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.37.2. Gets a page holding Resellers

GET /maxxton/v1/resellers
Description

Get a page holding Resellers objects.The records can be filtered based on reseller object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resellerId:0,
code:String,
description:String,
distributionChannelId:0,
name:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReseller

500

Error occurred while fetching resellers.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resellers
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "description" : "string",
    "distributionChannelId" : 1,
    "name" : "string",
    "resellerId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.37.3. Gets a single Reseller by it’s Id.

GET /maxxton/v1/resellers/{resellerId}
Description
Gets a single Reseller by its Id.
Parameters
Type Name Description Schema

Path

resellerId
required

resellerId to fetch reseller

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Reseller

500

Error occurred while fetching reseller.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resellers/{resellerId}
Example HTTP response
Response 200
{
  "code" : "string",
  "description" : "string",
  "distributionChannelId" : 1,
  "name" : "string",
  "resellerId" : 1
}

5.38. Reservability

Number of units available

5.38.1. Gets a Reservability by resource filter

GET /maxxton/v1/resourcereservability
Description

Gets a page of reservability resource. The records can be filtered based on resource reservability object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservabilityId:0,
startDate:String(date),
endDate:String(date),
allocatable:0,
reservable:0,
modifiedDate:String(date))

Query

resourceId
optional

Resource id for which the result is valid

string

Query

resourceType
optional

Resource type of the resourceid

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResourceReservability

500

Error occurred while fetching reservability

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resourcereservability
Example HTTP response
Response 200
{
  "content" : [ {
    "allocatable" : 1,
    "endDate" : "01-01-2023",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "reservabilityId" : 1,
    "reservable" : 1,
    "reserved" : 1,
    "resourceId" : 1,
    "resourceType" : "string",
    "startDate" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.38.2. Gets free allotments for resource reservability.

GET /maxxton/v1/resourcereservability/allotment
Description

The above endpoint gets the free allotments for reservability of resources and the records can be filtered based on fields of ResourceReservabilityAllotment, the max period of start and endDate should not exceed more than 2 years.
There could be some overlapping period for same resourceId and distributionChannelId, so in such case free allotments for the overlapping dates should be merged and calculated based on start date and end date.and the total free allotments for a specific date can be calculated by considering all the records which are overlapping for the specific date.
Example: for a resource id : 12345 and distribution channel id : 67890, The allotment for the entire period of 7th sept 2016 to 14th sept 2016 is 3 but the allotment period is defined as free allotment for 7th sept - 14th sept is 2 and from 9th sept to 14th sept is 1 so the user has to merge these allotments which sums up to 3.
The above endpoint also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
distributionChannelId:0)

Query

resourceId
required

The identifier of the ResourceId to fetch resource reservability

integer (int64)

Query

endDate
required

The identifier of the EndDate to fetch resource reservability

string (date)

Query

startDate
required

The identifier of the StartDate to fetch resource reservability

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResourceReservabilityAllotment

401

Unauthorized access, Please check your access token.

No Content

500

Error occurred while fetching free allotments reservability

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resourcereservability/allotment
Example HTTP response
Response 200
{
  "content" : [ {
    "bookedAllotments" : 1,
    "distributionChannelId" : 1,
    "endDate" : "01-01-2023",
    "freeAllotments" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "totalAllotments" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.38.3. Gets free allotments for unit reservability.

GET /maxxton/v1/unitreservability/allotment
Description

Get free allotments for reservability of units, records can be filtered based on fields of ReservedResourceUnitAllotment.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
startDate:String(date),
endDate:String(date),
resourceId:0)

Query

distributionChannelId
optional

The identifier of the DistributionChannel to fetch unit reservability

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservedResourceUnitAllotment

401

Unauthorized access, Please check your access token.

No Content

500

Error occurred while fetching free allotments reservability

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/unitreservability/allotment
Example HTTP response
Response 200
{
  "content" : [ {
    "distributionChannelId" : 1,
    "endDate" : "01-01-2023",
    "freeAllotments" : 1,
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.38.4. Gets unit reservability periods.

GET /maxxton/v1/unitreservability/period
Description

Gets a list of unit reservability periods. Records can be filtered based on domain holding values for unit reservability search filter.It also supports pageable.

Parameters
Type Name Description Schema

Query

endDate
optional

string (date)

Query

unitId
optional

< integer > array

Query

startDate
optional

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitReservabilityPeriod

500

Error occurred while fetching reservability

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/unitreservability/period
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "reservability" : "string",
    "startDate" : "01-01-2023",
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.38.5. Gets unit reservability.

GET /maxxton/v1/unitreservability
Description

Get a list of unit reservability. The records can be filtered based on unit reservability search object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
modifiedDate:String(date),
arrivalDateFrom:String(date),
arrivalDateTo:String(date),
reservabilityId:0,
allocatable:0,
reservable:0)

Query

resourceId
optional

resourceId for filtering unitReservability

integer (int64)

Query

unitId
optional

unitId for filtering unitReservability

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitReservability

500

Error occurred while fetching reservability

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/unitreservability
Example HTTP response
Response 200
{
  "content" : [ {
    "allocatable" : 1,
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "reservabilityId" : 1,
    "reservable" : 1,
    "reserved" : 1,
    "resourceId" : 1,
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39. Reservations

Customer booking of an accommodation

5.39.1. Add additions

POST /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Description
Addition is an optional resource which guest can opt and book it. This endpoint can be used to reserve/book addition with an existing reservation's reserved resource.
Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id to which additions will be added

integer (int64)

Path

reservedResourceId
required

ReservedResource id to which additions will be added

integer (int64)

Body

requestBody
required

< AdditionRequest
> array
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while adding additions

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Request body
[ {
  "endDate" : "01-01-2023",
  "memo" : "string",
  "name" : "string",
  "price" : 1,
  "quantity" : 1,
  "resourceId" : 1,
  "startDate" : "01-01-2023"
} ]
Example HTTP response

5.39.2. Add custom fields

POST /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Description
Custom fields are part of the reservation that can be updated for a particular reservation. This endpoint can be used to added custom field to the reservation .
Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id to which custom field will be added

integer (int64)

Path

reservedResourceId
required

ReservedResource id to which custom field will be added

integer (int64)

Body

requestBody
required

< CustomField
> array
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while adding custom fields

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Request body
[ {
  "booleanValue" : true,
  "dateValue" : "01-01-2023",
  "fieldId" : 1,
  "numericValue" : 1,
  "selectValues" : [ "string" ],
  "textValue" : "string"
} ]
Example HTTP response

5.39.3. Add payment for reservation

POST /maxxton/v1/reservations/{reservationId}/payments
Description

Creates payment for a reservation for a specific reservationId. The payment details are to be added to the request body. The distribution channel in the authorization token should be same as the one in reservation for which the payment is being created. If the distribution channel is not present in the token, the reservation distribution channel will be used.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which the payment has to be added.

integer (int64)

Body

requestBody
required

ReservationPaymentRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservationPaymentRequest

400

The distribution channel present in the authorization token does not match the distribution channel of the reservation.

No Content

500

Error occurred while adding payments for the reservation.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/payments
Request body
{
  "amount" : 1,
  "currencyCode" : "string",
  "paymentMethodCode" : "string",
  "remark" : "string"
}
Example HTTP response
Response 200
{
  "amount" : 1,
  "currencyCode" : "string",
  "paymentMethodCode" : "string",
  "remark" : "string"
}

5.39.4. Create emergency contact for reservation

POST /maxxton/v1/reservations/{reservationId}/emergencycontacts
Description

Creates emergency contact for a reservation for specific reservationId. The emergency contact details are to be added to the request body.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which emergency contact will be created for reservation

integer (int64)

Body

requestBody
required

EmergencyContact
Responses
Code Description Schema

200

The request is completed successfully without any errors

EmergencyContact

500

Error occurred while creating emergency contact.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/emergencycontacts
Request body
{
  "emergencyContactId" : 1,
  "firstName" : "string",
  "lastName" : "string",
  "middleName" : "string",
  "phone" : "string",
  "relationship" : "string",
  "reservationId" : 1
}
Example HTTP response
Response 200
{
  "emergencyContactId" : 1,
  "firstName" : "string",
  "lastName" : "string",
  "middleName" : "string",
  "phone" : "string",
  "relationship" : "string",
  "reservationId" : 1
}

5.39.5. Create memo for reservation

POST /maxxton/v1/reservations/{reservationId}/memos
Description

Creates memo for a reservation for specific reservationId. The memo details are to be added to the request body.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which memo will be created for reservation

integer (int64)

Body

requestBody
required

MemoRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

Memo

500

Error occurred while creating memo.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/memos
Request body
{
  "memoCategoryId" : 1,
  "onCheckin" : true,
  "onInvoice" : true,
  "sensitive" : true,
  "text" : "string"
}
Example HTTP response
Response 200
{
  "content" : "string",
  "creationDate" : "01-01-2023T11:23:45Z",
  "employeeId" : 1,
  "memoCategoryId" : 1,
  "memoId" : 1,
  "predefinedMemoId" : 1
}

5.39.6. Creates a new reservation

POST /maxxton/v1/reservations
Description

Creates a new reservation based on given criteria.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.

Parameters
Type Name Description Schema

Body

requestBody
required

Reservation criteria based on given detail new reservation will create

ReservationCriteria

Header

locale
optional

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.

string

Query

returnBill
optional

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

boolean

Query

returnInstalments
optional

The instalments will be returned when the value is set to true

boolean

Query

skipAvailabilityIndexCheck
optional

This parameter will skip the check on availability based on the Elastic search availability index. This can be used if a reservation needs to be made when you can’t wait for the index to be updated. It’s recommended to not use this parameter in case you are not really sure what you are doing. By default, this check is always there because it’s giving better performance in case of no availability. When this parameter is true - unitId is mandatory in request.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservationResponse

408

Reservation creation timed out

No Content

500

Error occurred while creating reservation

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations
Request body
{
  "accommodationTypes" : [ {
    "additions" : [ {
      "additionResourceId" : 1,
      "endDate" : "01-01-2023",
      "memo" : "string",
      "quantity" : 1,
      "startDate" : "01-01-2023"
    } ],
    "arrivalDate" : "01-01-2023",
    "duration" : 1,
    "offerCode" : "string",
    "preferences" : [ {
      "id" : 1,
      "remark" : "string",
      "type" : "string"
    } ],
    "rateTypeId" : 1,
    "removeImplies" : [ "integer" ],
    "resourceId" : 1,
    "subjects" : {
      "persons" : [ {
        "age" : 1,
        "quantity" : 1
      } ],
      "petsQuantity" : 1
    },
    "travelParties" : [ {
      "birthDate" : "01-01-2023",
      "firstName" : "string",
      "identityCardNumber" : "string",
      "identityNumber" : "string",
      "identityType" : "string",
      "lastName" : "string",
      "middleName" : "string",
      "sex" : "string"
    } ],
    "unitId" : 1,
    "useLoyaltyFreeNights" : 1,
    "useLoyaltyPoints" : 1,
    "vehicles" : [ {
      "remark" : "string",
      "subjectId" : 1,
      "vehicleRegistrationMark" : "string"
    } ],
    "voucherCode" : "string"
  } ],
  "categoryCode" : "string",
  "customer" : {
    "alternateName" : "string",
    "birthDate" : "01-01-2023",
    "companyName" : "string",
    "emailAllowed" : true,
    "firstName" : "string",
    "language" : "string",
    "lastName" : "string",
    "mailAddress" : {
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "city" : "string",
      "countryCode" : "string",
      "district" : "string",
      "email" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAllowed" : true,
    "middle" : "string",
    "questionnaireUnsubscribed" : true,
    "sex" : "string",
    "socialSecurityNumber" : "string",
    "titleId" : 1
  },
  "customerId" : 1,
  "distributionChannelCode" : "string",
  "employee" : "string",
  "externalBookingReference" : "string",
  "paymentTermSetId" : 1,
  "remark" : "string",
  "sendMethodCode" : "string",
  "statusValue" : "string"
}
Example HTTP response
Response 200
{
  "agentBill" : [ {
    "billLineType" : 1,
    "description" : "string",
    "endDate" : "01-01-2023",
    "name" : "string",
    "redeemedLoyaltyNights" : 1,
    "redeemedLoyaltyPoints" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "total" : 1,
    "vatRate" : 1
  } ],
  "arrivalDate" : "01-01-2023",
  "currencyCode" : "string",
  "customerBill" : [ {
    "billLineType" : 1,
    "description" : "string",
    "endDate" : "01-01-2023",
    "name" : "string",
    "redeemedLoyaltyNights" : 1,
    "redeemedLoyaltyPoints" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "total" : 1,
    "vatRate" : 1
  } ],
  "customerId" : 1,
  "departureDate" : "01-01-2023",
  "externalBookingReference" : "string",
  "infotexts" : [ {
    "description" : "string"
  } ],
  "instalments" : [ {
    "dueAmount" : 1,
    "dueDate" : "01-01-2023",
    "name" : "string",
    "priority" : 1
  } ],
  "paymentTermSetId" : 1,
  "reservationDate" : "01-01-2023T11:23:45Z",
  "reservationId" : 1,
  "reservationInfoTexts" : [ {
    "code" : "string",
    "description" : "string",
    "display" : true,
    "infoTextId" : 1,
    "name" : "string",
    "reservations" : [ {
      "display" : true,
      "infoTextId" : 1,
      "infoTextReservationId" : 1,
      "reservedResourceId" : 1
    } ],
    "reservedResourceId" : 1
  } ],
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "code" : "string",
    "description" : "string",
    "endDate" : "01-01-2023",
    "hasPriceOverride" : true,
    "impliesId" : 1,
    "imply" : true,
    "infotexts" : [ {
      "description" : "string"
    } ],
    "name" : "string",
    "offerType" : "string",
    "parentId" : 1,
    "price" : 1,
    "quantity" : 1,
    "removable" : true,
    "reservedResourceId" : 1,
    "resourceId" : 1,
    "shortDescription" : "string",
    "startDate" : "01-01-2023",
    "type" : "string",
    "unitId" : 1
  } ],
  "resortId" : 1,
  "status" : 1,
  "statusValue" : "string"
}

5.39.7. Creates a reservation proposal

POST /maxxton/v1/reservations/proposals
Description

Creates a reservation proposal based on given criteria. The endpoint provides the availability for a particular property for particular duration. It also provides a virtual bill to the user which contains all the possible additions for a reservation, the currency code is displayed in which the bill will be calculated, customers arrival and departure date, customer bill, installments etc. We can specify the information that we want to view in response i.e there are different query parameters to filter the response. The additions displayed in reservation proposal are displayed on the basis of show moments. There are four show moments for additions i.e mobile, internet, my environment and newyse. The show moments is displayed in the reservation proposal only if the show moment is internet.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.

Parameters
Type Name Description Schema

Body

requestBody
required

ReservationProposalRequest

Query

returnAdditions
optional

The applicable additions will be returned when the value is set to true

boolean

Query

returnUnits
optional

The list of available unit will be returned when the value is set to true.

boolean

Header

locale
optional

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.

string

Query

returnBill
optional

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

boolean

Query

returnInstalments
optional

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

boolean

Query

returnPaymentOptions
optional

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.

boolean

Query

skipAvailabilityIndexCheck
optional

This parameter will skip the check on availability based on the Elastic search availability index. This can be used if a reservation needs to be made when you can’t wait for the index to be updated. It’s recommended to not use this parameter in case you are not really sure what you are doing. By default, this check is always there because it’s giving better performance in case of no availability. When this parameter is true - unitId is mandatory in the request.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservationProposal

500

Error occurred while fetching reservation proposal

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/proposals
Request body
{
  "accommodationTypes" : [ {
    "additions" : [ {
      "additionResourceId" : 1,
      "endDate" : "string",
      "quantity" : 1,
      "startDate" : "string"
    } ],
    "arrivalDate" : "01-01-2023",
    "duration" : 1,
    "offerCode" : "string",
    "preferences" : [ {
      "id" : 1,
      "remark" : "string",
      "type" : "string"
    } ],
    "rateTypeId" : 1,
    "removeImplies" : [ "integer" ],
    "resourceId" : 1,
    "subjects" : {
      "persons" : [ {
        "age" : 1,
        "quantity" : 1
      } ],
      "petsQuantity" : 1
    },
    "unitId" : 1,
    "useLoyaltyFreeNights" : 1,
    "useLoyaltyPoints" : 1,
    "voucherCode" : "string"
  } ],
  "categoryCode" : "string",
  "customerId" : 1,
  "distributionChannelCode" : "string",
  "paymentTermSetId" : 1
}
Example HTTP response
Response 200
{
  "additions" : [ {
    "additionResourceId" : 1,
    "addonType" : "string",
    "code" : "string",
    "currency" : "string",
    "dayAddon" : true,
    "dayProductBookableDates" : [ "string" ],
    "description" : "string",
    "endDate" : "01-01-2023",
    "maxQuantity" : 1,
    "maxReservable" : 1,
    "minQuantity" : 1,
    "name" : "string",
    "perSubject" : true,
    "price" : 1,
    "resortArticle" : true,
    "resourceId" : 1,
    "shortDescription" : "string",
    "startDate" : "01-01-2023",
    "stockType" : "string",
    "type" : "string"
  } ],
  "agentBill" : [ {
    "billLineType" : 1,
    "multiplier" : 1,
    "name" : "string",
    "quantity" : 1,
    "redeemedLoyaltyNights" : 1,
    "redeemedLoyaltyPoints" : 1,
    "resourceId" : 1,
    "total" : 1,
    "value" : 1,
    "vatRate" : 1
  } ],
  "arrivalDate" : "01-01-2023",
  "currencyCode" : "string",
  "customerBill" : [ {
    "billLineType" : 1,
    "multiplier" : 1,
    "name" : "string",
    "quantity" : 1,
    "redeemedLoyaltyNights" : 1,
    "redeemedLoyaltyPoints" : 1,
    "resourceId" : 1,
    "total" : 1,
    "value" : 1,
    "vatRate" : 1
  } ],
  "departureDate" : "01-01-2023",
  "infotexts" : [ {
    "description" : "string",
    "display" : "string",
    "name" : "string"
  } ],
  "instalments" : [ {
    "dueAmount" : 1,
    "dueDate" : "01-01-2023",
    "name" : "string",
    "priority" : 1
  } ],
  "paymentOptions" : [ {
    "agentInstalments" : [ {
      "dueAmount" : 1,
      "dueDate" : "01-01-2023",
      "name" : "string",
      "priority" : 1
    } ],
    "autoPay" : true,
    "customerInstalments" : [ {
      "dueAmount" : 1,
      "dueDate" : "01-01-2023",
      "name" : "string",
      "priority" : 1
    } ],
    "description" : "string",
    "name" : "string",
    "nonRefundable" : true,
    "paymentTermSetId" : 1,
    "priority" : 1
  } ],
  "preBooking" : true,
  "reservedResources" : [ {
    "addOnMetricDescription" : "string",
    "code" : "string",
    "description" : "string",
    "endDate" : "01-01-2023",
    "hasPriceOverride" : true,
    "impliesId" : 1,
    "imply" : true,
    "infotexts" : [ {
      "description" : "string",
      "display" : "string",
      "name" : "string"
    } ],
    "internetAdditionalCost" : true,
    "name" : "string",
    "offerType" : "string",
    "price" : 1,
    "quantity" : 1,
    "removable" : true,
    "resourceId" : 1,
    "shortDescription" : "string",
    "startDate" : "01-01-2023",
    "type" : "string",
    "unitId" : 1
  } ],
  "unitIds" : [ "integer" ]
}

5.39.8. Delete a specific travelparty, vehicle or equipment from the reservation.

DELETE /maxxton/v1/reservations/{reservationId}/subjects/{reservationSubjectId}
Description

Delete a specific travelparty, vehicle or equipment from the reservation.

Parameters
Type Name Description Schema

Path

reservationSubjectId
required

Reservation subject id of the subject to be deleted.

integer (int64)

Path

reservationId
required

Reservation id for which the subjects are to be deleted

integer (int64)
Responses
Code Description Schema

204

specific reservation subject is deleted without any error.

No Content

404

No reservation found for given reservation id.

No Content

500

Error occurred while deleting reservation subject

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects/{reservationSubjectId}
Example HTTP response

5.39.9. Delete reservedResource

DELETE /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Description

Delete exiting reservedResource for the given reservationId and reservedResourceId as per the given criteria

Parameters
Type Name Description Schema

Path

reservationId
required

Id of the reservation which needs to be updated.

integer (int64)

Path

reservedResourceId
required

Id of the reservedresource which needs to be updated

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

No Content

500

Error occurred while updating reservedResource

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Example HTTP response

5.39.10. Get Reservation Payment Link

GET /maxxton/v1/reservations/{reservationId}/paymentlink
Description

Generate a PSP(payment service provider) payment link to pay for the reservation. This will provide a url which can be used by the customer to make the payment from the hosted payment page of the psp. When the payment is succesful it will automatically be added to the reservation in the Maxxton system.

Parameters
Type Name Description Schema

Query

acceptUrl
optional

URL where the customer should be redirected to in case of a successful payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct

string

Query

exceptionUrl
optional

URL where the customer should be redirected to in case of a failed payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct

string

Header

locale
optional

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

string

Query

homeUrl
optional

Home Url of website. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct

string

Query

storeCC
optional

When the value is set to true, the customer’s credit card details will be saved, and a reservation payment token will be generated for further payments

boolean

Query

cancelUrl
optional

URL where the customer should be redirected to in case of a canceled payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct

string

Query

payerType
required

Payer type of payment

enum (PAYING_CUSTOMER,AGENT,CUSTOMER)

Path

reservationId
required

The reservation id defines the reservation the payment goes to. When a payment comes in from Ingenico the open amount of this reservation will be deducted with the amount paid at Ingenico.

integer (int64)

Query

countryCode
optional

CountryCode(e.g. NL/FR) required to fetch the correct payment methods from Ingenico to be used with paymentMethods parameter. This countrycode is not impacting the actual language or locale of the Ingenico page

string

Query

declineUrl
optional

URL where the customer should be redirected to in case of a declined payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct

string

Query

price
required

Amount to be paid, this can be the full reservation amount or part of it.

number (double)

Query

paymentMethods
optional

Payment methods list which will be shown on payment page. Incase not provided all configured payment methods will be shown. To restrict the payment methods, take the paymentMethod field values from the following endpoint https://developers.maxxton.com/maxxton/v1/swagger/index.html#/Reservations/getReservationPaymentMethod Then, pass the paymentMethod obtained from this endpoint in the generatePaymentLink requestParam.

< string > array

Query

returnUrl
optional

The returnUrl parameter specifies the URL to which a customer is redirected after completing a transaction on the Ingenico Direct payment page. This parameter is specific to Ingenico Direct and simplifies the redirection process by consolidating multiple URL parameters used in the legacy Ingenico platform into a single parameter. In the legacy platform, separate URLs (such as declineUrl, acceptUrl, cancelUrl, homeUrl, and exceptionUrl) are used based on the transaction result. These fields are replaced in Ingenico Direct to this single redirection URL(returnUrl).
1). Base URL Setup: The client provides a base URL that will initiates the redirection process after payment on Ingenico page. It’s possible to append some parameters:
{{baseUrl}}/paymentresult?clientparam1=abcd&clientparam2=123.
2). Parameter Addition by Maxxton: Maxxton appends its specific parameters to the client’s returnUrl. This includes identifiers like reservationId and pspId. Example URL after Maxxton additions:
{{baseUrl}}/paymentresult?clientparam1=abcd&clientparam2=123&reservationId={reservationIdNumber}&pspId={pspId}&currencyCode=EUR.
3). Final Redirection by Ingenico: After the payment transaction is completed, Ingenico adds its transaction identification parameters to the URL. This final URL is used to redirect the customer, now including a transaction confirmation token (RETURNMAC) and the hostedCheckoutId. Example of the final redirect URL:
{{baseUrl}}/paymentresult?clientparam1=abcd&clientparam2=123&reservationId={ReservationIdNumber}&pspId={pspId}&currencyCode=EUR&RETURNMAC=ed360b-ee5a-42ae-9e11-e3d384808f3b&hostedCheckoutId={hostedCheckoutIdNumber}.

string

Query

currencyCode
required

Code of currency in which payment will be charged

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PaymentLink

500

Error occurred while creating payment page link

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/paymentlink
Example HTTP response
Response 200
{
  "url" : "string"
}

5.39.11. Get a Reservation details by reservation id

GET /maxxton/v1/reservations/{reservationId}/details
Description

Get a Reservation details by reservation id. Archived resources will also be returned in the response.

Parameters
Type Name Description Schema

Path

reservationId
required

The identifier of the reservation.

integer (int64)

Query

returnEmergencyContacts
optional

The emergency contacts will be returned when the value is set to true

boolean

Query

returnReservedResources
optional

The reserved resource will be returned when the value is set to true

boolean

Query

returnFreeFields
optional

The free fields of reserved resource will be returned when the value is set to true

boolean

Query

returnCustomerStatus
optional

The customer status will be returned when the value is set to true

boolean

Header

locale
optional

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.

string

Query

returnBill
optional

The instalments will be returned when the value is set to true

boolean

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are AGENTBILL, CUSTOMER, CUSTOMERBILL, CUSTOMERSTATUS, EMERGENCYCONTACTS, INFOTEXTS, INSTALMENTS, RESERVEDRESOURCES. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

returnCustomer
optional

The customer will be returned when the value is set to true

boolean

Query

returnInstalments
optional

The instalments will be returned when the value is set to true

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservationDetailResponse

404

No reservation found for given reservation id.

No Content

500

Error occurred while fetching this reservation

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/details
Example HTTP response
Response 200
{
  "agentBill" : [ {
    "billLineType" : 1,
    "endDate" : "01-01-2023",
    "multiplier" : 1,
    "name" : "string",
    "overrideValue" : 1,
    "quantity" : 1,
    "reservationBillId" : 1,
    "reservationBillLineId" : 1,
    "reservedResourceId" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "total" : 1,
    "value" : 1,
    "vatRate" : 1,
    "virtualOverrideValue" : 1
  } ],
  "arrivalDate" : "01-01-2023",
  "cancelDate" : "01-01-2023",
  "categoryCode" : "string",
  "currencyCode" : "string",
  "currencyId" : 1,
  "customer" : {
    "alternateName" : "string",
    "bicSwift" : "string",
    "birthDate" : "01-01-2023",
    "companyName" : "string",
    "creationDate" : "01-01-2023T11:23:45Z",
    "customerId" : 1,
    "emailAllowed" : true,
    "firstName" : "string",
    "ibanNumber" : "string",
    "language" : "string",
    "lastName" : "string",
    "mailAddress" : {
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAllowed" : true,
    "middle" : "string",
    "owner" : true,
    "questionnaireUnsubscribed" : true,
    "sex" : "string",
    "socialSecurityNumber" : "string",
    "title" : {
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "title" : "string"
      } ]
    }
  },
  "customerBill" : [ {
    "billLineType" : 1,
    "endDate" : "01-01-2023",
    "multiplier" : 1,
    "name" : "string",
    "overrideValue" : 1,
    "quantity" : 1,
    "reservationBillId" : 1,
    "reservationBillLineId" : 1,
    "reservedResourceId" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "total" : 1,
    "value" : 1,
    "vatRate" : 1,
    "virtualOverrideValue" : 1
  } ],
  "customerId" : 1,
  "customerStatus" : {
    "customerCluseters" : [ {
      "categoryId" : 1,
      "clusterId" : 1,
      "code" : "string",
      "description" : "string",
      "name" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "customerClusters" : [ {
      "categoryId" : 1,
      "clusterId" : 1,
      "code" : "string",
      "description" : "string",
      "name" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ]
  },
  "departureDate" : "01-01-2023",
  "distributionChannelCode" : "string",
  "distributionChannelId" : 1,
  "emergencyContacts" : [ {
    "emergencyContactId" : 1,
    "firstName" : "string",
    "lastName" : "string",
    "middleName" : "string",
    "phone" : "string",
    "relationship" : "string",
    "reservationId" : 1
  } ],
  "employeeId" : 1,
  "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
  "expectedArrivalTime" : "01-01-2023T11:23:45Z",
  "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
  "expectedDepartureTime" : "01-01-2023T11:23:45Z",
  "externalBookingReference" : "string",
  "infotexts" : [ {
    "description" : "string"
  } ],
  "instalments" : [ {
    "dueAmount" : 1,
    "dueDate" : "01-01-2023",
    "name" : "string",
    "priority" : 1
  } ],
  "modifiedDate" : "01-01-2023T11:23:45Z",
  "parentId" : 1,
  "payingCustomer" : {
    "alternateName" : "string",
    "bicSwift" : "string",
    "birthDate" : "01-01-2023",
    "companyName" : "string",
    "creationDate" : "01-01-2023T11:23:45Z",
    "customerId" : 1,
    "emailAllowed" : true,
    "firstName" : "string",
    "ibanNumber" : "string",
    "language" : "string",
    "lastName" : "string",
    "mailAddress" : {
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAllowed" : true,
    "middle" : "string",
    "owner" : true,
    "questionnaireUnsubscribed" : true,
    "sex" : "string",
    "socialSecurityNumber" : "string",
    "title" : {
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "title" : "string"
      } ]
    }
  },
  "payingCustomerId" : 1,
  "paymentTermSetId" : 1,
  "previousPmsId" : 1,
  "reservationCategoryId" : 1,
  "reservationDate" : "01-01-2023T11:23:45Z",
  "reservationId" : 1,
  "reservationInfoTexts" : [ {
    "code" : "string",
    "description" : "string",
    "display" : true,
    "infoTextId" : 1,
    "name" : "string",
    "reservations" : [ {
      "display" : true,
      "infoTextId" : 1,
      "infoTextReservationId" : 1,
      "reservedResourceId" : 1
    } ],
    "reservedResourceId" : 1
  } ],
  "reservationKind" : "string",
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "actualCheckinTime" : "01-01-2023T11:23:45Z",
    "actualCheckoutTime" : "01-01-2023T11:23:45Z",
    "actualEndDate" : "01-01-2023",
    "actualStartDate" : "01-01-2023",
    "amenities" : [ {
      "amenityId" : 1,
      "categories" : [ {
        "amenityCategoryId" : 1,
        "code" : "string",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "isInternalUse" : true,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      } ],
      "endDate" : "01-01-2023",
      "metricDetail" : {
        "code" : "string",
        "i18n" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "metricId" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      },
      "parentAmenityId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "type" : "string"
    } ],
    "cancellationPremium" : true,
    "code" : "string",
    "description" : "string",
    "endDate" : "01-01-2023",
    "freeFields" : [ {
      "dataTypeName" : "string",
      "fieldId" : 1,
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "type" : "string",
      "value" : "string"
    } ],
    "impliesId" : 1,
    "imply" : true,
    "included" : true,
    "infotexts" : [ {
      "description" : "string"
    } ],
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "name" : "string",
    "nightsRedeemed" : 1,
    "offerType" : "string",
    "parentId" : 1,
    "pointsRedeemed" : 1,
    "preferences" : [ {
      "id" : 1,
      "type" : "string"
    } ],
    "price" : 1,
    "quantity" : 1,
    "rateType" : {
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "rateTypeId" : 1,
    "removable" : true,
    "reservationDate" : "01-01-2023T11:23:45Z",
    "reservedResourceId" : 1,
    "resortArticle" : true,
    "resourceCode" : "string",
    "resourceId" : 1,
    "shortDescription" : "string",
    "startDate" : "01-01-2023",
    "status" : 1,
    "subjects" : [ {
      "includeInTotal" : true,
      "maxAge" : 1,
      "quantity" : 1,
      "subjectId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "resourceId" : 1,
      "shortDescription" : "string"
    } ],
    "turnOverValue" : 1,
    "type" : "string",
    "unit" : {
      "code" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "unitId" : 1
    },
    "unitId" : 1,
    "vatRate" : 1
  } ],
  "resortId" : 1,
  "sendMethodId" : 1,
  "status" : 1,
  "statusValue" : "string",
  "supplierBookingReference" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "01-01-2023",
  "tncSigneeCustomerName" : "string",
  "validationStatusId" : 1,
  "voucher" : "string",
  "vouchers" : [ {
    "amount" : 1,
    "blockReason" : "string",
    "reservationId" : 1,
    "status" : "string",
    "voucher" : {
      "blockReason" : "string",
      "code" : "string",
      "employeeId" : 1,
      "employeeName" : "string",
      "generationDate" : "01-01-2023",
      "numberOfVouchers" : 1,
      "originalReservationId" : 1,
      "printCount" : 1,
      "resourceCode" : "string",
      "status" : "string",
      "type" : "string",
      "validFrom" : "01-01-2023",
      "validTo" : "01-01-2023",
      "voucherCriteriaId" : 1,
      "voucherId" : 1,
      "voucherOriginalValue" : 1,
      "voucherSetCashResourceId" : 1,
      "voucherSetId" : 1,
      "voucherSetName" : "string",
      "voucherSetResourceCode" : "string",
      "voucherTypeName" : "string",
      "voucherValue" : 1
    },
    "voucherId" : 1,
    "voucherRedemptionId" : 1
  } ]
}

5.39.12. Get a list of preferences by reservation id

GET /maxxton/v1/reservations/{reservationId}/preferences
Description

Get a list of preferences by reservation id. The preferences are used to identify specific unit preference, to guarantee that the customer will stay in the unit he/she chose.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which the preferences are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< ReservedResourcePreference
> array

404

No reservation or preferences found for given reservation id.

No Content

500

Error occurred while fetching preferences

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/preferences
Example HTTP response
Response 200
[ {
  "remark" : "string",
  "reservationId" : 1,
  "reservedResourceId" : 1,
  "reservedResourcePreferenceId" : 1,
  "type" : "string"
} ]

5.39.13. Get a page of Reservations

GET /maxxton/v1/reservations
Description

Get all the reservations for particular concern as per the access token and if dc is null then all the reservations of all the dcs are fetched in response.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationId:0,
arrivalDate:String(date),
customerId:0,
departureDate:String(date),
distributionChannelId:0,
modifiedDate:String(date),
reservationCategoryId:0,
reservationDate:String(date),
reservationNumber:String,
resortId:0,
status:0,
supplierVoucher:String,
tncSigned:true,
tncSignedDate:String(date),
tncSigneeCustomerName:String,
type:String,
validationStatus:0,
voucher:String,
parentId:0,
cancelDate:String(date),
originId:String,
origin:String,
expireDate:String(date),
printedDate:String(date),
sendMethodId:0,
paymentTermSetId:0,
reservationKind:String,
payingCustomerId:0)

Query

distributionChannelCode
optional

If DC is present in the access token then the reservations of that DC will be retrieved. If DC is null in access token then the DC entered in filter will be considered. If both DCs are null then all the reservations from all the dc will be fetched.

string

Query

reservationIds
optional

< integer > array

Query

customeremail
optional

string

Query

resourceId
optional

integer (int64)

Query

accommodationtypecode
optional

string

Query

unitId
optional

The unitId for filtering the reservations

integer (int64)

Query

customerName
optional

Filter reservations on customer name. Customer name should be provided in the format specified as: {first name} {middle name} {last name}. Ex: first name = x, middle name = y and last name = z, then the filter field will be passed as: customerName=x y z.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservation

204

No reservations found for given criteria.

No Content

500

Error occurred while fetching these reservations

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDate" : "01-01-2023",
    "cancelDate" : "01-01-2023",
    "categoryCode" : "string",
    "categoryName" : "string",
    "customerId" : 1,
    "departureDate" : "01-01-2023",
    "distributionChannelId" : 1,
    "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
    "expectedArrivalTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureTime" : "01-01-2023T11:23:45Z",
    "expireDate" : "01-01-2023T11:23:45Z",
    "externalBookingReference" : "string",
    "memoManagerId" : 1,
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "origin" : "string",
    "originId" : "string",
    "parentId" : 1,
    "payingCustomerId" : 1,
    "paymentTermSetId" : 1,
    "printedDate" : "01-01-2023",
    "resellerId" : 1,
    "reservationCategoryId" : 1,
    "reservationDate" : "01-01-2023T11:23:45Z",
    "reservationId" : 1,
    "reservationKind" : "string",
    "reservationNumber" : "string",
    "resortId" : 1,
    "sendMethodId" : 1,
    "status" : 1,
    "statusValue" : "string",
    "supplierVoucher" : "string",
    "tncSigned" : true,
    "tncSignedDate" : "01-01-2023",
    "tncSigneeCustomerName" : "string",
    "type" : "string",
    "validationStatus" : 1,
    "voucher" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.14. Get a page of preferences by reservation ids

GET /maxxton/v1/reservations/preferences
Description

Get a page of preferences by reservation ids. The preferences are used to identify specific unit preference, to guarantee that the customer will stay in the unit he/she chose.

Parameters
Type Name Description Schema

Query

reservationIds
required

Reservation ids for which the preferences are to be fetched

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservedResourcePreferencePerReservation

500

Error occurred while fetching preferences

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/preferences
Example HTTP response
Response 200
{
  "content" : [ {
    "reservationId" : 1,
    "reservedResourcePreferences" : [ {
      "remark" : "string",
      "reservationId" : 1,
      "reservedResourceId" : 1,
      "reservedResourcePreferenceId" : 1,
      "type" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.15. Get a reservation infotexts by reservation id. Archived resources will also be returned in the response.

GET /maxxton/v1/reservations/{reservationId}/infotexts
Description

Get a reservation infotexts by reservation id

Parameters
Type Name Description Schema

Path

reservationId
required

The identifier of the reservation.

integer (int64)

Header

locale
optional

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.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors.

< InfotextResponse
> array

404

No reservation found for given reservation id.

No Content

500

Error occurred while fetching this reservation.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/infotexts
Example HTTP response
Response 200
[ {
  "description" : "string",
  "display" : true,
  "name" : "string"
} ]

5.39.16. Get a reservation journal by reservation id.

GET /maxxton/v1/reservations/{reservationId}/journals
Description

Get a reservation Journal by reservation id

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which journal is to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors.

< JournalResponse
> array

404

No reservation found for given reservation id.

No Content

500

Error occurred while fetching this reservation.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/journals
Example HTTP response
Response 200
[ {
  "accountName" : "string",
  "comments" : "string",
  "contractType" : "string",
  "costCenter" : "string",
  "creditVatExcluded" : 1,
  "creditVatIncluded" : 1,
  "customerId" : 1,
  "debitVatExcluded" : 1,
  "debitVatIncluded" : 1,
  "distributionChannelCountryCode" : "string",
  "distributionChannelId" : 1,
  "ledgerNumber" : "string",
  "mutationDate" : "01-01-2023T11:23:45Z",
  "ownerName" : "string",
  "referenceNumber" : 1,
  "reportId" : 1,
  "reportNumber" : 1,
  "reservationId" : 1,
  "reservationNumber" : "string",
  "reservedResourceId" : 1,
  "resortId" : 1,
  "resourceCode" : "string",
  "secondLedgerNumber" : "string",
  "settlementNumber" : 1,
  "statementDate" : "01-01-2023",
  "statementNumber" : "string",
  "type" : "string",
  "workOrderId" : 1
} ]

5.39.17. Get a single Reservation by reservation id

GET /maxxton/v1/reservations/{reservationId}
Description

Get a single Reservation by reservation id. You can use other calls, like /content or /customers to gather more detailed information.

Parameters
Type Name Description Schema

Path

reservationId
required

The identifier of the reservation.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Reservation

404

No reservation found for given reservation id.

No Content

500

Error occurred while fetching this reservation

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}
Example HTTP response
Response 200
{
  "arrivalDate" : "01-01-2023",
  "cancelDate" : "01-01-2023",
  "categoryCode" : "string",
  "categoryName" : "string",
  "customerId" : 1,
  "departureDate" : "01-01-2023",
  "distributionChannelId" : 1,
  "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
  "expectedArrivalTime" : "01-01-2023T11:23:45Z",
  "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
  "expectedDepartureTime" : "01-01-2023T11:23:45Z",
  "expireDate" : "01-01-2023T11:23:45Z",
  "externalBookingReference" : "string",
  "memoManagerId" : 1,
  "modifiedDate" : "01-01-2023T11:23:45Z",
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "payingCustomerId" : 1,
  "paymentTermSetId" : 1,
  "printedDate" : "01-01-2023",
  "resellerId" : 1,
  "reservationCategoryId" : 1,
  "reservationDate" : "01-01-2023T11:23:45Z",
  "reservationId" : 1,
  "reservationKind" : "string",
  "reservationNumber" : "string",
  "resortId" : 1,
  "sendMethodId" : 1,
  "status" : 1,
  "statusValue" : "string",
  "supplierVoucher" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "01-01-2023",
  "tncSigneeCustomerName" : "string",
  "type" : "string",
  "validationStatus" : 1,
  "voucher" : "string"
}

5.39.18. Get additions

GET /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Description

Get additions for given reservedResourceId and reservationId

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which application resource additions to be fetch

integer (int64)

Path

reservedResourceId
required

ReservedResource id for which application resource additions to be fetch

integer (int64)

Header

locale
optional

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.

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAddition

500

Error occurred while fetching additions

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Example HTTP response
Response 200
{
  "content" : [ {
    "addonType" : "string",
    "allowPriceOverride" : true,
    "code" : "string",
    "completed" : true,
    "description" : "string",
    "endDate" : "01-01-2023",
    "maxQuantity" : 1,
    "minQuantity" : 1,
    "name" : "string",
    "price" : 1,
    "resortArticle" : true,
    "resourceId" : 1,
    "shortDescription" : "string",
    "startDate" : "01-01-2023",
    "supplierId" : 1,
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.19. Get reservation details

GET /maxxton/v1/reservations/details
Description

Get reservation details.
Maximum page size for this endpoint is 10.

Parameters
Type Name Description Schema

Query

returnCustomerStatus
optional

The customer status will be returned when the value is set to true

boolean

Query

reservedResourceStatusIds
optional

Filter reservations based on reserved resource status ids

< integer > array

Header

locale
optional

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.

string

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are AGENTBILL, CUSTOMER, CUSTOMERBILL, CUSTOMERSTATUS, EMERGENCYCONTACTS, INFOTEXTS, INSTALMENTS, RESERVEDRESOURCES. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

accommodationKindIds
optional

Filter response based on accommodation kind ids. Its mandatory to pass either reservationIds or customerIds in request with accommodationKindIds.

< integer > array

Query

reservedResourceType
optional

Filter reservations based on reserved resource type

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
validationStatus:0,
status:0,
resortId:0,
reservationNumber:String,
reservationDate:String(date),
reservationCategoryId:0,
reservationId:0,
arrivalDate:String(date),
cancelDate:String(date),
departureDate:String(date),
distributionChannelId:0,
modifiedDate:String(date),
cancellationPremium:true,
parentId:0,
sendMethodId:0,
tncSignedDate:String(date),
tncSigneeCustomerName:String,
employeeId:0,
previousPmsId:0,
reservationKind:String)

Query

reservationIds
optional

Filter reservations based on reservation ids

< integer > array

Query

returnReservedResources
optional

The reserved resources will be returned when the value is set to true

boolean

Query

reservationNumber
optional

The identifier of the reservation

string

Query

returnFreeFields
optional

The free fields will be returned when the value is set to true

boolean

Query

customerIds
optional

Filter reservations based on customer ids

< integer > array

Query

distributionChannelId
optional

Filter reservations based on distribution channel id

integer (int64)

Query

reservationCategoryIds
optional

Filter reservations based on reservation category ids

< integer > array

Query

returnBill
optional

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

boolean

Query

statusIds
optional

Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41)

< integer > array

Query

returnCustomer
optional

The customer information will be returned when the value is set to true

boolean

Query

returnInstalments
optional

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

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationDetailResponse

500

Error occurred while fetching this reservation

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/details
Example HTTP response
Response 200
{
  "content" : [ {
    "agentBill" : [ {
      "billLineType" : 1,
      "endDate" : "01-01-2023",
      "multiplier" : 1,
      "name" : "string",
      "overrideValue" : 1,
      "quantity" : 1,
      "reservationBillId" : 1,
      "reservationBillLineId" : 1,
      "reservedResourceId" : 1,
      "resourceId" : 1,
      "startDate" : "01-01-2023",
      "total" : 1,
      "value" : 1,
      "vatRate" : 1,
      "virtualOverrideValue" : 1
    } ],
    "arrivalDate" : "01-01-2023",
    "cancelDate" : "01-01-2023",
    "categoryCode" : "string",
    "currencyCode" : "string",
    "currencyId" : 1,
    "customer" : {
      "alternateName" : "string",
      "bicSwift" : "string",
      "birthDate" : "01-01-2023",
      "companyName" : "string",
      "creationDate" : "01-01-2023T11:23:45Z",
      "customerId" : 1,
      "emailAllowed" : true,
      "firstName" : "string",
      "ibanNumber" : "string",
      "language" : "string",
      "lastName" : "string",
      "mailAddress" : {
        "address1" : "string",
        "address2" : "string",
        "address3" : "string",
        "alternateContactPerson" : "string",
        "boxNumber" : "string",
        "city" : "string",
        "country" : {
          "code" : "string",
          "countryId" : 1,
          "default" : true,
          "translations" : [ { } ]
        },
        "countryId" : 1,
        "district" : "string",
        "email" : "string",
        "exposeLocation" : true,
        "fax" : "string",
        "houseNumber" : "string",
        "houseNumberSuffix" : "string",
        "latitude" : 1,
        "longitude" : 1,
        "mobilePhone" : "string",
        "mobilePhone2" : "string",
        "municipality" : "string",
        "poBox" : "string",
        "poBoxCity" : "string",
        "poBoxZipcode" : "string",
        "privatePhone" : "string",
        "workPhone" : "string",
        "zipCode" : "string"
      },
      "mailAllowed" : true,
      "middle" : "string",
      "owner" : true,
      "questionnaireUnsubscribed" : true,
      "sex" : "string",
      "socialSecurityNumber" : "string",
      "title" : {
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "title" : "string"
        } ]
      }
    },
    "customerBill" : [ {
      "billLineType" : 1,
      "endDate" : "01-01-2023",
      "multiplier" : 1,
      "name" : "string",
      "overrideValue" : 1,
      "quantity" : 1,
      "reservationBillId" : 1,
      "reservationBillLineId" : 1,
      "reservedResourceId" : 1,
      "resourceId" : 1,
      "startDate" : "01-01-2023",
      "total" : 1,
      "value" : 1,
      "vatRate" : 1,
      "virtualOverrideValue" : 1
    } ],
    "customerId" : 1,
    "customerStatus" : {
      "customerCluseters" : [ {
        "categoryId" : 1,
        "clusterId" : 1,
        "code" : "string",
        "description" : "string",
        "name" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      } ],
      "customerClusters" : [ {
        "categoryId" : 1,
        "clusterId" : 1,
        "code" : "string",
        "description" : "string",
        "name" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      } ]
    },
    "departureDate" : "01-01-2023",
    "distributionChannelCode" : "string",
    "distributionChannelId" : 1,
    "emergencyContacts" : [ {
      "emergencyContactId" : 1,
      "firstName" : "string",
      "lastName" : "string",
      "middleName" : "string",
      "phone" : "string",
      "relationship" : "string",
      "reservationId" : 1
    } ],
    "employeeId" : 1,
    "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
    "expectedArrivalTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
    "expectedDepartureTime" : "01-01-2023T11:23:45Z",
    "externalBookingReference" : "string",
    "infotexts" : [ {
      "description" : "string"
    } ],
    "instalments" : [ {
      "dueAmount" : 1,
      "dueDate" : "01-01-2023",
      "name" : "string",
      "priority" : 1
    } ],
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "parentId" : 1,
    "payingCustomer" : {
      "alternateName" : "string",
      "bicSwift" : "string",
      "birthDate" : "01-01-2023",
      "companyName" : "string",
      "creationDate" : "01-01-2023T11:23:45Z",
      "customerId" : 1,
      "emailAllowed" : true,
      "firstName" : "string",
      "ibanNumber" : "string",
      "language" : "string",
      "lastName" : "string",
      "mailAddress" : {
        "address1" : "string",
        "address2" : "string",
        "address3" : "string",
        "alternateContactPerson" : "string",
        "boxNumber" : "string",
        "city" : "string",
        "country" : {
          "code" : "string",
          "countryId" : 1,
          "default" : true,
          "translations" : [ { } ]
        },
        "countryId" : 1,
        "district" : "string",
        "email" : "string",
        "exposeLocation" : true,
        "fax" : "string",
        "houseNumber" : "string",
        "houseNumberSuffix" : "string",
        "latitude" : 1,
        "longitude" : 1,
        "mobilePhone" : "string",
        "mobilePhone2" : "string",
        "municipality" : "string",
        "poBox" : "string",
        "poBoxCity" : "string",
        "poBoxZipcode" : "string",
        "privatePhone" : "string",
        "workPhone" : "string",
        "zipCode" : "string"
      },
      "mailAllowed" : true,
      "middle" : "string",
      "owner" : true,
      "questionnaireUnsubscribed" : true,
      "sex" : "string",
      "socialSecurityNumber" : "string",
      "title" : {
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "title" : "string"
        } ]
      }
    },
    "payingCustomerId" : 1,
    "paymentTermSetId" : 1,
    "previousPmsId" : 1,
    "reservationCategoryId" : 1,
    "reservationDate" : "01-01-2023T11:23:45Z",
    "reservationId" : 1,
    "reservationInfoTexts" : [ {
      "code" : "string",
      "description" : "string",
      "display" : true,
      "infoTextId" : 1,
      "name" : "string",
      "reservations" : [ {
        "display" : true,
        "infoTextId" : 1,
        "infoTextReservationId" : 1,
        "reservedResourceId" : 1
      } ],
      "reservedResourceId" : 1
    } ],
    "reservationKind" : "string",
    "reservationNumber" : "string",
    "reservedResources" : [ {
      "actualCheckinTime" : "01-01-2023T11:23:45Z",
      "actualCheckoutTime" : "01-01-2023T11:23:45Z",
      "actualEndDate" : "01-01-2023",
      "actualStartDate" : "01-01-2023",
      "amenities" : [ {
        "amenityId" : 1,
        "categories" : [ {
          "amenityCategoryId" : 1,
          "code" : "string",
          "i18n" : [ { } ],
          "isInternalUse" : true,
          "translations" : [ { } ]
        } ],
        "endDate" : "01-01-2023",
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "parentAmenityId" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string"
      } ],
      "cancellationPremium" : true,
      "code" : "string",
      "description" : "string",
      "endDate" : "01-01-2023",
      "freeFields" : [ {
        "dataTypeName" : "string",
        "fieldId" : 1,
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "value" : "string"
      } ],
      "impliesId" : 1,
      "imply" : true,
      "included" : true,
      "infotexts" : [ {
        "description" : "string"
      } ],
      "modifiedDate" : "01-01-2023T11:23:45Z",
      "name" : "string",
      "nightsRedeemed" : 1,
      "offerType" : "string",
      "parentId" : 1,
      "pointsRedeemed" : 1,
      "preferences" : [ {
        "id" : 1,
        "type" : "string"
      } ],
      "price" : 1,
      "quantity" : 1,
      "rateType" : {
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      },
      "rateTypeId" : 1,
      "removable" : true,
      "reservationDate" : "01-01-2023T11:23:45Z",
      "reservedResourceId" : 1,
      "resortArticle" : true,
      "resourceCode" : "string",
      "resourceId" : 1,
      "shortDescription" : "string",
      "startDate" : "01-01-2023",
      "status" : 1,
      "subjects" : [ {
        "includeInTotal" : true,
        "maxAge" : 1,
        "quantity" : 1,
        "subjectId" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "type" : "string"
      } ],
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "resourceId" : 1,
        "shortDescription" : "string"
      } ],
      "turnOverValue" : 1,
      "type" : "string",
      "unit" : {
        "code" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string"
        } ],
        "unitId" : 1
      },
      "unitId" : 1,
      "vatRate" : 1
    } ],
    "resortId" : 1,
    "sendMethodId" : 1,
    "status" : 1,
    "statusValue" : "string",
    "supplierBookingReference" : "string",
    "tncSigned" : true,
    "tncSignedDate" : "01-01-2023",
    "tncSigneeCustomerName" : "string",
    "validationStatusId" : 1,
    "voucher" : "string",
    "vouchers" : [ {
      "amount" : 1,
      "blockReason" : "string",
      "reservationId" : 1,
      "status" : "string",
      "voucher" : {
        "blockReason" : "string",
        "code" : "string",
        "employeeId" : 1,
        "employeeName" : "string",
        "generationDate" : "01-01-2023",
        "numberOfVouchers" : 1,
        "originalReservationId" : 1,
        "printCount" : 1,
        "resourceCode" : "string",
        "status" : "string",
        "type" : "string",
        "validFrom" : "01-01-2023",
        "validTo" : "01-01-2023",
        "voucherCriteriaId" : 1,
        "voucherId" : 1,
        "voucherOriginalValue" : 1,
        "voucherSetCashResourceId" : 1,
        "voucherSetId" : 1,
        "voucherSetName" : "string",
        "voucherSetResourceCode" : "string",
        "voucherTypeName" : "string",
        "voucherValue" : 1
      },
      "voucherId" : 1,
      "voucherRedemptionId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.20. Get reservation doorlock

GET /maxxton/v1/reservations/{reservationId}/doorlocks
Description

Gets a reservation doorlocks.

Parameters
Type Name Description Schema

Path

reservationId
required

Filter data for specific reservationId.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservationDoorlock

500

Error occurred while fetching reservation door locks.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/doorlocks
Example HTTP response
Response 200
{
  "arrivalDate" : "01-01-2023",
  "departureDate" : "01-01-2023",
  "doorLockCodes" : [ {
    "code1" : "string",
    "code1Active" : "string",
    "code2" : "string",
    "code2Active" : "string",
    "earlyCheckInCode1" : "string",
    "earlyCheckInCode2" : "string",
    "reservedResourceId" : 1,
    "unitId" : 1,
    "validDateFrom" : "01-01-2023",
    "validDateTo" : "01-01-2023"
  } ],
  "reservationId" : 1
}

5.39.21. Get reservation doorlocks

GET /maxxton/v1/reservations/doorlocks
Description

Gets a page of reservation doorlocks.
Maximum page size for this endpoint is 100

Parameters
Type Name Description Schema

Query

reservationId
optional

Filter data for specific reservationId.

integer (int64)

Query

reservedResourceId
optional

Filter data for specific reservedResourceId.

integer (int64)

Query

arrivalDateFrom
optional

arrival date range, from which the data will be fetched till arrivalDateTo. if only arrivalDateFrom is provided then data for only that day will be returned.

string (date)

Query

unitId
optional

Filter the response for specific unitId.

integer (int64)

Query

arrivalDateTo
optional

arrival date range, from which the data will be fetched till arrivalDateTo. if only arrivalDateFrom is provided then data for only that day will be returned.

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationDoorlock

500

Error occurred while fetching reservation door locks.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/doorlocks
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDate" : "01-01-2023",
    "departureDate" : "01-01-2023",
    "doorLockCodes" : [ {
      "code1" : "string",
      "code1Active" : "string",
      "code2" : "string",
      "code2Active" : "string",
      "earlyCheckInCode1" : "string",
      "earlyCheckInCode2" : "string",
      "reservedResourceId" : 1,
      "unitId" : 1,
      "validDateFrom" : "01-01-2023",
      "validDateTo" : "01-01-2023"
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.22. Get reservation payment term sets

GET /maxxton/v1/reservations/{reservationId}/paymenttermsets
Description

Gets a page of reservation payment term sets.

Parameters
Type Name Description Schema

Path

reservationId
required

Filter data for specific reservationId.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePaymentTermSet

500

Error occurred while fetching payment term sets.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/paymenttermsets
Example HTTP response
Response 200
{
  "content" : [ {
    "arrivalDateFrom" : "01-01-2023",
    "arrivalDateTo" : "01-01-2023",
    "maxArrivalDeviation" : 1,
    "maxStayLength" : 1,
    "minArrivalDeviation" : 1,
    "minStayLength" : 1,
    "nonRefundable" : true,
    "paymentTermSetId" : 1,
    "paymentTermSetType" : "string",
    "preBooking" : true,
    "priority" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.23. Get the amenities by reservation id

GET /maxxton/v1/reservations/{reservationId}/amenities
Description

Amenities of a reservation are the amenities that this customer has booked with preference and are guaranteed. For example 'non smoking' will mean that the unit in this booking will be a non smoking accommodation.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which amenities are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< ReservedResourceAmenity
> array

404

No reservation or amenities found for given reservation id.

No Content

500

Error occurred while fetching amenities

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/amenities
Example HTTP response
Response 200
[ {
  "amenityId" : 1,
  "extraId" : 1,
  "reservedResourceId" : 1,
  "type" : "string"
} ]

5.39.24. Get the page of reservation costs by reservation ids.

GET /maxxton/v1/reservations/bills/costs
Description

Get the page of reservation costs by reservation ids.

Parameters
Type Name Description Schema

Query

reservationIds
required

Reservation ids for which costs is to be fetched

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationCostPrice

500

Error occurred while fetching reservation costs

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/bills/costs
Example HTTP response
Response 200
{
  "content" : [ {
    "costs" : [ {
      "costPrice" : {
        "bookDateFrom" : "01-01-2023T11:23:45Z",
        "bookDateTo" : "01-01-2023T11:23:45Z",
        "costPriceId" : 1,
        "costPriceSpecials" : [ {
          "endDate" : "01-01-2023",
          "resourceId" : 1,
          "startDate" : "01-01-2023"
        } ],
        "currency" : {
          "code" : "string",
          "currencyCountry" : "string",
          "currencyId" : 1,
          "currencyLanguage" : "string",
          "name" : "string",
          "symbol" : "string"
        },
        "remark" : "string",
        "resourceId" : 1,
        "stayDateFrom" : "01-01-2023",
        "stayDateTo" : "01-01-2023",
        "usageUnit" : 1,
        "usageUnitFrom" : 1,
        "usageUnitTo" : 1,
        "value" : 1
      },
      "costPriceType" : "string",
      "endDate" : "01-01-2023",
      "quantity" : 1,
      "startDate" : "01-01-2023",
      "subjectId" : 1
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.25. Get the page of reservation reminders.

GET /maxxton/v1/reservations/reminders
Description

Get the page of reservation reminders.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
dueAmount:0.0,
status:String,
sendDate:String(date),
paymentDate:String(date),
printDate:String(date),
reservationId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationReminder

500

Error occurred while fetching reservation reminders

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/reminders
Example HTTP response
Response 200
{
  "content" : [ {
    "dueAmount" : 1,
    "paymentDate" : "01-01-2023T11:23:45Z",
    "paymentTermSetId" : 1,
    "printDate" : "01-01-2023T11:23:45Z",
    "reservationId" : 1,
    "sendDate" : "01-01-2023T11:23:45Z",
    "status" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.26. Get the page of reservation snapshots by reservation id

GET /maxxton/v1/reservations/{reservationId}/bills/snapshots
Description

Get the page of reservation snapshots by reservation id.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which snapshots is to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationSnapshot

404

No reservation or reservation snapshots found for given reservation id.

No Content

500

Error occurred while fetching reservation snapshots

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/bills/snapshots
Example HTTP response
Response 200
{
  "content" : [ {
    "businessSnapshotId" : 1,
    "businessSnapshotNumber" : "string",
    "creationDate" : "01-01-2023",
    "dueDate" : "01-01-2023",
    "endDate" : "01-01-2023",
    "issueDate" : "01-01-2023",
    "open" : 1,
    "paid" : 1,
    "payerType" : "string",
    "startDate" : "01-01-2023",
    "validationStatus" : "string",
    "value" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.27. Get the reservation bill by reservation id

GET /maxxton/v1/reservations/bills
Description

Get the page of reservation bill by reservation ids, this will give you a range of bill lines which build up the total bill. Each reservation can have three bills, for the customer, paying customer and the agent. The distinction can be made by filtering on the payertype.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationBillId:0,
reservationId:0,
cashflowRuleName:String,
resourceName:String,
description:String,
quantity:0,
multiplier:0,
value:0.0,
total:0.0,
billLineType:0,
totalBottomSequenceNr:0,
reservedResourceId:0,
startDate:String(date),
endDate:String(date),
payerType:String,
virtualOverrideValue:0.0,
resourceId:0,
reservationBillLineId:0,
resourceType:String,
resourceDescription:String,
type:String,
vatRate:0.0,
redeemedLoyaltyPoints:0,
redeemedLoyaltyNights:0,
resourceTypeSequenceNr:0,
overrideValue:0.0,
replacesParentResource:true)

Query

reservationIds
required

Reservation ids for which bill is to be fetched

< integer > array

Query

payerType
required

payerType of the bill. Possible values: CUSTOMER or PAYING_CUSTOMER or AGENT

string

Query

doFetchInternalBill
optional

true then fetch internal bill lines else don’t default value false

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationBill

500

Error occurred while fetching reservation bill

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/bills
Example HTTP response
Response 200
{
  "content" : [ {
    "reservationBillLines" : [ {
      "billLineType" : 1,
      "cashflowRuleName" : "string",
      "description" : "string",
      "endDate" : "01-01-2023",
      "multiplier" : 1,
      "overrideValue" : 1,
      "payerType" : "string",
      "quantity" : 1,
      "redeemedLoyaltyNights" : 1,
      "redeemedLoyaltyPoints" : 1,
      "replacesParentResource" : true,
      "reservationBillId" : 1,
      "reservationBillLineId" : 1,
      "reservationId" : 1,
      "reservedResourceId" : 1,
      "resourceDescription" : "string",
      "resourceId" : 1,
      "resourceName" : "string",
      "resourceType" : "string",
      "resourceTypeSequenceNr" : 1,
      "startDate" : "01-01-2023",
      "total" : 1,
      "totalBottomSequenceNr" : 1,
      "type" : "string",
      "value" : 1,
      "vatRate" : 1,
      "virtualOverrideValue" : 1
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.28. Get the reservation bill by reservation id

GET /maxxton/v1/reservations/{reservationId}/bills
Description

Get the reservation bill by reservation id, this will give you a range of bill lines which build up the total bill. Each reservation can have three bills, for the customer, paying customer and the agent. The distinction can be made by filtering on the payertype.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationBillId:0,
reservationId:0,
cashflowRuleName:String,
resourceName:String,
description:String,
quantity:0,
multiplier:0,
value:0.0,
total:0.0,
billLineType:0,
totalBottomSequenceNr:0,
reservedResourceId:0,
startDate:String(date),
endDate:String(date),
payerType:String,
virtualOverrideValue:0.0,
resourceId:0,
reservationBillLineId:0,
resourceType:String,
resourceDescription:String,
type:String,
vatRate:0.0,
redeemedLoyaltyPoints:0,
redeemedLoyaltyNights:0,
resourceTypeSequenceNr:0,
overrideValue:0.0,
replacesParentResource:true)

Query

payerType
required

payerType of the bill. Possible values: CUSTOMER or PAYING_CUSTOMER or AGENT

string

Path

reservationId
required

Reservation id for which bill is to be fetched

integer (int64)

Query

doFetchInternalBill
optional

true then fetch internal bill lines else don’t default value false

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

< ReservationBillLine
> array

404

No reservation or reservation bill found for given reservation id.

No Content

500

Error occurred while fetching reservation bill

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/bills
Example HTTP response
Response 200
[ {
  "billLineType" : 1,
  "cashflowRuleName" : "string",
  "description" : "string",
  "endDate" : "01-01-2023",
  "multiplier" : 1,
  "overrideValue" : 1,
  "payerType" : "string",
  "quantity" : 1,
  "redeemedLoyaltyNights" : 1,
  "redeemedLoyaltyPoints" : 1,
  "replacesParentResource" : true,
  "reservationBillId" : 1,
  "reservationBillLineId" : 1,
  "reservationId" : 1,
  "reservedResourceId" : 1,
  "resourceDescription" : "string",
  "resourceId" : 1,
  "resourceName" : "string",
  "resourceType" : "string",
  "resourceTypeSequenceNr" : 1,
  "startDate" : "01-01-2023",
  "total" : 1,
  "totalBottomSequenceNr" : 1,
  "type" : "string",
  "value" : 1,
  "vatRate" : 1,
  "virtualOverrideValue" : 1
} ]

5.39.29. Gets a page of custom fields

GET /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Description
Custom fields are part of the reservation that can be updated for a particular reservation. This endpoint can be used to fetch a page of custom field of reservation .
Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id of the reservation

integer (int64)

Path

reservedResourceId
required

ReservedResource id of the reservation

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationCustomField

500

Error occurred while fetching custom fields

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Example HTTP response
Response 200
{
  "content" : [ {
    "allowedValues" : [ "string" ],
    "booleanValue" : true,
    "dataType" : "string",
    "dateValue" : "01-01-2023",
    "fieldId" : 1,
    "numericValue" : 1,
    "selectValues" : [ "string" ],
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.30. Gets a page with credit card authorisations for a reservation.

GET /maxxton/v1/reservations/{reservationId}/creditcardauthorisations
Description

Gets a page with credit card authorisations for a reservation. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
creditCardAuthorisationId:0,
status:String,
type:String,
authorisedAmount:0.0,
availableAmount:0.0,
creationDate:String(date),
capturedAmount:0.0,
payerType:String)

Path

reservationId
required

Reservation id for which credit card authorisations will be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageCreditCardAuthorisation

404

When reservationId path parameter value is invalid/does not exist.

No Content

500

Error occurred while fetching reservation credit card authorisations

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/creditcardauthorisations
Example HTTP response
Response 200
{
  "content" : [ {
    "authorisationStatus" : "string",
    "authorisedAmount" : 1,
    "availableAmount" : 1,
    "bankAccount" : {
      "bankAccountName" : "string",
      "code" : "string",
      "currencyCode" : "string",
      "name" : "string",
      "paymentMethodDefinition" : {
        "brandName" : "string",
        "code" : "string",
        "name" : "string"
      }
    },
    "capturedAmount" : 1,
    "creationDate" : "01-01-2023",
    "creditCardAuthorisationId" : 1,
    "payerType" : "string",
    "paymentMethod" : {
      "brandName" : "string",
      "code" : "string",
      "name" : "string"
    },
    "status" : "string",
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.31. Gets all source categories.

GET /maxxton/v1/reservations/sources/categories
Description

Gets a page of all source categories, records can be filtered based on fields on source object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
categoryId:0,
parentId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors.

PageSourceCategory

500

Error occurred while fetching category.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/sources/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "categoryId" : 1,
    "parentId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.32. Gets all sources.

GET /maxxton/v1/reservations/sources
Description

Gets a page of all sources, records can be filtered based on fields on source object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
sourceId:0,
startDate:String(date),
endDate:String(date),
code:String,
showOnInternet:true,
sourceCategoryId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors.

PageSource

500

Error occurred while fetching source.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/sources
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "endDate" : "01-01-2023T11:23:45Z",
    "showOnInternet" : true,
    "sourceCategoryId" : 1,
    "sourceId" : 1,
    "startDate" : "01-01-2023T11:23:45Z",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.33. Gets page of reservation categories

GET /maxxton/v1/reservations/categories
Description

Get reservation categories.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationCategoryId:0,
name:String,
code:String,
endDate:String,
markForOwnUse:true)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationCategory

500

Error occurred while fetching reservation categories

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "endDate" : "string",
    "markForOwnUse" : true,
    "name" : "string",
    "reservationCategory" : {
      "code" : "string",
      "endDate" : "string",
      "markForOwnUse" : true,
      "name" : "string",
      "reservationCategory" : {
        "code" : "string",
        "endDate" : "string",
        "markForOwnUse" : true,
        "name" : "string",
        "reservationCategory" : {
          "code" : "string",
          "endDate" : "string",
          "markForOwnUse" : true,
          "name" : "string",
          "reservationCategory" : { },
          "reservationCategoryId" : 1,
          "translations" : [ { } ]
        },
        "reservationCategoryId" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      },
      "reservationCategoryId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "reservationCategoryId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.34. Gets page of reservation terms and conditions

GET /maxxton/v1/reservations/{reservationId}/termsandconditions
Description

Get reservation terms and conditions. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
termAndConditionId:0,
validFrom:String(date),
validTo:String(date),
templateId:0)

Path

reservationId
required

Reservation id for which term and conditions are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationTermAndCondition

500

Error occurred while fetching reservation terms and conditions

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/termsandconditions
Example HTTP response
Response 200
{
  "content" : [ {
    "contents" : "string",
    "isDefault" : true,
    "templateId" : 1,
    "termAndConditionId" : 1,
    "type" : "string",
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.35. Gets page of reservation’s payent methods

GET /maxxton/v1/reservations/{reservationId}/paymentmethods
Description

Get payment methods for reservation based on reservationId.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
paymentMethod:String,
code:String,
paymentType:String,
paymentProvider:String,
minDaysBeforeArrival:0,
maxDaysBetweenBookAndArrivalDate:0,
translations:String)

Path

reservationId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PagePaymentMethod

500

Error occurred while fetching payment methods for the given reservation

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/paymentmethods
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "maxDaysBetweenBookAndArrivalDate" : 1,
    "minDaysBeforeArrival" : 1,
    "paymentMethod" : "string",
    "paymentProvider" : "string",
    "paymentType" : "string",
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.36. Gets page with memos

GET /maxxton/v1/reservations/memos
Description

Get memos for reservation ids specified by a list of reservationIds.The records can be filtered based on memo object. In order to filter creationDate the format of date passed should be: YYYY-MM-DDThh:mm:ss. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoId:0,
employeeId:0,
content:String,
creationDate:String(date),
predefinedMemoId:0)

Query

reservationIds
required

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageMemoResponse

500

Error occurred while fetching memos for the given reservation

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/memos
Example HTTP response
Response 200
{
  "content" : [ {
    "memo" : [ {
      "content" : "string",
      "creationDate" : "01-01-2023T11:23:45Z",
      "employeeId" : 1,
      "memoCategoryId" : 1,
      "memoId" : 1,
      "predefinedMemoId" : 1
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.37. Gets page with memos

GET /maxxton/v1/reservations/{reservationId}/memos
Description

Get memos for a reservation specified by reservationId.The records can be filtered based on memo object. In order to filter creationDate the format of date passed should be: YYYY-MM-DDThh:mm:ss. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoId:0,
employeeId:0,
content:String,
creationDate:String(date),
predefinedMemoId:0)

Path

reservationId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageMemo

500

Error occurred while fetching memos for the given reservation

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/memos
Example HTTP response
Response 200
{
  "content" : [ {
    "content" : "string",
    "creationDate" : "01-01-2023T11:23:45Z",
    "employeeId" : 1,
    "memoCategoryId" : 1,
    "memoId" : 1,
    "predefinedMemoId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.38. Gets the page of amenities by reservation ids

GET /maxxton/v1/reservations/amenities
Description

Amenities of a reservations are the amenities that the customer has booked with preference and are guaranteed. For example 'non smoking' will mean that the unit in this booking will be a non smoking accommodation.

Parameters
Type Name Description Schema

Query

reservationIds
required

Reservation ids for which amenities are to be fetched

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationAmenity

500

Error occurred while fetching amenities

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/amenities
Example HTTP response
Response 200
{
  "content" : [ {
    "amenities" : [ {
      "amenityId" : 1,
      "extraId" : 1,
      "reservedResourceId" : 1,
      "type" : "string"
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.39. Gets the page of instalments by reservation ids

GET /maxxton/v1/reservations/instalments
Parameters
Type Name Description Schema

Query

reservationIds
required

Reservation ids for which instalments are to be fetched. Maximum allowed reservationIds per call is 20

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationInstalmentResponse

500

Error occurred while fetching instalments

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/instalments
Example HTTP response
Response 200
{
  "content" : [ {
    "instalments" : [ {
      "dueAmount" : 1,
      "dueDate" : "01-01-2023",
      "name" : "string",
      "priority" : 1
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.40. Gets the page of payment details for the specific reservationIds.

GET /maxxton/v1/reservations/payments
Parameters
Type Name Description Schema

Query

reservationIds
required

Ids of the reservation for which payments has to be fethced.

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationPaymentContainer

500

Error occurred while fetching reservation payments.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/payments
Example HTTP response
Response 200
{
  "content" : [ {
    "payments" : [ {
      "amount" : 1,
      "currencyCode" : "string",
      "currencyId" : 1,
      "ledgerId" : 1,
      "payerType" : "string",
      "paymentAccount" : "string",
      "paymentDate" : "01-01-2023T11:23:45Z",
      "paymentId" : 1,
      "paymentMethod" : {
        "brandName" : "string",
        "code" : "string",
        "name" : "string"
      },
      "paymentNumber" : "string",
      "paymentType" : "string",
      "refunded" : true,
      "remark" : "string",
      "reservationId" : 1,
      "statementDate" : "01-01-2023"
    } ],
    "reservationId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.41. Gets the page of reservation addition groups

POST /maxxton/v1/reservations/proposals/additiongroups
Description

This endpoint provides you with a page of valid additions for your request criteria including marketing groups and all details of the addition. This endpoint only provides the additions which are in a marketing group. If not they will not be returned. In the case of a nested marketing group structure, all groups are returned separately, in case the whole tree is required this can be created using the parentId.

Parameters
Type Name Description Schema

Body

requestBody
required

ReservationAdditionCriteria
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationAdditionResponse

500

Error occurred while fetching addition groups.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/proposals/additiongroups
Request body
{
  "accommodationTypes" : [ {
    "arrivalDate" : "01-01-2023",
    "duration" : 1,
    "rateTypeId" : 1,
    "resourceId" : 1,
    "subjects" : {
      "persons" : [ {
        "age" : 1,
        "quantity" : 1
      } ],
      "petsQuantity" : 1
    },
    "unitId" : 1
  } ],
  "categoryCode" : "string",
  "distributionChannelCode" : "string"
}
Example HTTP response
Response 200
{
  "content" : [ {
    "additions" : [ {
      "additionResourceId" : 1,
      "endDate" : "01-01-2023",
      "memo" : "string",
      "quantity" : 1,
      "startDate" : "01-01-2023"
    } ],
    "code" : "string",
    "groupId" : 1,
    "parentId" : 1,
    "priority" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.42. Gets the payment details for the specific reservationId.

GET /maxxton/v1/reservations/{reservationId}/payments
Parameters
Type Name Description Schema

Path

reservationId
required

Id of the reservation for which payments has to be fethced.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationPayment

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching reservation payments.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/payments
Example HTTP response
Response 200
{
  "content" : [ {
    "amount" : 1,
    "currencyCode" : "string",
    "currencyId" : 1,
    "ledgerId" : 1,
    "payerType" : "string",
    "paymentAccount" : "string",
    "paymentDate" : "01-01-2023T11:23:45Z",
    "paymentId" : 1,
    "paymentMethod" : {
      "brandName" : "string",
      "code" : "string",
      "name" : "string"
    },
    "paymentNumber" : "string",
    "paymentType" : "string",
    "refunded" : true,
    "remark" : "string",
    "reservationId" : 1,
    "statementDate" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.43. Reservation subjects by reservation id

GET /maxxton/v1/reservations/{reservationId}/subjects
Description

The endpoints returns the number of subjects added in reservation.
1. Get a page of reservation subjects per reserved resource.
2. The vehicle list in reservation will be added to the first accommodation type reserved resource in the response list.
3. The response is by default sorted on the reserved resource id in ascending order.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservedResourceId:0,
subjectId:0,
quantity:0)

Path

reservationId
required

Reservation id for which the subjects are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservedResourceSubjectQuantity

404

No reservation or reservation Subjects found for given reservation id.

No Content

500

Error occurred while fetching reservation subjects

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects
Example HTTP response
Response 200
{
  "content" : [ {
    "equipments" : [ {
      "remark" : "string",
      "reservationSubjectId" : 1,
      "reservedResourceId" : 1,
      "value" : "string"
    } ],
    "quantity" : 1,
    "reservedResourceId" : 1,
    "subject" : {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    },
    "subjectId" : 1,
    "travelParties" : [ {
      "arrivalDate" : "01-01-2023",
      "birthDate" : "01-01-2023",
      "city" : "string",
      "companion" : true,
      "countryId" : 1,
      "departureDate" : "01-01-2023",
      "email" : "string",
      "firstName" : "string",
      "gender" : "string",
      "guest" : true,
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "identityCardNumber" : "string",
      "identityCountryId" : 1,
      "identityDateIssued" : "01-01-2023",
      "identityNumber" : "string",
      "identityType" : "string",
      "lastName" : "string",
      "middleName" : "string",
      "personAlreadyLeft" : true,
      "reservationSubjectId" : 1,
      "sex" : "string",
      "street" : "string",
      "zipCode" : "string"
    } ],
    "vehicles" : [ {
      "registrationMark" : "string",
      "remark" : "string",
      "reservationSubjectId" : 1,
      "reservedResourceId" : 1,
      "subjectId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.44. Reservation subjects by reservation id

POST /maxxton/v1/reservations/{reservationId}/subjects
Description

Creates subjects for a reservation. You can add a list of either travel parties, vehicles, or equipments at a time using this endpoint.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which the subjects are to be fetched

integer (int64)

Body

requestBody
required

< ReservationSubjectRequest
> array
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

400

You can add a list of either travel parties, vehicles, or equipments at a time using this endpoint.

No Content

404

No reservation found for given reservation id.

No Content

500

Error occurred while creating reservation subject

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects
Request body
[ {
  "equipments" : [ {
    "remark" : "string",
    "reservedResourceId" : 1,
    "value" : "string"
  } ],
  "reservedResourceId" : 1,
  "subjectId" : 1,
  "travelParties" : [ {
    "arrivalDate" : "01-01-2023",
    "birthDate" : "01-01-2023",
    "city" : "string",
    "companion" : true,
    "countryId" : 1,
    "departureDate" : "01-01-2023",
    "email" : "string",
    "firstName" : "string",
    "gender" : "string",
    "guest" : true,
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "identityCardNumber" : "string",
    "identityCountryId" : 1,
    "identityDateIssued" : "01-01-2023",
    "identityNumber" : "string",
    "identityType" : "string",
    "lastName" : "string",
    "middleName" : "string",
    "personAlreadyLeft" : true,
    "sex" : "string",
    "street" : "string",
    "zipCode" : "string"
  } ],
  "vehicles" : [ {
    "registrationMark" : "string",
    "remark" : "string",
    "reservedResourceId" : 1,
    "subjectId" : 1
  } ]
} ]
Example HTTP response

5.39.45. Reservation subjects by reservation ids

GET /maxxton/v1/reservations/subjects
Description

The endpoints returns the page of subjects added in reservation.
1. Get a page of reservation subjects per reservationId.
2. The vehicle list in reservation will be added to the first accommodation type reserved resource in the response list.
3. The response is by default sorted on the reserved resource id in ascending order.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservedResourceId:0,
subjectId:0,
quantity:0)

Query

reservationIds
required

Reservation id for which the subjects are to be fetched

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservationReservedResourceSubject

500

Error occurred while fetching reservation subjects

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/subjects
Example HTTP response
Response 200
{
  "content" : [ {
    "reservationId" : 1,
    "reservedResourceSubjectQuantity" : [ {
      "equipments" : [ {
        "remark" : "string",
        "reservationSubjectId" : 1,
        "reservedResourceId" : 1,
        "value" : "string"
      } ],
      "quantity" : 1,
      "reservedResourceId" : 1,
      "subject" : {
        "controlAccess" : true,
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "includeInTotal" : true,
        "maxAge" : 1,
        "reportGroupSubjectId" : 1,
        "subjectCategoryId" : 1,
        "subjectId" : 1,
        "subjectOrder" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "type" : "string"
      },
      "subjectId" : 1,
      "travelParties" : [ {
        "arrivalDate" : "01-01-2023",
        "birthDate" : "01-01-2023",
        "city" : "string",
        "companion" : true,
        "countryId" : 1,
        "departureDate" : "01-01-2023",
        "email" : "string",
        "firstName" : "string",
        "gender" : "string",
        "guest" : true,
        "houseNumber" : "string",
        "houseNumberSuffix" : "string",
        "identityCardNumber" : "string",
        "identityCountryId" : 1,
        "identityDateIssued" : "01-01-2023",
        "identityNumber" : "string",
        "identityType" : "string",
        "lastName" : "string",
        "middleName" : "string",
        "personAlreadyLeft" : true,
        "reservationSubjectId" : 1,
        "sex" : "string",
        "street" : "string",
        "zipCode" : "string"
      } ],
      "vehicles" : [ {
        "registrationMark" : "string",
        "remark" : "string",
        "reservationSubjectId" : 1,
        "reservedResourceId" : 1,
        "subjectId" : 1
      } ]
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.46. Reserved resources by reservation id

GET /maxxton/v1/reservations/{reservationId}/content
Description

Get the reserved resources by reservation id. ReservedResources are the content of a booking, everything you add to your booking as a resource, is a reservedresource. For example your accommodation is a reservedresource but also the mandatory or additional products. Together they form a tree structure which we call the reservation content. Archived resources will also be returned in the response.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservedResourceId:0,
reservationId:0,
resourceId:0,
unitId:0,
rateTypeId:0,
overrideEmployeeId:0,
overrideValue:0.0,
quantity:0,
type:String,
offerType:String,
vatRate:0.0,
statusName:String,
name:String,
code:String,
shortDescription:String,
description:String,
startDate:String(date),
endDate:String(date),
cancellationPremium:true,
reservationDate:String(date),
onBill:true,
price:0.0,
hasPriceOverride:true,
totalInternalPrice:0.0,
employeeId:0,
removable:true,
modifiedDate:String(date),
implyOnce:true,
included:true,
turnOverValue:0.0,
representationId:0,
parentId:0,
impliesId:0,
resellerAddonCode:String,
actualStartDate:String(date),
actualEndDate:String(date))

Path

reservationId
required

Reservation id for which reserved resources should be fetched

integer (int64)

Query

fetchTurnover
optional

Parameter to identify if Turnover is to be fetched for each reserved resource. By default this is false.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservedResourceOfReservation

404

No reserved resources or reservation found for given reservation id.

No Content

500

Error occurred while fetching reserved resources

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/content
Example HTTP response
Response 200
{
  "content" : [ {
    "actualCheckinTime" : "01-01-2023T11:23:45Z",
    "actualCheckoutTime" : "01-01-2023T11:23:45Z",
    "actualEndDate" : "01-01-2023",
    "actualStartDate" : "01-01-2023",
    "cancellationPremium" : true,
    "code" : "string",
    "description" : "string",
    "employeeId" : 1,
    "endDate" : "01-01-2023",
    "hasPriceOverride" : true,
    "impliesId" : 1,
    "imply" : true,
    "implyOnce" : true,
    "included" : true,
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "name" : "string",
    "nightsRedeemed" : 1,
    "offerType" : "string",
    "onBill" : true,
    "overrideEmployeeId" : 1,
    "overrideValue" : 1,
    "parentId" : 1,
    "pointsRedeemed" : 1,
    "price" : 1,
    "quantity" : 1,
    "rateTypeId" : 1,
    "removable" : true,
    "representationId" : 1,
    "resellerAddonCode" : "string",
    "reservationDate" : "01-01-2023T11:23:45Z",
    "reservationId" : 1,
    "reservedResourceId" : 1,
    "resourceCode" : "string",
    "resourceId" : 1,
    "shortDescription" : "string",
    "startDate" : "01-01-2023",
    "statusName" : "string",
    "totalInternalPrice" : 1,
    "turnOverValue" : 1,
    "type" : "string",
    "unitId" : 1,
    "vatRate" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.47. Reserved resources by reservation ids

GET /maxxton/v1/reservations/content
Description

Get the page of reserved resources by reservation ids. ReservedResources are the content of a booking, everything you add to your booking as a resource, is a reservedresource. For example your accommodation is a reservedresource but also the mandatory or additional products. Together they form a tree structure which we call the reservation content. Archived resources will also be returned in the response.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservedResourceId:0,
reservationId:0,
resourceId:0,
unitId:0,
rateTypeId:0,
overrideEmployeeId:0,
overrideValue:0.0,
quantity:0,
type:String,
offerType:String,
vatRate:0.0,
statusName:String,
name:String,
code:String,
shortDescription:String,
description:String,
startDate:String(date),
endDate:String(date),
cancellationPremium:true,
reservationDate:String(date),
onBill:true,
price:0.0,
hasPriceOverride:true,
totalInternalPrice:0.0,
employeeId:0,
removable:true,
modifiedDate:String(date),
implyOnce:true,
included:true,
turnOverValue:0.0,
representationId:0,
parentId:0,
impliesId:0,
resellerAddonCode:String,
actualStartDate:String(date),
actualEndDate:String(date))

Query

reservationIds
required

Reservation ids for which reserved resources should be fetched

< integer > array

Query

fetchTurnover
optional

Parameter to identify if Turnover is to be fetched for each reserved resource. By default this is false.

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageReservedResourcePerReservation

500

Error occurred while fetching reserved resources

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/content
Example HTTP response
Response 200
{
  "content" : [ {
    "reservationId" : 1,
    "reservedResources" : [ {
      "actualCheckinTime" : "01-01-2023T11:23:45Z",
      "actualCheckoutTime" : "01-01-2023T11:23:45Z",
      "actualEndDate" : "01-01-2023",
      "actualStartDate" : "01-01-2023",
      "cancellationPremium" : true,
      "code" : "string",
      "description" : "string",
      "employeeId" : 1,
      "endDate" : "01-01-2023",
      "hasPriceOverride" : true,
      "impliesId" : 1,
      "imply" : true,
      "implyOnce" : true,
      "included" : true,
      "modifiedDate" : "01-01-2023T11:23:45Z",
      "name" : "string",
      "nightsRedeemed" : 1,
      "offerType" : "string",
      "onBill" : true,
      "overrideEmployeeId" : 1,
      "overrideValue" : 1,
      "parentId" : 1,
      "pointsRedeemed" : 1,
      "price" : 1,
      "quantity" : 1,
      "rateTypeId" : 1,
      "removable" : true,
      "representationId" : 1,
      "resellerAddonCode" : "string",
      "reservationDate" : "01-01-2023T11:23:45Z",
      "reservationId" : 1,
      "reservedResourceId" : 1,
      "resourceCode" : "string",
      "resourceId" : 1,
      "shortDescription" : "string",
      "startDate" : "01-01-2023",
      "statusName" : "string",
      "totalInternalPrice" : 1,
      "turnOverValue" : 1,
      "type" : "string",
      "unitId" : 1,
      "vatRate" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.39.48. Update reservation

PUT /maxxton/v1/reservations/{reservationId}
Description

Update an existing reservation based on given details.
The user can change the status of the reservation as per the below status flow specified:
QUOTATION(-5) → CONFIRM(10), DECLINE(-10)
OPTIONAL(11) → CONFIRM(10), DECLINE(-10)
REQUEST(10)→DECLINE(-10), CONFIRM(12)
PROVISIONAL(12) → CANCEL(-12), DECLINE(-10)
DEFINITIVE(21)→CANCEL(-12), CHECKED_IN(31)
CHECKED_IN(31)→CHECKED_OUT(41).
The expectedArrivalDateTime and expectedDepartureDateTime should be passed in the below format:
'YYYY-MM-DDThh:mm:ss'
The above fields are mainly used by the receptionist of the resort, by maintenance department and housekeeping.

Parameters
Type Name Description Schema

Path

reservationId
required

Id of the reservation which needs to be updated.

integer (int64)

Body

requestBody
required

ReservationUpdateRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservationUpdateResponse

500

Error occurred while updating reservation

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}
Request body
{
  "cancellationReason" : "string",
  "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
  "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
  "paymentTermSetId" : 1,
  "statusValue" : "string"
}
Example HTTP response
Response 200
{
  "expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
  "expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
  "infotexts" : [ {
    "description" : "string"
  } ],
  "paymentTermSetId" : 1,
  "reservationId" : 1,
  "status" : "string",
  "statusValue" : "string"
}

5.39.49. Update reservation subjects by reservation id

PUT /maxxton/v1/reservations/{reservationId}/subjects
Description

All the equipment, travelparties, and vehicles available in a reservation can be updated with this call.

Parameters
Type Name Description Schema

Path

reservationId
required

Reservation id for which the subjects are to be updated

integer (int64)

Body

requestBody
required

UpdateReservationSubjectRequest
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

404

No reservation found for given reservation id.

No Content

500

Error occurred while updating reservation subject

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects
Request body
{
  "equipments" : [ {
    "remark" : "string",
    "reservationSubjectId" : 1,
    "reservedResourceId" : 1,
    "value" : "string"
  } ],
  "travelParties" : [ {
    "arrivalDate" : "01-01-2023",
    "birthDate" : "01-01-2023",
    "city" : "string",
    "companion" : true,
    "countryId" : 1,
    "departureDate" : "01-01-2023",
    "email" : "string",
    "firstName" : "string",
    "gender" : "string",
    "guest" : true,
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "identityCardNumber" : "string",
    "identityCountryId" : 1,
    "identityDateIssued" : "01-01-2023",
    "identityNumber" : "string",
    "identityType" : "string",
    "lastName" : "string",
    "middleName" : "string",
    "personAlreadyLeft" : true,
    "reservationSubjectId" : 1,
    "sex" : "string",
    "street" : "string",
    "zipCode" : "string"
  } ],
  "vehicles" : [ {
    "registrationMark" : "string",
    "remark" : "string",
    "reservationSubjectId" : 1,
    "reservedResourceId" : 1,
    "subjectId" : 1
  } ]
}
Example HTTP response

5.39.50. Update reservedResource

PUT /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Description

Update exiting reservedResource for the given reservationId and reservedResourceId as per the given criteria
startDate/endDate and actualStartDate/actualEndDate date should be pass in following format : 'YYYY-MM-DD'. The start and end date depicts the dates of booking with financial implications and actualStartDate and actualEndDate shows when the availability and bookability of an accommodation. Please note that if a reservedResource of a reservation is an imply, then it cannot be updated.

Parameters
Type Name Description Schema

Path

reservationId
required

Id of the reservation which needs to be updated.

integer (int64)

Path

reservedResourceId
required

Id of the reservedresource which needs to be updated

integer (int64)

Body

requestBody
required

ReservedResourceUpdate
Responses
Code Description Schema

200

The request is completed successfully without any errors

ReservedResource

500

Error occurred while updating reservedResource

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Request body
{
  "actualEndDate" : "01-01-2023",
  "actualStartDate" : "01-01-2023",
  "endDate" : "01-01-2023",
  "price" : 1,
  "quantity" : 1,
  "startDate" : "01-01-2023",
  "unitId" : 1
}
Example HTTP response
Response 200
{
  "actualEndDate" : "01-01-2023",
  "actualStartDate" : "01-01-2023",
  "cancellationPremium" : true,
  "code" : "string",
  "description" : "string",
  "employeeId" : 1,
  "endDate" : "01-01-2023",
  "hasPriceOverride" : true,
  "impliesId" : 1,
  "imply" : true,
  "implyOnce" : true,
  "included" : true,
  "modifiedDate" : "01-01-2023T11:23:45Z",
  "name" : "string",
  "offerType" : "string",
  "onBill" : true,
  "overrideEmployeeId" : 1,
  "overrideValue" : 1,
  "parentId" : 1,
  "price" : 1,
  "quantity" : 1,
  "rateTypeId" : 1,
  "removable" : true,
  "representationId" : 1,
  "resellerAddonCode" : "string",
  "reservationDate" : "01-01-2023T11:23:45Z",
  "reservationId" : 1,
  "reservedResourceId" : 1,
  "resourceCode" : "string",
  "resourceId" : 1,
  "shortDescription" : "string",
  "startDate" : "01-01-2023",
  "statusName" : "string",
  "totalInternalPrice" : 1,
  "turnOverValue" : 1,
  "type" : "string",
  "unitId" : 1,
  "vatRate" : 1
}

5.40. Resorts

Group of accommodation types at the same location

5.40.1. Gets Resort Activities

GET /maxxton/v1/resorts/activities
Description

Gets a page with Resort Activities .It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resortActivityId:0,
code:String,
activityCategoryId:0,
priceAdult:String,
priceChild:String,
priceValuePoints:String,
priceType:String,
ticketingType:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResortActivity

500

Error occurred while fetching resorts Activities

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/activities
Example HTTP response
Response 200
{
  "content" : [ {
    "activityCategoryId" : 1,
    "code" : "string",
    "priceAdult" : "string",
    "priceChild" : "string",
    "priceType" : "string",
    "priceValuePoints" : "string",
    "resortActivityId" : 1,
    "ticketingType" : "string",
    "translations" : [ {
      "description" : "string",
      "headText" : "string",
      "languageId" : 1,
      "text" : "string",
      "title" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.2. Gets a List of Subjects associated with Resort

GET /maxxton/v1/resorts/{resortId}/subjects
Description

Provides the List of subjects for specific resort. The subjects correspond to the travelling party for ex. Adult, Youngster, Baby etc.

Parameters
Type Name Description Schema

Path

resortId
required

resortId to fetch subjects

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< Subject
> array

500

Error occurred while fetching Subjects for Resort.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/subjects
Example HTTP response
Response 200
[ {
  "controlAccess" : true,
  "endDate" : "01-01-2023",
  "i18n" : [ {
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "subjectId" : 1
  } ],
  "includeInTotal" : true,
  "maxAge" : 1,
  "reportGroupSubjectId" : 1,
  "subjectCategoryId" : 1,
  "subjectId" : 1,
  "subjectOrder" : 1,
  "translations" : [ {
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "subjectId" : 1
  } ],
  "type" : "string"
} ]

5.40.3. Gets a page holding resort objects

GET /maxxton/v1/resorts
Description

Gets a page holding resort objects.The records can be filtered based on resort object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resortPriority:0,
resortNumber:0,
internalResortNumber:String,
code:String,
resortId:0,
parentId:0,
archivedFrom:String(date),
supplierId:0,
adminOrganisationId:0,
origin:String,
originId:String,
bookableLocation:true,
previousPmsId:String)

Query

resortIds
optional

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResort

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching resorts.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : 1,
    "amenityManagerId" : 1,
    "archivedFrom" : "01-01-2023",
    "bookableLocation" : true,
    "code" : "string",
    "dynamicManagerId" : 1,
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "imageManagerId" : 1,
    "inheritTc" : true,
    "internalResortNumber" : "string",
    "mailAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAddressManagerId" : 1,
    "origin" : "string",
    "originId" : "string",
    "parentId" : 1,
    "previousPmsId" : "string",
    "resArrivalDateFrom" : "01-01-2023",
    "resortId" : 1,
    "resortNumber" : 1,
    "resortPriority" : 1,
    "supplierId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "visitAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "visitAddressManagerId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.4. Gets a page holding resort priorities objects

GET /maxxton/v1/resorts/priorities
Description

Gets a page holding resort priorities objects.The records can be filtered based on resort priorities object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resortId:0,
distributionChannelId:0,
startDate:String(date),
endDate:String(date),
priority:0,
segmentId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResortPriority

404

No resorts priorities found for given criteria.

No Content

500

Error occurred while fetching priorities.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/priorities
Example HTTP response
Response 200
{
  "content" : [ {
    "distributionChannelId" : 1,
    "endDate" : "01-01-2023",
    "priority" : 1,
    "resortId" : 1,
    "resortPriorityId" : 1,
    "segmentId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.5. Gets a page of resort amenity links

GET /maxxton/v1/resorts/amenitylinks
Description

Gets a page of all the amenity links, along with the applicable resortId. The records can be filtered based on resortamenity object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityLinkId:0,
type:String,
visible:true,
preferenceExtraId:0,
numberValue:0.0,
textValue:String,
startDate:String(date),
endDate:String(date),
amenityId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResortAmenityLink

404

No amenity links found for given resort.

No Content

500

Error occurred while fetching amenity links.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "code" : "string",
    "endDate" : "01-01-2023",
    "numberValue" : 1,
    "preferenceExtraId" : 1,
    "resortId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.6. Gets a page of resort amenity links

GET /maxxton/v1/resorts/{resortId}/amenitylinks
Description

Gets a page with amenity links by resortId.It also supports pageable.

Parameters
Type Name Description Schema

Path

resortId
required

resortId to fetch AmenityLink(s)

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAmenityLink

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching resorts.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "code" : "string",
    "endDate" : "01-01-2023",
    "numberValue" : 1,
    "preferenceExtraId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.7. Gets a resort by its Id

GET /maxxton/v1/resorts/{resortId}
Description

Get’s a resort by its Id

Parameters
Type Name Description Schema

Path

resortId
required

resortId to fetch resort

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Resort

404

No resort found for given criteria.

No Content

500

Error occurred while fetching resort.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "bookableLocation" : true,
  "code" : "string",
  "dynamicManagerId" : 1,
  "i18n" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "imageManagerId" : 1,
  "inheritTc" : true,
  "internalResortNumber" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "previousPmsId" : "string",
  "resArrivalDateFrom" : "01-01-2023",
  "resortId" : 1,
  "resortNumber" : 1,
  "resortPriority" : 1,
  "supplierId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visitAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "visitAddressManagerId" : 1
}

5.40.8. Gets a resort details by it’s Id

GET /maxxton/v1/resorts/{resortId}/details
Description

Gets a resort details by it’s Id.The data is being filtered based on start and end date

Parameters
Type Name Description Schema

Query

endDate
optional

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Path

resortId
required

resortId to fetch resort details

integer (int64)

Query

returnResortMap
optional

The unitMap will be returned when the value is set to true.

boolean

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are AMENITYCATEGORYSETS, DYNAMICFIELDS, IMAGES, MAILADDRESS, RESORTMAP, SUBJECTS, VIDEOS, VISITADDRESS, TRANSLATIONS. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

startDate
optional

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

ResortDetailWithUnitMap

404

No resort details found for given criteria.

No Content

500

Error occurred while fetching resort details.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/details
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "amenityCategorySets" : [ {
    "categories" : [ {
      "amenities" : [ {
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "identifier" : "string",
        "imageManagerId" : 1,
        "images" : [ {
          "endDate" : "01-01-2023",
          "fileName" : "string",
          "hostType" : "string",
          "imageId" : 1,
          "imageManagerId" : 1,
          "imageManagerIds" : [ "integer" ],
          "imageOrientation" : "string",
          "imageType" : "string",
          "isActive" : true,
          "isUploaded" : true,
          "isWebPresentation" : true,
          "mediaLanguageId" : 1,
          "mediaType" : "string",
          "mimeType" : "string",
          "modifiedDate" : "01-01-2023T11:23:45Z",
          "sequenceNumber" : 1,
          "startDate" : "01-01-2023",
          "tags" : [ { } ],
          "thumbnailUrl" : "string",
          "translations" : [ { } ],
          "uploadDate" : "01-01-2023T11:23:45Z",
          "url" : "string",
          "version" : 1
        } ],
        "managerId" : 1,
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityCategoryId" : 1,
      "amenityGroups" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "identifier" : "string",
        "managerId" : 1,
        "metric" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "priority" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "bookableLocation" : true,
  "breadCrumb" : "string",
  "code" : "string",
  "dynamicFields" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "dynamicManagerId" : 1,
  "i18n" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "imageManagerId" : 1,
  "images" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "inheritTc" : true,
  "internalResortNumber" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "previousPmsId" : "string",
  "regionId" : 1,
  "resArrivalDateFrom" : "01-01-2023",
  "resortId" : 1,
  "resortMap" : {
    "filename" : "string",
    "imageId" : 1,
    "imageUrl" : "string",
    "unitCoordinates" : [ {
      "getxValue" : 1,
      "getyValue" : 1,
      "unitId" : 1
    } ]
  },
  "resortNumber" : 1,
  "resortPriority" : 1,
  "subjects" : [ {
    "controlAccess" : true,
    "endDate" : "01-01-2023",
    "i18n" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "subjectId" : 1
    } ],
    "includeInTotal" : true,
    "maxAge" : 1,
    "reportGroupSubjectId" : 1,
    "subjectCategoryId" : 1,
    "subjectId" : 1,
    "subjectOrder" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "subjectId" : 1
    } ],
    "type" : "string"
  } ],
  "supplierId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "videos" : [ {
    "endDate" : "01-01-2023",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 1
  } ],
  "visitAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "visitAddressManagerId" : 1
}

5.40.9. Gets all resorts with their details

GET /maxxton/v1/resorts/details
Description

Gets a page of resorts along with their details. Maximum and default page size for this endpoint is 10.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resortPriority:0,
resortNumber:0,
internalResortNumber:String,
code:String,
resortId:0,
parentId:0,
archivedFrom:String(date),
supplierId:0,
adminOrganisationId:0,
origin:String,
originId:String,
bookableLocation:true,
previousPmsId:String)

Query

endDate
optional

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Query

resortIds
optional

List of resortIds to fetch the details

< integer > array

Query

returnResortMap
optional

The unitMap will be returned when the value is set to true.

boolean

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are AMENITYCATEGORYSETS, DYNAMICFIELDS, IMAGES, MAILADDRESS, RESORTMAP, SUBJECTS, VIDEOS, VISITADDRESS, TRANSLATIONS. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

startDate
optional

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResortDetailWithUnitMap

500

Error occurred while fetching resorts.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/details
Example HTTP response
Response 200
{
  "content" : [ {
    "adminOrganisationId" : 1,
    "amenityCategorySets" : [ {
      "categories" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityCategoryId" : 1,
        "amenityGroups" : [ {
          "amenities" : [ { } ],
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "identifier" : "string",
          "managerId" : 1,
          "metric" : { },
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "code" : "string",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "priority" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      } ],
      "code" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "amenityManagerId" : 1,
    "archivedFrom" : "01-01-2023",
    "bookableLocation" : true,
    "breadCrumb" : "string",
    "code" : "string",
    "dynamicFields" : [ {
      "code" : "string",
      "eventmanagerId" : 1,
      "fieldId" : 1,
      "translations" : [ {
        "description" : "string",
        "fieldId" : 1,
        "i18nFieldId" : 1,
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "text" : "string"
      } ],
      "type" : "string"
    } ],
    "dynamicManagerId" : 1,
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "imageManagerId" : 1,
    "images" : [ {
      "endDate" : "01-01-2023",
      "fileName" : "string",
      "hostType" : "string",
      "imageId" : 1,
      "imageManagerId" : 1,
      "imageManagerIds" : [ "integer" ],
      "imageOrientation" : "string",
      "imageType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "mimeType" : "string",
      "modifiedDate" : "01-01-2023T11:23:45Z",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "tags" : [ {
        "name" : "string",
        "tagId" : 1
      } ],
      "thumbnailUrl" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "uploadDate" : "01-01-2023T11:23:45Z",
      "url" : "string",
      "version" : 1
    } ],
    "inheritTc" : true,
    "internalResortNumber" : "string",
    "mailAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAddressManagerId" : 1,
    "origin" : "string",
    "originId" : "string",
    "parentId" : 1,
    "previousPmsId" : "string",
    "regionId" : 1,
    "resArrivalDateFrom" : "01-01-2023",
    "resortId" : 1,
    "resortMap" : {
      "filename" : "string",
      "imageId" : 1,
      "imageUrl" : "string",
      "unitCoordinates" : [ {
        "getxValue" : 1,
        "getyValue" : 1,
        "unitId" : 1
      } ]
    },
    "resortNumber" : 1,
    "resortPriority" : 1,
    "subjects" : [ {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ],
    "supplierId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "videos" : [ {
      "endDate" : "01-01-2023",
      "hostType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageCode" : "string",
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "thumbnailUrl" : "string",
      "url" : "string",
      "videoId" : 1
    } ],
    "visitAddress" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "visitAddressManagerId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.10. Gets dynamic fields for a particular resort

GET /maxxton/v1/resorts/{resortId}/dynamicfields
Description

Gets a page with dynamic fields to a specific resort. The records can be filtered based on the DynamicField object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fieldId:0,
code:String,
type:String)

Path

resortId
required

Resort id for which dynamic fieilds are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDynamicField

500

Error occurred while fetching resort dynamic fields.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/dynamicfields
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.11. Gets images for a particular resort

GET /maxxton/v1/resorts/{resortId}/images
Description

Gets a page with images to a specific resort. The records can be filtered based on the image object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileName:String,
imageId:0,
startDate:String(date),
endDate:String(date),
mimeType:String,
version:0,
url:String,
uploadDate:String(date),
imageType:String,
imageOrientation:String,
modifiedDate:String(date))

Path

resortId
required

Resort id for which images are to be fetched

integer (int64)
Responses
Code Description Schema

200

Resort id for which images are to be fetched

PageImage

500

Error occurred while fetching resorts.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/images
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.12. Gets resort priorities by it’s resort Id

GET /maxxton/v1/resorts/{resortId}/priorities
Description

Gets resort priorities by resort Id

Parameters
Type Name Description Schema

Path

resortId
required

resortId to fetch resort’s priorities

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageResortPriority

404

No resort priorities found for given criteria.

No Content

500

Error occurred while fetching resort priorities.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/priorities
Example HTTP response
Response 200
{
  "content" : [ {
    "distributionChannelId" : 1,
    "endDate" : "01-01-2023",
    "priority" : 1,
    "resortId" : 1,
    "resortPriorityId" : 1,
    "segmentId" : 1,
    "startDate" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.40.13. Search available accommodationtypes of a resort based on provided criteria

POST /maxxton/v1/resorts/search
Description

The above endpoint is used to search through the availability of the whole inventory based on resorts. The endpoint will club the accommodation types with availability per resort and provide them as a nested list within the resort entity. The result can be filtered based on the provided request criteria. For example: arrival date, duration, resorts, amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals, departures, resorts and amenities as per the criteria passed in the request.
In case of prebooking, the accommdationtype prices are null.
The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It’s up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay. See below diagram for an explanation on how the alternative stays work:
DateMarginFlowDiagram role="text-center"

Parameters
Type Name Description Schema

Body

requestBody
required

ResortSearchRequest

Query

defaultSelection
optional

nearest_arrival, cheapest_price [nearest_arrival - First available arrival(based on today’s date) if no arrival date is provided. cheapest_price - sort based on cheapest price]

string

Query

segmentId
optional

if provided, it will fetch the resort priorities based on this segmentId.if not provided, but segments are used, it will use the priority configured on the location level instead and sort the resorts based on that

integer (int64)

Query

sort
optional

if provided, it will sort the resort priorities in the given direction. if not provided, it will sort the resort priorities in ascending order. Possible : resort_priority_asc, resort_priority_desc.

enum (RESORT_PRIORITY_ASC,RESORT_PRIORITY_DESC)
Responses
Code Description Schema

200

The request is completed successfully without any errors

ResortSearchResponse

500

Error occurred while fetching resorts

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/search
Request body
{
  "accommodationKindIds" : [ "integer" ],
  "amenityIds" : [ "integer" ],
  "arrivalDate" : "01-01-2023",
  "dateMargin" : 1,
  "dateMarginMethod" : "string",
  "distributionChannelId" : 1,
  "duration" : 1,
  "filterOptions" : [ "string" ],
  "includeAccommodationtypes" : true,
  "includeFilterOptionCounts" : true,
  "maxNrOfBathrooms" : 1,
  "maxNrOfBedrooms" : 1,
  "minNrOfBathrooms" : 1,
  "minNrOfBedrooms" : 1,
  "offerCode" : "string",
  "offerId" : 1,
  "petQuantity" : 1,
  "redeemableLoyaltyPoints" : 1,
  "regionId" : 1,
  "resortIds" : [ "integer" ],
  "subjects" : {
    "persons" : [ {
      "maxAge" : "string",
      "quantity" : 1
    } ]
  }
}
Example HTTP response
Response 200
{
  "filterOptionsResult" : {
    "accommodationKinds" : [ "object" ],
    "amenities" : [ "object" ],
    "arrivals" : [ "string" ],
    "departures" : [ "string" ]
  },
  "result" : {
    "content" : [ {
      "accommodationtypes" : [ {
        "accommodationKindId" : 1,
        "arrivalDate" : "01-01-2023",
        "basePrice" : 1,
        "basePriceInclusive" : 1,
        "departureDate" : "01-01-2023",
        "duration" : 1,
        "freeLoyaltyDuration" : 1,
        "loyaltyPrice" : 1,
        "loyaltyPriceInclusive" : 1,
        "nrOfBathrooms" : 1,
        "nrOfBedrooms" : 1,
        "offerCode" : "string",
        "offerPrice" : 1,
        "offerPriceInclusive" : 1,
        "rateTypeId" : 1,
        "referencePrice" : 1,
        "referencePriceInclusive" : 1,
        "requiredLoyaltyPoints" : 1,
        "resourceId" : 1,
        "totalCapacity" : 1
      } ],
      "resortId" : 1
    } ],
    "empty" : true,
    "first" : true,
    "last" : true,
    "number" : 1,
    "numberOfElements" : 1,
    "size" : 1,
    "sort" : {
      "empty" : true,
      "sorted" : true,
      "unsorted" : true
    },
    "totalElements" : 1,
    "totalPages" : 1
  }
}

5.40.14. Update/insert resort dynamic field

PUT /maxxton/v1/resorts/{resortId}/dynamicfields/{fieldId}
Description

The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for resort, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the resort, then the text field will be modified

Parameters
Type Name Description Schema

Body

requestBody
required

< DynamicFieldDataCriteria
> array

Path

resortId
required

resortId to fetch resort

integer (int64)

Path

fieldId
required

fieldId to fetch dynamic field

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while fetching updating/inserting the resort dynamic fields.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/dynamicfields/{fieldId}
Request body
[ {
  "language" : "string",
  "text" : "string"
} ]
Example HTTP response

5.40.15. Updates/creates amenitylink to the resort.

PUT /maxxton/v1/resorts/{resortId}/amenitylinks/{amenityId}
Description

The above endpoint updates the amenity link for that resort. If the amenityId is valid for resort, but not linked yet, then the link will be created.

Parameters
Type Name Description Schema

Path

amenityId
required

amenityId to update/create AmenityLink

integer (int64)

Body

requestBody
required

UpdateAmenityLinkRequest

Path

resortId
required

resortId to update/create AmenityLink

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while updating/creating amenity links.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/amenitylinks/{amenityId}
Request body
{
  "amenityId" : 1,
  "endDate" : "01-01-2023",
  "numberValue" : 1,
  "startDate" : "01-01-2023",
  "textValue" : "string"
}
Example HTTP response

5.40.16. creates a new resort

POST /maxxton/v1/resorts
Description

creates a new resort

Parameters
Type Name Description Schema

Body

requestBody
required

CreateResortRequest
Responses
Code Description Schema

200

The request is completed successfully without any errors

Resort

500

Error occurred while creating resort.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts
Request body
{
  "adminOrganisationId" : 1,
  "code" : "string",
  "internalResortNumber" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "resortNumber" : 1,
  "resortPriority" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visitAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  }
}
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "bookableLocation" : true,
  "code" : "string",
  "dynamicManagerId" : 1,
  "i18n" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "imageManagerId" : 1,
  "inheritTc" : true,
  "internalResortNumber" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "previousPmsId" : "string",
  "resArrivalDateFrom" : "01-01-2023",
  "resortId" : 1,
  "resortNumber" : 1,
  "resortPriority" : 1,
  "supplierId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visitAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "visitAddressManagerId" : 1
}

5.40.17. updates a existing resort

PUT /maxxton/v1/resorts/{resortId}
Description

updates a existing resort

Parameters
Type Name Description Schema

Body

requestBody
required

UpdateResortRequest

Path

resortId
required

resortId to update resort

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Resort

500

Error occurred while creating resort.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}
Request body
{
  "adminOrganisationId" : 1,
  "code" : "string",
  "internalResortNumber" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "resortNumber" : 1,
  "resortPriority" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visitAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  }
}
Example HTTP response
Response 200
{
  "adminOrganisationId" : 1,
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "bookableLocation" : true,
  "code" : "string",
  "dynamicManagerId" : 1,
  "i18n" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "imageManagerId" : 1,
  "inheritTc" : true,
  "internalResortNumber" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 1,
  "origin" : "string",
  "originId" : "string",
  "parentId" : 1,
  "previousPmsId" : "string",
  "resArrivalDateFrom" : "01-01-2023",
  "resortId" : 1,
  "resortNumber" : 1,
  "resortPriority" : 1,
  "supplierId" : 1,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visitAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "visitAddressManagerId" : 1
}

5.40.18. updates a resortPriority for a given resortId

POST /maxxton/v1/resorts/{resortId}/priorities
Parameters
Type Name Description Schema

Body

requestBody
required

ResortPriority

Path

resortId
required

Resort id for which priority needs to be updated.

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

404

Resort not found

No Content

500

Error occurred while updating resort priorities.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/priorities
Request body
{
  "distributionChannelId" : 1,
  "endDate" : "01-01-2023",
  "priority" : 1,
  "resortId" : 1,
  "resortPriorityId" : 1,
  "segmentId" : 1,
  "startDate" : "01-01-2023"
}
Example HTTP response

5.41. Room types

Defines type of room in an unit

5.41.1. Gets a page with room types

GET /maxxton/v1/roomtypes
Description

Gets a page with room types and its details.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
roomTypeId:0,
code:String)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRoomType

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching roomtypes.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/roomtypes
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "roomTypeId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.42. Rooms

Defines a room in an unit

5.42.1. Gets all amenity links

GET /maxxton/v1/rooms/amenitylinks
Description

Gets a page with all the amenity links.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
roomId:0,
amenityLinkId:0,
type:String,
visible:true,
preferenceExtraId:0,
numberValue:0.0,
textValue:String,
startDate:String(date),
endDate:String(date),
amenityId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRoomAmenityLink

500

Error occurred while fetching Amenity links.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/rooms/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "code" : "string",
    "endDate" : "01-01-2023",
    "numberValue" : 1,
    "preferenceExtraId" : 1,
    "roomId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.42.2. Gets amenity links for a specific room

GET /maxxton/v1/rooms/{roomId}/amenitylinks
Description

Gets a page with amenity links for a particular room.It also supports pageable.It also supports pageable..

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityLinkId:0,
type:String,
visible:true,
preferenceExtraId:0,
numberValue:0.0,
textValue:String,
startDate:String(date),
endDate:String(date),
amenityId:0)

Path

roomId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAmenityLink

404

No resorts found for given criteria.

No Content

500

Error occurred while fetching Amenity links.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/rooms/{roomId}/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "code" : "string",
    "endDate" : "01-01-2023",
    "numberValue" : 1,
    "preferenceExtraId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.43. Send Methods

Send methods of reservation

5.43.1. Gets a send methods for reservations

GET /maxxton/v1/sendmethods
Description

Gets a page with send methods.The records can be filtered based on send method object.It also supports pageable.

Responses
Code Description Schema

200

The request is completed successfully without any errors

PageSendMethod

500

Error occurred while fetching send methods.

No Content
Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/sendmethods
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "default" : true,
    "extraCostResourceId" : 1,
    "isDefault" : true,
    "sendMethodId" : 1,
    "translations" : [ {
      "i18nSendMethodId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "sendMethodId" : 1
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.44. Subjects

Subjects for accommodation types

5.44.1. Gets subject categories

GET /maxxton/v1/subjects/categories
Description

Gets subject categories.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
subjectId:0,
maxAge:0,
sort:0,
endDate:String(date))
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageSubjectCategory

500

Error occurred while fetching subject categories.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/subjects/categories
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "i18n" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "subjectId" : 1
    } ],
    "maxAge" : 1,
    "sort" : 1,
    "subjectId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "subjectId" : 1
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45. Units

Physical accommodation where customer stays

5.45.1. Adds a lock to the specific unit.

POST /maxxton/v1/units/{unitId}/locks
Description

Adds a lock to the specific unit, this makes the unit no longer bookable online. In case a lock already exists for part of the period the existing period is extended.

Parameters
Type Name Description Schema

Body

requestBody
required

CreateLockRequest

Path

unitId
required

id of the unit

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while creating unit lock.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/locks
Request body
{
  "detailDescription" : "string",
  "endDate" : "01-01-2023",
  "reasonId" : 1,
  "startDate" : "01-01-2023",
  "type" : "string",
  "unitId" : 1
}
Example HTTP response

5.45.2. Create Unit

POST /maxxton/v1/units
Description

Adds a new Unit. The details are to be added in request body.
Note: The country field in mailAddress is not allowed while adding a unit.

Parameters
Type Name Description Schema

Body

requestBody
required

CreateUnitRequest
Responses
Code Description Schema

200

unit created without any error.

Unit

500

Error occurred while creating unit.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units
Request body
{
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "groupPriority" : 1,
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "rentableUnitId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "unitId" : 1
  } ]
}
Example HTTP response
Response 200
{
  "accommodationAddressManagerId" : 1,
  "accommodationMemoManagerId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityManagerId" : 1,
  "archivedFrom" : "01-01-2023",
  "brandId" : 1,
  "cadastralId" : "string",
  "capacityManagerId" : 1,
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "concernId" : 1,
  "contactManagerId" : 1,
  "costCenterId" : 1,
  "dynamicManagerId" : 1,
  "eventManagerId" : 1,
  "excludeQuestionnaireStats" : true,
  "fileManagerId" : 1,
  "genericMemoManagerId" : 1,
  "groupPriority" : 1,
  "imageManagerId" : 1,
  "implicationManagerId" : 1,
  "impliedObject" : true,
  "isSeasonalRuleExcluded" : true,
  "ledgerId" : 1,
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "path" : "string",
  "questionnaireStatsManagerId" : 1,
  "rentableUnitId" : 1,
  "resourceGroupId" : 1,
  "resourceId" : 1,
  "resourceManagerId" : 1,
  "roomCode" : "string",
  "roomManagerId" : 1,
  "secondLedgerId" : 1,
  "setupDate" : "01-01-2023",
  "showOnPlanningChart" : true,
  "supervisorId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "unitId" : 1
  } ],
  "type" : "string",
  "unitId" : 1,
  "virtual" : true,
  "vsi" : 1
}

5.45.3. Create new amenity link

POST /maxxton/v1/units/{unitId}/amenitylinks
Description

Send an request to the endpoint. This will link the amenity to the unit from the request. After this, you will get the amenityLinkId and information in the response. To update other details for the amenity from the response and update it using the PUT maxxton/v1/units/{unitId}/amenitylink/{amenitylinkId}

Parameters
Type Name Description Schema

Body

requestBody
required

CreateUnitAmenitylinkRequest_Basic

Path

unitId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed without any error.

AmenityDetail_Basic

500

Error occurred while creating new unit link with amenity.

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks
Request body
{
  "amenityId" : 1,
  "endDate" : "01-01-2023",
  "numberValue" : 1,
  "preferenceExtraId" : 1,
  "startDate" : "01-01-2023",
  "textValue" : "string",
  "visible" : true
}
Example HTTP response
Response 200
{
  "amenityId" : 1,
  "amenityLinkId" : 1,
  "archivedFrom" : "01-01-2023",
  "categories" : [ {
    "amenityCategoryId" : 1,
    "code" : "string",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "isInternalUse" : true,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "endDate" : "01-01-2023",
  "identifier" : "string",
  "metric" : {
    "code" : "string",
    "i18n" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "metricId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  },
  "numberValue" : 1,
  "origin" : "string",
  "parentAmenityId" : 1,
  "preferenceExtraId" : 1,
  "startDate" : "01-01-2023",
  "textValue" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "type" : "string",
  "visible" : true
}

5.45.4. Delete amenity link

DELETE /maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Description

Delete amenity link with a specific amenity id from a specific unit.

Parameters
Type Name Description Schema

Path

unitId
required

integer (int64)

Path

amenitylinkId
required

integer (int64)
Responses
Code Description Schema

204

amenityLink is deleted without any error.

No Content

500

Error occurred while deleting amenityLink.

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Example HTTP response

5.45.5. Get rooms for a specific unitId

GET /maxxton/v1/units/{unitId}/rooms
Description

Provides the details of the rooms specific to a particular unit id. The records can be filtered based on rooms object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
roomId:0,
code:String,
parentId:0,
lowestLevel:true)

Path

unitId
required

Unit id for which rooms are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageRoom

500

Error occurred while fetching Rooms

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/rooms
Example HTTP response
Response 200
{
  "content" : [ {
    "amenities" : [ {
      "amenityLinkId" : 1,
      "numberValue" : 1,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "name" : "string",
    "parentId" : 1,
    "roomId" : 1,
    "roomManagerId" : 1,
    "roomType" : {
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "roomTypeId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.6. Get unit doorlock pincodes

GET /maxxton/v1/units/doorlocks/pincodes
Description

Gets a page of unit doorlock pincodes.
Maximum page size for this endpoint is 100. The records can be filtered based on unit doorlock Pincodes object. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
doorlockId:0,
unitId:0,
lockCode:String,
codeLength:0,
bluetoothLowEnergy:true)

Query

endDate
optional

If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the endDate is provided, pin codes will be returned from the currentDate until endDate, and the duration in between the currentDate and endDate should not be greater than one month.

string (date)

Query

startDate
optional

If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the startDate is provided, pin codes will be returned from startDate until the next one month.

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDoorlockPincodesContainer

500

Error occurred while fetching unit doorlock pincodes

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/doorlocks/pincodes
Example HTTP response
Response 200
{
  "content" : [ {
    "bluetoothLowEnergy" : true,
    "codeLength" : 1,
    "doorlockId" : 1,
    "lockCode" : "string",
    "pincodes" : [ {
      "arrivalDate" : "01-01-2023",
      "doorlockPincodeId" : 1,
      "pincode1" : "string",
      "pincode2" : "string",
      "statusCode1" : true,
      "statusCode2" : true
    } ],
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.7. Get unit doorlocktypes

GET /maxxton/v1/units/doorlocktypes
Description

Gets a page of unit doorlock types.
Maximum page size for this endpoint is 100. The records can be filtered based on unit. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0)

Query

endDate
optional

If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the endDate is provided, data will be returned until endDate

string (date)

Query

lockType
optional

filtered based on lockType

enum (SAFLOKCARD,KOOLECONTROLS)

Query

startDate
optional

If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate.If only startDate is provided, data will be fetched from startDate

string (date)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitDoorlock

500

Error occurred while fetching unit doorlock pincodes

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/doorlocktypes
Example HTTP response
Response 200
{
  "content" : [ {
    "doorLockTypes" : [ {
      "doorlockTypeId" : 1,
      "doorlocks" : [ {
        "bluetoothLowEnergy" : true,
        "doorLockCode" : "string"
      } ],
      "endDate" : "01-01-2023",
      "lockType" : "string",
      "startDate" : "01-01-2023"
    } ],
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.8. Get workorder for units

GET /maxxton/v1/units/workorders
Description

Get a page of workorders for units.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
workOrderId:0,
status:String,
item:String,
description:String,
assigneeEmployeeId:0,
reporterEmployeeId:0,
expectedStartDate:String(date),
reservationId:0,
areaName:String,
totalWorkTime:0,
totalLabourPrice:0.0,
totalMaterialPrice:0.0,
materialSupplier:String,
issueCategoryName:String,
reportedOn:String(date),
priority:String,
reportedWorkOrder:String,
resortId:0,
resourceId:0,
solvedDate:String(date),
referenceNumber:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageWorkorder

500

Error occurred while fetching Workorders

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/workorders
Example HTTP response
Response 200
{
  "content" : [ {
    "areaName" : "string",
    "assigneeEmployeeId" : 1,
    "description" : "string",
    "expectedStartDate" : "01-01-2023",
    "issueCategoryName" : "string",
    "item" : "string",
    "materialSupplier" : "string",
    "priority" : "string",
    "referenceNumber" : 1,
    "reportedOn" : "01-01-2023T11:23:45Z",
    "reportedWorkOrder" : "string",
    "reporterEmployeeId" : 1,
    "reservationId" : 1,
    "resortId" : 1,
    "resourceId" : 1,
    "solvedDate" : "01-01-2023T11:23:45Z",
    "status" : "string",
    "totalLabourPrice" : 1,
    "totalMaterialPrice" : 1,
    "totalWorkTime" : 1,
    "unitId" : 1,
    "workOrderId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.9. Gets Amenity links for units

GET /maxxton/v1/units/amenitylinks
Description

Gets a page with amenity links associated with Units.The records can be filtered based on AmenityDetail object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
amenityLinkId:0,
amenityId:0,
amenity:String,
endDate:String(date),
startDate:String(date),
numberValue:0.0,
textValue:String,
visible:true,
origin:String,
translations:String,
managerId:0,
type:String)

Query

unitId
optional

A unitId to filter amenity links based for specific unit.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitAmenityLink

500

Error occurred while fetching amenity links for units.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "archivedFrom" : "01-01-2023",
    "categories" : [ {
      "amenityCategoryId" : 1,
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "isInternalUse" : true,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "endDate" : "01-01-2023",
    "identifier" : "string",
    "metric" : {
      "code" : "string",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "metricId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "numberValue" : 1,
    "origin" : "string",
    "parentAmenityId" : 1,
    "preferenceExtraId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.10. Gets Units locks

GET /maxxton/v1/units/locks
Description

Gets a page with Units locks to all unit ids. The records can be filtered based on the lock object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reasonId:0,
detailDescription:String,
startDate:String(date),
endDate:String(date),
type:String,
unitId:0)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageLock

500

Error occurred while fetching units locks.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/locks
Example HTTP response
Response 200
{
  "content" : [ {
    "accoCreatedLock" : 1,
    "blockDate" : "01-01-2023",
    "clientId" : 1,
    "created" : "01-01-2023T11:23:45Z",
    "createdOn" : "01-01-2023T11:23:45Z",
    "detailDescription" : "string",
    "endDate" : "01-01-2023",
    "objectId" : 1,
    "reasonId" : 1,
    "resourceId" : 1,
    "resourceLockId" : 1,
    "resourceManagerId" : 1,
    "startDate" : "01-01-2023",
    "type" : "string",
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.11. Gets a single unit

GET /maxxton/v1/units/{unitId}
Description

Gets a single unit based on a specific unit id.

Parameters
Type Name Description Schema

Path

unitId
required

Unit id of the unit

integer (int64)

Query

returnWorkOrderUnits
optional

Work order type units are not returned by default. To get work order type units, this request parameter can be used

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

UnitDetail_Id
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}
Example HTTP response
Response 200
{
  "accommodationAddressManagerId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "archivedFrom" : "01-01-2023",
  "brandId" : 1,
  "capacityManagerId" : 1,
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "dynamicManagerId" : 1,
  "energyLabelRegistrationNumber" : "string",
  "excludeQuestionnaireStats" : true,
  "imageManagerId" : 1,
  "implicationManagerId" : 1,
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "path" : "string",
  "previousPmsId" : "string",
  "rentableUnitId" : 1,
  "resourceGroupId" : 1,
  "resourceId" : 1,
  "resourceManagerId" : 1,
  "roomCode" : "string",
  "roomManagerId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "unitId" : 1
  } ],
  "type" : "string",
  "unitId" : 1,
  "vsi" : 1
}

5.45.12. Gets a unit with details.

GET /maxxton/v1/units/{unitId}/details
Description

Provides a unit with amenities, capacities, images, rooms and dynamic fields.The data is being filtered based on start and end date.

Parameters
Type Name Description Schema

Query

endDate
optional

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Path

unitId
required

Unit id of the unit

integer (int64)

Query

distributionChannelId
optional

A distributionChannelId to fetch Unit

integer (int64)

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are ADDRESS, AMENITYCATEGORYSETS, CAPACITIES, CAPACITYREQUIREMENTS, DYNAMICFIELDS, IMAGES, ROOMS, VIDEOS, TRANSLATIONS, DOORLOCKTYPES. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

startDate
optional

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Query

returnWorkOrderUnits
optional

Work order type units are not returned by default. To get work order type units, this request parameter can be used

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

UnitDetail

500

Error occurred while fetching the unit.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/details
Example HTTP response
Response 200
{
  "accommodationAddressManagerId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityCategorySets" : [ {
    "categories" : [ {
      "amenities" : [ {
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "identifier" : "string",
        "imageManagerId" : 1,
        "images" : [ {
          "endDate" : "01-01-2023",
          "fileName" : "string",
          "hostType" : "string",
          "imageId" : 1,
          "imageManagerId" : 1,
          "imageManagerIds" : [ "integer" ],
          "imageOrientation" : "string",
          "imageType" : "string",
          "isActive" : true,
          "isUploaded" : true,
          "isWebPresentation" : true,
          "mediaLanguageId" : 1,
          "mediaType" : "string",
          "mimeType" : "string",
          "modifiedDate" : "01-01-2023T11:23:45Z",
          "sequenceNumber" : 1,
          "startDate" : "01-01-2023",
          "tags" : [ { } ],
          "thumbnailUrl" : "string",
          "translations" : [ { } ],
          "uploadDate" : "01-01-2023T11:23:45Z",
          "url" : "string",
          "version" : 1
        } ],
        "managerId" : 1,
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityCategoryId" : 1,
      "amenityGroups" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "identifier" : "string",
        "managerId" : 1,
        "metric" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "metricDetail" : {
          "code" : "string",
          "i18n" : [ { } ],
          "metricId" : 1,
          "translations" : [ { } ]
        },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "priority" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "archivedFrom" : "01-01-2023",
  "brandId" : 1,
  "capacities" : [ {
    "capacity" : 1,
    "capacityId" : 1,
    "endDate" : "01-01-2023",
    "managerId" : 1,
    "startDate" : "01-01-2023",
    "subject" : {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    },
    "subjectId" : 1
  } ],
  "capacityManagerId" : 1,
  "capacityRequirements" : [ {
    "managerId" : 1,
    "required" : 1,
    "subject" : [ {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ]
  } ],
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "doorLockTypes" : [ {
    "doorlockTypeId" : 1,
    "doorlocks" : [ {
      "bluetoothLowEnergy" : true,
      "doorLockCode" : "string"
    } ],
    "endDate" : "01-01-2023",
    "lockType" : "string",
    "startDate" : "01-01-2023"
  } ],
  "dynamicFields" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "dynamicManagerId" : 1,
  "energyLabelRegistrationNumber" : "string",
  "excludeQuestionnaireStats" : true,
  "imageManagerId" : 1,
  "images" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "implicationManagerId" : 1,
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "path" : "string",
  "previousPmsId" : "string",
  "rentableUnitId" : 1,
  "resourceGroupId" : 1,
  "resourceId" : 1,
  "resourceManagerId" : 1,
  "roomCode" : "string",
  "roomManagerId" : 1,
  "rooms" : [ {
    "amenities" : [ {
      "amenityLinkId" : 1,
      "numberValue" : 1,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "name" : "string",
    "parentId" : 1,
    "roomId" : 1,
    "roomManagerId" : 1,
    "roomType" : {
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "roomTypeId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "unitId" : 1
  } ],
  "type" : "string",
  "unitId" : 1,
  "videos" : [ {
    "endDate" : "01-01-2023",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 1
  } ],
  "vsi" : 1
}

5.45.13. Gets all units

GET /maxxton/v1/units
Description

Gets a page with units. The records can be filtered based on unit object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
type:String,
resourceId:0,
code:String,
nrOfBathrooms:0.0,
path:String,
excludeQuestionnaireStats:true,
choosableOnInternet:true,
resourceGroupId:0,
cleaningStatus:String,
roomCode:String,
nrOfBedrooms:0,
archivedFrom:String(date),
vsi:0,
origin:String,
originId:String,
energyLabelRegistrationNumber:String,
previousPmsId:String,
rentableUnitId:0)

Query

returnWorkOrderUnits
optional

Work order type units are not returned by default. To get work order type units, this request parameter can be used

boolean

Query

unitIds
optional

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitDetail_Id

500

Error occurred while fetching units.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddressManagerId" : 1,
    "address" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "archivedFrom" : "01-01-2023",
    "brandId" : 1,
    "capacityManagerId" : 1,
    "choosableOnInternet" : true,
    "cleaningStatus" : "string",
    "code" : "string",
    "dynamicManagerId" : 1,
    "energyLabelRegistrationNumber" : "string",
    "excludeQuestionnaireStats" : true,
    "imageManagerId" : 1,
    "implicationManagerId" : 1,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "origin" : "string",
    "originId" : "string",
    "path" : "string",
    "previousPmsId" : "string",
    "rentableUnitId" : 1,
    "resourceGroupId" : 1,
    "resourceId" : 1,
    "resourceManagerId" : 1,
    "roomCode" : "string",
    "roomManagerId" : 1,
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "unitId" : 1
    } ],
    "type" : "string",
    "unitId" : 1,
    "vsi" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.14. Gets all units with their details

GET /maxxton/v1/units/details
Description

Gets a page of units along with their details. Maximum and default page size for this endpoint is 10.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
type:String,
resourceId:0,
code:String,
nrOfBathrooms:0.0,
path:String,
excludeQuestionnaireStats:true,
choosableOnInternet:true,
resourceGroupId:0,
cleaningStatus:String,
roomCode:String,
nrOfBedrooms:0,
archivedFrom:String(date),
vsi:0,
origin:String,
originId:String,
energyLabelRegistrationNumber:String,
previousPmsId:String,
rentableUnitId:0)

Query

returnSections
optional

List of constant strings to return only the selected sections in the response. The possible values are ADDRESS, AMENITYCATEGORYSETS, CAPACITIES, CAPACITYREQUIREMENTS, DYNAMICFIELDS, IMAGES, ROOMS, VIDEOS, TRANSLATIONS, DOORLOCKTYPES. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

< string > array

Query

returnWorkOrderUnits
optional

Work order type units are not returned by default. To get work order type units, this request parameter can be used

boolean

Query

unitIds
optional

List of unitIds to fetch the details

< integer > array
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitDetail

500

Error occurred while fetching units.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/details
Example HTTP response
Response 200
{
  "content" : [ {
    "accommodationAddressManagerId" : 1,
    "address" : {
      "accuracy" : "string",
      "address1" : "string",
      "address2" : "string",
      "address3" : "string",
      "addressId" : 1,
      "altContactPerson" : "string",
      "alternateContactPerson" : "string",
      "boxNumber" : "string",
      "city" : "string",
      "country" : {
        "code" : "string",
        "countryId" : 1,
        "default" : true,
        "defaultLanguageId" : 1,
        "priority" : 1,
        "shortName" : "string",
        "translations" : [ {
          "i18nCountryId" : 1,
          "language" : "string",
          "languageId" : 1,
          "longName" : "string",
          "name" : "string"
        } ]
      },
      "countryId" : 1,
      "dateBegin" : "01-01-2023",
      "dateEnd" : "01-01-2023",
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 1,
      "longitude" : 1,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "municipality" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 1,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "amenityCategorySets" : [ {
      "categories" : [ {
        "amenities" : [ {
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "i18n" : [ { } ],
          "identifier" : "string",
          "imageManagerId" : 1,
          "images" : [ { } ],
          "managerId" : 1,
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityCategoryId" : 1,
        "amenityGroups" : [ {
          "amenities" : [ { } ],
          "amenityId" : 1,
          "amenityLinkId" : 1,
          "archivedFrom" : "01-01-2023",
          "code" : "string",
          "endDate" : "01-01-2023",
          "identifier" : "string",
          "managerId" : 1,
          "metric" : { },
          "metricDetail" : { },
          "numberValue" : 1,
          "origin" : "string",
          "parentAmenityId" : 1,
          "preferenceExtraId" : 1,
          "startDate" : "01-01-2023",
          "textValue" : "string",
          "translations" : [ { } ],
          "type" : "string",
          "visible" : true
        } ],
        "code" : "string",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "priority" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      } ],
      "code" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "archivedFrom" : "01-01-2023",
    "brandId" : 1,
    "capacities" : [ {
      "capacity" : 1,
      "capacityId" : 1,
      "endDate" : "01-01-2023",
      "managerId" : 1,
      "startDate" : "01-01-2023",
      "subject" : {
        "controlAccess" : true,
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "includeInTotal" : true,
        "maxAge" : 1,
        "reportGroupSubjectId" : 1,
        "subjectCategoryId" : 1,
        "subjectId" : 1,
        "subjectOrder" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "type" : "string"
      },
      "subjectId" : 1
    } ],
    "capacityManagerId" : 1,
    "capacityRequirements" : [ {
      "managerId" : 1,
      "required" : 1,
      "subject" : [ {
        "controlAccess" : true,
        "endDate" : "01-01-2023",
        "i18n" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "includeInTotal" : true,
        "maxAge" : 1,
        "reportGroupSubjectId" : 1,
        "subjectCategoryId" : 1,
        "subjectId" : 1,
        "subjectOrder" : 1,
        "translations" : [ {
          "language" : "string",
          "languageId" : 1,
          "name" : "string",
          "shortDescription" : "string",
          "subjectId" : 1
        } ],
        "type" : "string"
      } ]
    } ],
    "choosableOnInternet" : true,
    "cleaningStatus" : "string",
    "code" : "string",
    "doorLockTypes" : [ {
      "doorlockTypeId" : 1,
      "doorlocks" : [ {
        "bluetoothLowEnergy" : true,
        "doorLockCode" : "string"
      } ],
      "endDate" : "01-01-2023",
      "lockType" : "string",
      "startDate" : "01-01-2023"
    } ],
    "dynamicFields" : [ {
      "code" : "string",
      "eventmanagerId" : 1,
      "fieldId" : 1,
      "translations" : [ {
        "description" : "string",
        "fieldId" : 1,
        "i18nFieldId" : 1,
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "text" : "string"
      } ],
      "type" : "string"
    } ],
    "dynamicManagerId" : 1,
    "energyLabelRegistrationNumber" : "string",
    "excludeQuestionnaireStats" : true,
    "imageManagerId" : 1,
    "images" : [ {
      "endDate" : "01-01-2023",
      "fileName" : "string",
      "hostType" : "string",
      "imageId" : 1,
      "imageManagerId" : 1,
      "imageManagerIds" : [ "integer" ],
      "imageOrientation" : "string",
      "imageType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "mimeType" : "string",
      "modifiedDate" : "01-01-2023T11:23:45Z",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "tags" : [ {
        "name" : "string",
        "tagId" : 1
      } ],
      "thumbnailUrl" : "string",
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "uploadDate" : "01-01-2023T11:23:45Z",
      "url" : "string",
      "version" : 1
    } ],
    "implicationManagerId" : 1,
    "nrOfBathrooms" : 1,
    "nrOfBedrooms" : 1,
    "origin" : "string",
    "originId" : "string",
    "path" : "string",
    "previousPmsId" : "string",
    "rentableUnitId" : 1,
    "resourceGroupId" : 1,
    "resourceId" : 1,
    "resourceManagerId" : 1,
    "roomCode" : "string",
    "roomManagerId" : 1,
    "rooms" : [ {
      "amenities" : [ {
        "amenityLinkId" : 1,
        "numberValue" : 1,
        "textValue" : "string"
      } ],
      "code" : "string",
      "lowestLevel" : true,
      "name" : "string",
      "parentId" : 1,
      "roomId" : 1,
      "roomManagerId" : 1,
      "roomType" : {
        "code" : "string",
        "i18n" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ],
        "roomTypeId" : 1,
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "languageId" : 1,
          "name" : "string"
        } ]
      },
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "translations" : [ {
      "description" : "string",
      "description2" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "unitId" : 1
    } ],
    "type" : "string",
    "unitId" : 1,
    "videos" : [ {
      "endDate" : "01-01-2023",
      "hostType" : "string",
      "isActive" : true,
      "isUploaded" : true,
      "isWebPresentation" : true,
      "mediaLanguageCode" : "string",
      "mediaLanguageId" : 1,
      "mediaType" : "string",
      "sequenceNumber" : 1,
      "startDate" : "01-01-2023",
      "thumbnailUrl" : "string",
      "url" : "string",
      "videoId" : 1
    } ],
    "vsi" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.15. Gets allotments for Unit to a specific unit id.

GET /maxxton/v1/units/{unitId}/allotments
Description

Gets a page with all allotments for Unit to a specific unit id.The records can be filtered based on allotment object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentId:0,
distributionChannelId:0,
resourceId:0,
name:String,
description:String,
type:String,
exceedLimit:0,
expirePeriod:0,
amount:0,
modified:String(date),
isEnactive:true)

Path

unitId
required

Unit id for which to fetch Allotments

integer (int64)

Query

distributionChannelId
optional

DistributionChannel id for which to fetch Allotments

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageAllotment

500

Error occurred while fetching Allotments.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/allotments
Example HTTP response
Response 200
{
  "content" : [ {
    "allotmentId" : 1,
    "amount" : 1,
    "description" : "string",
    "distributionChannelId" : 1,
    "exceedLimit" : 1,
    "expirePeriod" : 1,
    "hasObjects" : true,
    "isEnactive" : true,
    "modified" : "01-01-2023",
    "name" : "string",
    "periods" : [ {
      "endDate" : "01-01-2023",
      "quantity" : 1,
      "startDate" : "01-01-2023",
      "unitIds" : [ "integer" ]
    } ],
    "resourceId" : 1,
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.16. Gets amenity links to a specific unit id.

GET /maxxton/v1/units/{unitId}/amenitylinks
Description

Gets a page with amenity links associated with Unit to a specific unit id.It also supports pageable.

Parameters
Type Name Description Schema

Path

unitId
required

unitId to fetch amenity links.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageUnitAmenityLink

500

Error occurred while fetching amenity links for unit.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks
Example HTTP response
Response 200
{
  "content" : [ {
    "amenityId" : 1,
    "amenityLinkId" : 1,
    "archivedFrom" : "01-01-2023",
    "categories" : [ {
      "amenityCategoryId" : 1,
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "isInternalUse" : true,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "endDate" : "01-01-2023",
    "identifier" : "string",
    "metric" : {
      "code" : "string",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "metricId" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "numberValue" : 1,
    "origin" : "string",
    "parentAmenityId" : 1,
    "preferenceExtraId" : 1,
    "startDate" : "01-01-2023",
    "textValue" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "type" : "string",
    "unitId" : 1,
    "visible" : true
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.17. Gets capacity list of the unit

GET /maxxton/v1/units/{unitId}/capacities
Description

Gets capacities associated with Unit, capacity specify the details about the number persons (Adult, Youngster, Baby etc.) or pets that can be accommodated in the unit. This endpoint provides capacities for a unit.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
capacityId:0,
managerId:0,
capacity:0,
subjectId:0,
startDate:String(date),
endDate:String(date))

Path

unitId
required

unitId to fetch capacities

integer (int64)

Query

returnWorkOrderUnits
optional

Work order type units or their capacities are not returned by default. To get work order type units, this request parameter can be used with true value

boolean
Responses
Code Description Schema

200

The request is completed successfully without any errors

< Capacity
> array

500

Error occurred while fetching capacities for unit.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/capacities
Example HTTP response
Response 200
[ {
  "capacity" : 1,
  "capacityId" : 1,
  "endDate" : "01-01-2023",
  "managerId" : 1,
  "name" : "string",
  "startDate" : "01-01-2023",
  "subjectId" : 1
} ]

5.45.18. Gets contracts to a particular unit id.

GET /maxxton/v1/units/{unitId}/contracts
Description

Gets a page with Contracts associated with Unit to a specific unit id. It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contractId:0,
code:String,
name:String,
ownerId:0,
unitId:0,
startDate:String(date),
endDate:String(date),
contractTypeId:0,
resourceId:0,
poolOwnerId:0,
origin:String,
originId:String,
rentAssurance:0.0,
contractRenewalReminder:String(date))

Path

unitId
required

unitId to fetch contracts.

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageContract

500

Error occurred while fetching contracts for unit.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/contracts
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "contractId" : 1,
    "contractRenewalReminder" : "01-01-2023",
    "contractTypeId" : 1,
    "endDate" : "01-01-2023",
    "name" : "string",
    "origin" : "string",
    "originId" : "string",
    "ownerId" : 1,
    "poolOwnerId" : 1,
    "rentAssurance" : 1,
    "resourceId" : 1,
    "startDate" : "01-01-2023",
    "targetAmount" : 1,
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.19. Gets dynamic fields for a particular unit

GET /maxxton/v1/units/{unitId}/dynamicfields
Description

Gets a page with dynamic fields to a specific unit. The records can be filtered based on the DynamicField object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fieldId:0,
code:String,
type:String)

Path

unitId
required

Unit id for which dynamic fieilds are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageDynamicField

500

Error occurred while fetching unit dynamic fields.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/dynamicfields
Example HTTP response
Response 200
{
  "content" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.20. Gets images for a particular unit

GET /maxxton/v1/units/{unitId}/images
Description

Gets a page with images to a specific uint. The records can be filtered based on the image object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileName:String,
imageId:0,
startDate:String(date),
endDate:String(date),
mimeType:String,
version:0,
url:String,
uploadDate:String(date),
imageType:String,
imageOrientation:String,
modifiedDate:String(date))

Path

unitId
required

unit id for which images are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImage

500

Error occurred while fetching unit images.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/images
Example HTTP response
Response 200
{
  "content" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.21. Gets unit implies for a unit id.

GET /maxxton/v1/units/{unitId}/implies
Description

Gets a page with unit implies for a specific unit id. The records can be filtered based on implies object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Path

unitId
required

unit id for which implies are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageImplies

500

Error occurred while fetching unit implies.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/implies
Example HTTP response
Response 200
{
  "content" : [ {
    "addToParent" : 1,
    "bookDateFrom" : "01-01-2023",
    "bookDateTo" : "01-01-2023",
    "countFromMin" : true,
    "ignoreRentability" : true,
    "implicationManagerId" : 1,
    "implied" : [ {
      "objectId" : 1,
      "resourceId" : 1
    } ],
    "impliesId" : 1,
    "implyOnce" : true,
    "included" : true,
    "onBill" : true,
    "parent" : true,
    "parentId" : 1,
    "priority" : 1,
    "quantityMax" : 1,
    "quantityMin" : 1,
    "removable" : true,
    "required" : true,
    "resourceId" : 1,
    "resourceIds" : [ "integer" ],
    "showOnAllInPriceBill" : true,
    "showPrice" : true,
    "stay" : true,
    "subjectsMax" : 1,
    "subjectsMin" : 1,
    "supplierImpliesId" : 1,
    "validFrom" : "01-01-2023",
    "validTo" : "01-01-2023"
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.22. Gets unit locks to a specific unit id.

GET /maxxton/v1/units/{unitId}/locks
Description

Gets a page with Unit locks specific to a particular unit id. The records can be filtered based on locks object.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reasonId:0,
detailDescription:String,
startDate:String(date),
endDate:String(date),
type:String,
unitId:0)

Path

unitId
required

Unit id for which locks are to be fetched

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

PageLock

500

Error occurred while fetching unit locks.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/locks
Example HTTP response
Response 200
{
  "content" : [ {
    "accoCreatedLock" : 1,
    "blockDate" : "01-01-2023",
    "clientId" : 1,
    "created" : "01-01-2023T11:23:45Z",
    "createdOn" : "01-01-2023T11:23:45Z",
    "detailDescription" : "string",
    "endDate" : "01-01-2023",
    "objectId" : 1,
    "reasonId" : 1,
    "resourceId" : 1,
    "resourceLockId" : 1,
    "resourceManagerId" : 1,
    "startDate" : "01-01-2023",
    "type" : "string",
    "unitId" : 1
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 1,
  "numberOfElements" : 1,
  "size" : 1,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 1,
  "totalPages" : 1
}

5.45.23. Gets units of resource

GET /maxxton/v1/units/{resourceId}/children
Description

Gets list of units of resource to a specific resource id.

Parameters
Type Name Description Schema

Path

resourceId
required

resource id to fetch all units of resource

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

< UnitDetail
> array

500

Error occurred while fetching resource units.

No Content
Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{resourceId}/children
Example HTTP response
Response 200
[ {
  "accommodationAddressManagerId" : 1,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "altContactPerson" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 1,
      "default" : true,
      "defaultLanguageId" : 1,
      "priority" : 1,
      "shortName" : "string",
      "translations" : [ {
        "i18nCountryId" : 1,
        "language" : "string",
        "languageId" : 1,
        "longName" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 1,
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityCategorySets" : [ {
    "categories" : [ {
      "amenities" : [ {
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "i18n" : [ { } ],
        "identifier" : "string",
        "imageManagerId" : 1,
        "images" : [ { } ],
        "managerId" : 1,
        "metricDetail" : { },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ { } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityCategoryId" : 1,
      "amenityGroups" : [ {
        "amenities" : [ { } ],
        "amenityId" : 1,
        "amenityLinkId" : 1,
        "archivedFrom" : "01-01-2023",
        "code" : "string",
        "endDate" : "01-01-2023",
        "identifier" : "string",
        "managerId" : 1,
        "metric" : { },
        "metricDetail" : { },
        "numberValue" : 1,
        "origin" : "string",
        "parentAmenityId" : 1,
        "preferenceExtraId" : 1,
        "startDate" : "01-01-2023",
        "textValue" : "string",
        "translations" : [ { } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "priority" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "archivedFrom" : "01-01-2023",
  "brandId" : 1,
  "capacities" : [ {
    "capacity" : 1,
    "capacityId" : 1,
    "endDate" : "01-01-2023",
    "managerId" : 1,
    "startDate" : "01-01-2023",
    "subject" : {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    },
    "subjectId" : 1
  } ],
  "capacityManagerId" : 1,
  "capacityRequirements" : [ {
    "managerId" : 1,
    "required" : 1,
    "subject" : [ {
      "controlAccess" : true,
      "endDate" : "01-01-2023",
      "i18n" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "includeInTotal" : true,
      "maxAge" : 1,
      "reportGroupSubjectId" : 1,
      "subjectCategoryId" : 1,
      "subjectId" : 1,
      "subjectOrder" : 1,
      "translations" : [ {
        "language" : "string",
        "languageId" : 1,
        "name" : "string",
        "shortDescription" : "string",
        "subjectId" : 1
      } ],
      "type" : "string"
    } ]
  } ],
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "doorLockTypes" : [ {
    "doorlockTypeId" : 1,
    "doorlocks" : [ {
      "bluetoothLowEnergy" : true,
      "doorLockCode" : "string"
    } ],
    "endDate" : "01-01-2023",
    "lockType" : "string",
    "startDate" : "01-01-2023"
  } ],
  "dynamicFields" : [ {
    "code" : "string",
    "eventmanagerId" : 1,
    "fieldId" : 1,
    "translations" : [ {
      "description" : "string",
      "fieldId" : 1,
      "i18nFieldId" : 1,
      "language" : "string",
      "languageId" : 1,
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "dynamicManagerId" : 1,
  "energyLabelRegistrationNumber" : "string",
  "excludeQuestionnaireStats" : true,
  "imageManagerId" : 1,
  "images" : [ {
    "endDate" : "01-01-2023",
    "fileName" : "string",
    "hostType" : "string",
    "imageId" : 1,
    "imageManagerId" : 1,
    "imageManagerIds" : [ "integer" ],
    "imageOrientation" : "string",
    "imageType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "01-01-2023T11:23:45Z",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "tags" : [ {
      "name" : "string",
      "tagId" : 1
    } ],
    "thumbnailUrl" : "string",
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "uploadDate" : "01-01-2023T11:23:45Z",
    "url" : "string",
    "version" : 1
  } ],
  "implicationManagerId" : 1,
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "path" : "string",
  "previousPmsId" : "string",
  "rentableUnitId" : 1,
  "resourceGroupId" : 1,
  "resourceId" : 1,
  "resourceManagerId" : 1,
  "roomCode" : "string",
  "roomManagerId" : 1,
  "rooms" : [ {
    "amenities" : [ {
      "amenityLinkId" : 1,
      "numberValue" : 1,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "name" : "string",
    "parentId" : 1,
    "roomId" : 1,
    "roomManagerId" : 1,
    "roomType" : {
      "code" : "string",
      "i18n" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ],
      "roomTypeId" : 1,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "languageId" : 1,
        "name" : "string"
      } ]
    },
    "roomTypeId" : 1,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "unitId" : 1
  } ],
  "type" : "string",
  "unitId" : 1,
  "videos" : [ {
    "endDate" : "01-01-2023",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaLanguageId" : 1,
    "mediaType" : "string",
    "sequenceNumber" : 1,
    "startDate" : "01-01-2023",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 1
  } ],
  "vsi" : 1
} ]

5.45.24. Removes lock for the provided unit Id.

DELETE /maxxton/v1/units/{unitId}/locks
Description

Removes lock for the provided unit Id. The lock is only released for the period specified in the start date and until the end date(included). In case this is within a bigger period two new locks are created to keep the rest of the locked period locked and only the specified period is released from the lock.

Parameters
Type Name Description Schema

Query

endDate
required

Lock end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

Path

unitId
required

id of the unit

integer (int64)

Query

startDate
required

Lock start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)
Responses
Code Description Schema

204

lock for given unit is deleted without any error.

No Content

404

No Lock Found for given startDate and endDate

No Content

500

Error occurred while deleting unit lock.

No Content
Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/locks
Example HTTP response

5.45.25. Search units based on provided criteria

POST /maxxton/v1/units/search
Description

The above endpoint is used to search through the availability of the whole inventory based on all unit ids, this can be filtered by providing request criteria. For example: arrival date, duration, resort, accommodation type, amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals, departures, resorts, units and amenities as per the criteria passed in the request. If "includeAllPrices" field is passed as true in the request, it will provide 10 records in the response, if it is provided as false, then only the first record is displayed in the response.
In case of prebooking, the prices returned would be null.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.
The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It’s up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. See below diagram for an explanation on how the alternative stays work:
DateMarginFlowDiagram role="text-center"

Parameters
Type Name Description Schema

Body

requestBody
required

UnitSearchRequestFilter

Query

sort
optional

Sort parameter is used to sort the response in ascending or descending order on the basis of offer price. In order to sort the response in ascending order 'offer_price_asc' is used and to sort in descending order the value of sort that should be passed is 'offer_price_desc'

string
Responses
Code Description Schema

200

The request is completed successfully without any errors

UnitAvailabilityResponse

400

  1. Either offerCode or voucherCode should be passed

  2. The dateMargin parameter cannot be used in combination with includeAllPrices parameter.

No Content

500

Error occurred while fetching accommodationTypes

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/search
Request body
{
  "accommodationKindIds" : [ "integer" ],
  "amenityIds" : [ "integer" ],
  "arrivalDate" : "01-01-2023",
  "dateMargin" : 1,
  "dateMarginMethod" : "string",
  "distributionChannelId" : 1,
  "duration" : 1,
  "filterOptions" : [ "string" ],
  "includeAllPrices" : true,
  "includeFilterOptionCounts" : true,
  "maxNrOfBathrooms" : 1,
  "maxNrOfBedrooms" : 1,
  "minNrOfBathrooms" : 1,
  "minNrOfBedrooms" : 1,
  "offerCode" : "string",
  "offerId" : 1,
  "petQuantity" : 1,
  "redeemableLoyaltyPoints" : 1,
  "regionId" : 1,
  "resortId" : 1,
  "resourceIds" : [ "integer" ],
  "subjects" : {
    "persons" : [ {
      "maxAge" : "string",
      "quantity" : 1
    } ]
  },
  "voucherCode" : "string"
}
Example HTTP response
Response 200
{
  "filterOptionsResult" : {
    "accommodationKinds" : [ "object" ],
    "amenities" : [ "object" ],
    "arrivals" : [ "string" ],
    "departures" : [ "string" ],
    "resorts" : [ "object" ]
  },
  "result" : {
    "content" : [ {
      "accommodationKindId" : 1,
      "arrivalDate" : "01-01-2023",
      "basePrice" : 1,
      "basePriceInclusive" : 1,
      "departureDate" : "01-01-2023",
      "duration" : 1,
      "freeLoyaltyDuration" : 1,
      "loyaltyPrice" : 1,
      "loyaltyPriceInclusive" : 1,
      "nrOfBathrooms" : 1,
      "nrOfBedrooms" : 1,
      "offerCode" : "string",
      "offerName" : "string",
      "offerPrice" : 1,
      "offerPriceInclusive" : 1,
      "priority" : 1,
      "rateTypeId" : 1,
      "requiredLoyaltyPoints" : 1,
      "resortId" : 1,
      "resourceId" : 1,
      "totalCapacity" : 1,
      "unitId" : 1,
      "unitRating" : 1
    } ],
    "empty" : true,
    "first" : true,
    "last" : true,
    "number" : 1,
    "numberOfElements" : 1,
    "size" : 1,
    "sort" : {
      "empty" : true,
      "sorted" : true,
      "unsorted" : true
    },
    "totalElements" : 1,
    "totalPages" : 1
  }
}

5.45.26. Update/insert unit’s dynamic field

PUT /maxxton/v1/units/{unitId}/dynamicfields/{fieldId}
Description

The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for unit, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the unit, then the text field will be modified

Parameters
Type Name Description Schema

Body

requestBody
required

< DynamicFieldDataCriteria
> array

Path

unitId
required

unitId to fetch unit

integer (int64)

Path

fieldId
required

fieldId to fetch dynamic field

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while fetching updating/inserting the unit dynamic fields.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/dynamicfields/{fieldId}
Request body
[ {
  "language" : "string",
  "text" : "string"
} ]
Example HTTP response

5.45.27. Updates a single unit

PUT /maxxton/v1/units/{unitId}
Description

Updates a single unit

Parameters
Type Name Description Schema

Body

requestBody
required

Request body to update the unit

UpdateUnitRequest

Path

unitId
required

Unit id of the unit

integer (int64)
Responses
Code Description Schema

204

The request is completed successfully without any errors

No Content

500

Error occurred while updating the unit.

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}
Request body
{
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 1,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "dateBegin" : "01-01-2023",
    "dateEnd" : "01-01-2023",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 1,
    "longitude" : 1,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 1,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "cleaningStatus" : "string",
  "code" : "string",
  "nrOfBathrooms" : 1,
  "nrOfBedrooms" : 1,
  "origin" : "string",
  "originId" : "string",
  "rentableUnitId" : 1,
  "resourceId" : 1,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string",
    "shortDescription" : "string",
    "unitId" : 1
  } ]
}
Example HTTP response

5.45.28. Updates details of existing amenity link.

PUT /maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Description

Updates details of existing amenity link.

Parameters
Type Name Description Schema

Body

requestBody
required

Request body to update the start and end date of the amenity link.

UpdateUnitAmenitylinkRequest

Path

unitId
required

integer (int64)

Path

amenitylinkId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed without any error.

AmenityDetail_Basic

500

Error occurred while creating new unit link with amenity.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Request body
{
  "endDate" : "01-01-2023",
  "startDate" : "01-01-2023"
}
Example HTTP response
Response 200
{
  "amenityId" : 1,
  "amenityLinkId" : 1,
  "archivedFrom" : "01-01-2023",
  "categories" : [ {
    "amenityCategoryId" : 1,
    "code" : "string",
    "i18n" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "isInternalUse" : true,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  } ],
  "endDate" : "01-01-2023",
  "identifier" : "string",
  "metric" : {
    "code" : "string",
    "i18n" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ],
    "metricId" : 1,
    "translations" : [ {
      "language" : "string",
      "languageId" : 1,
      "name" : "string"
    } ]
  },
  "numberValue" : 1,
  "origin" : "string",
  "parentAmenityId" : 1,
  "preferenceExtraId" : 1,
  "startDate" : "01-01-2023",
  "textValue" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "type" : "string",
  "visible" : true
}

5.45.29. Updates details of existing image.

PUT /maxxton/v1/units/{unitId}/images/{imageId}
Description

Updates details of existing image.

Parameters
Type Name Description Schema

Path

imageId
required

imageId id of the image to be updated

integer (int64)

Body

requestBody
required

UpdateImageRequest

Path

unitId
required

unitId id of the Unit

integer (int64)
Responses
Code Description Schema

200

Image is updated without any error.

Image

500

Error occurred while updating image.

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/images/{imageId}
Request body
{
  "endDate" : "01-01-2023",
  "imageOrientation" : "string",
  "imageType" : "string",
  "sequenceNumber" : 1,
  "startDate" : "01-01-2023",
  "tags" : [ {
    "name" : "string",
    "tagId" : 1
  } ],
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "version" : 1
}
Example HTTP response
Response 200
{
  "endDate" : "01-01-2023",
  "fileName" : "string",
  "hostType" : "string",
  "imageId" : 1,
  "imageManagerId" : 1,
  "imageManagerIds" : [ "integer" ],
  "imageOrientation" : "string",
  "imageType" : "string",
  "isActive" : true,
  "isUploaded" : true,
  "isWebPresentation" : true,
  "mediaLanguageId" : 1,
  "mediaType" : "string",
  "mimeType" : "string",
  "modifiedDate" : "01-01-2023T11:23:45Z",
  "sequenceNumber" : 1,
  "startDate" : "01-01-2023",
  "tags" : [ {
    "name" : "string",
    "tagId" : 1
  } ],
  "thumbnailUrl" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "uploadDate" : "01-01-2023T11:23:45Z",
  "url" : "string",
  "version" : 1
}

5.45.30. Upload Image for a particular unit.

POST /maxxton/v1/units/{unitId}/images/upload
Description

Send an image as content-type:multipart to the endpoint. This will upload the image to the Maxxton CDN and link it to the unit from the request. After this, you will get the image Id and information in the response. To update other details for the image use the imageId from the response and update it using the PUT /units/{unitId}/images/{imageId}

Parameters
Type Name Description Schema

Body

requestBody
required

object

Path

unitId
required

integer (int64)
Responses
Code Description Schema

200

The request is completed successfully without any errors

Image

500

Error occurred while uploading unit.

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name

oauth2

oAuth2
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/images/upload
Example HTTP response
Response 200
{
  "endDate" : "01-01-2023",
  "fileName" : "string",
  "hostType" : "string",
  "imageId" : 1,
  "imageManagerId" : 1,
  "imageManagerIds" : [ "integer" ],
  "imageOrientation" : "string",
  "imageType" : "string",
  "isActive" : true,
  "isUploaded" : true,
  "isWebPresentation" : true,
  "mediaLanguageId" : 1,
  "mediaType" : "string",
  "mimeType" : "string",
  "modifiedDate" : "01-01-2023T11:23:45Z",
  "sequenceNumber" : 1,
  "startDate" : "01-01-2023",
  "tags" : [ {
    "name" : "string",
    "tagId" : 1
  } ],
  "thumbnailUrl" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "languageId" : 1,
    "name" : "string"
  } ],
  "uploadDate" : "01-01-2023T11:23:45Z",
  "url" : "string",
  "version" : 1
}

6. Definitions

6.1. AccommodationKind

Properties
Name Description Schema

accommodationkindId
optional

unique id associated with each accommodationKind

integer (int64)

name
optional

name associated with each accommodationKind

string

isWorkOrderObject
optional

Write only (field is only accessible in the request body)

boolean

translations
optional

information of the accommodation kind which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAccommodationKind
> array

code
optional

unique code associated with each accommodationKind

string

6.2. AccommodationKindDetail

Properties
Name Description Schema

accommodationkindId
optional

unique id associated with each accommodationKind

integer (int64)

code
optional

unique code associated with each accommodationKind

string

priority
optional

it defines acoommodation kind priority

integer (int32)

translations
optional

information of the accommodation kind which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAccommodationKind
> array

excludeFromReporting
optional

It specifies if the accommodation types linked to the corresponding accommodation kind is excluded or not from the statistical/reporting data.

boolean

workOrderUnits
optional

boolean

archivedFrom
optional

string (date)

6.3. AccommodationType

Properties
Name Description Schema

resourceId
optional

unique id associated with each accommodationtype

integer (int64)

resourceManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

ledgerGroupId
optional

integer (int64)

type
optional

type of the resource i.e ACCOMMODATIONTYPE

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

code
optional

unique code associated with each accommodationtype

string

resortId
optional

unique id associated with each resort to which the accommodationtype belong

integer (int64)

parentId
optional

if the accommodationtype is child to another accommodationtype then the id of the parent accommodationtype is displayed in response

integer (int64)

path
optional

the field denotes where the accommodationtype is located

string

hasObjects
optional

if an accommodation is to be created having some predefined units then hasObjects check-box is checked and the value is true else the value is false.

boolean

dependsOnLedgerGroup
optional

if the accommodationtype ledger depends on a ledger group then the field is true else false

boolean

priority
optional

the sequence in which the accommodationtype will be visible to the user

integer (int32)

numberOfPersons
optional

total number of persons which an accommodationtype can accommodate

integer (int32)

nrOfBedrooms
optional

number of bedrooms that an accommodationtype possess

number (double)

nrOfBathrooms
optional

number of bathrooms that an accommodationtype can possess

number (double)

accotypeKindId
optional

unique id associated with each kind of accommodationtype

integer (int64)

supplierOrigin
optional

If the accommodationtype is consuming units from supplier then the name of the supplier is displayed

deprecated

string

translations
optional

information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nResource
> array

accotypeAddressmanagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

cashflowManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

brandId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

Write only (field is only accessible in the request body)

string

shortDescription
optional

Write only (field is only accessible in the request body)

string

description
optional

Write only (field is only accessible in the request body)

string

realRentabilityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

address
optional

Address

capacityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

amenityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

archivedFrom
optional

date from which the accommodationtype was archived. The accommodationtypes will not be displayed if the accommodationtype is archived. Thus for all accommodationtypes which are being displayed the value will be null.The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

ledgerId
optional

integer (int64)

brand
optional

label associated with the accommodationtype by which an accommodationtype can be sold out. It can vary from website to website for same accommodationtype.

string

origin
optional

string

originId
optional

string

powerplayGroupId
optional

integer (int64)

groupId
optional

integer (int64)

qualityLevelId
optional

integer (int64)

previousPmsId
optional

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

string

accotypeDoorlock
optional

Number cards/keys for accommodation

integer (int64)

accotypeBarrier
optional

Number of access cards for entry barrier at a location

integer (int64)

i18n
optional

Write only (field is only accessible in the request body)

< I18nResource
> array

accommodationTypeKindCode
optional

unique code associated with each accommodationkind

string

6.4. AccommodationTypeAddon

Properties
Name Description Schema

resourceId
optional

integer (int64)

resortId
optional

integer (int64)

bookDateFrom
optional

string (date)

bookDateTo
optional

string (date)

translations
optional

< I18nAddon
> array

arrivalDateFrom
optional

string (date)

arrivalDateTo
optional

string (date)

prices
optional

< AddonPrice
> array

minQuantity
optional

Minimum quantity of the add-on that needs to be available in the reservation

integer (int64)

maxQuantity
optional

Maximum quantity of the add-on that needs to be available in the reservation

integer (int64)

6.5. AccommodationTypeAmenityLink

Properties
Name Description Schema

amenityLinkId
optional

unique id associated which tells the amenity is linked to a resource

integer (int64)

type
optional

type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

visible
optional

if the amenity linked should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

startDate
optional

date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

amenityId
optional

unique id associated with each amenity

integer (int64)

code
optional

unique code associated with each amenity

string

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

accommodationTypeId
optional

unique id associated with each accommodationtype

integer (int64)

6.6. AccommodationTypeCostPrice

Properties
Name Description Schema

costPriceId
optional

unique id associated with CostPrice

integer (int64)

resourceId
optional

unique code associated with resource

integer (int64)

arrivalDateFrom
optional

start of period within a period of the reservation(between and including arrival and departure date)

string (date)

arrivalDateTo
optional

end of period within a period of the reservation(between and including arrival and departure date)

string (date)

bookDateFrom
optional

the date from which cost price will be valid

string (date-time)

bookDateTo
optional

the date till which CostPrice will be valid

string (date-time)

duration
optional

specifies the duration for which cost price can be applied

integer (int64)

minDuration
optional

minimum number of days CostPrice will be valid

integer (int64)

maxDuration
optional

maximum number of days CostPrice will be valid

integer (int64)

value
optional

value of the CostPrice

number (double)

currencyId
optional

unique id associated with currency

integer (int64)

valueType
optional

value types of rate

string

usageDowList
optional

the days of the week on which CostPrices can be applied

< string > array

currencyCode
optional

unique code associated with currency

string

6.7. AccommodationTypeDetail

Properties
Name Description Schema

resourceId
optional

unique id associated with each accommodationtype

integer (int64)

code
optional

unique code associated with each accommodationtype

string

ledgerGroupId
optional

integer (int64)

resortId
optional

unique id associated with each resort to which the accommodationtype belong

integer (int64)

brandId
optional

unique id associated with each brand

integer (int64)

priority
optional

the sequence in which the accommodationtype will be visible to the user

integer (int32)

nrOfBedrooms
optional

number of bedrooms that an accommodationtype possess

number (double)

nrOfBathrooms
optional

number of bathrooms that an accommodationtype can possess

number (double)

hasObjects
optional

if an accommodation is to be created having some predefined units then hasObjects check-box is checked and the value is true else the value is false.

boolean

path
optional

the field denotes where the accommodationtype is located

string

checkinTime
optional

LocalTime

checkoutTime
optional

LocalTime

lateCheckoutTime
optional

LocalTime

earlyCheckinTime
optional

LocalTime

translations
optional

information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nResource
> array

dynamicFields
optional

user-defined and customized fields

< DynamicField
> array

address
optional

Address

images
optional

details of the images associated to the accommodationtype

< Image
> array

videos
optional

details associated with videos related to the accommodationtype

< Video
> array

amenityCategorySets
optional

group of amenity categories

< AmenityCategorySetDetail
> array

capacities
optional

The maximum number of subjects for which the accommodation can be booked including all the younger subjects than adult for e.g Child and Infant

< CapacityDetail
> array

capacityRequirements
optional

The minimum number of subjects which are mandatory for making a reservation. If requirement of 4 adults is configured then 4 adults are mandatory for making a reservation

< Requirement
> array

rooms
optional

different part of units in an accommodation are considered as rooms ex: bedrooms, living rooms etc

< Room
> array

accommodationKind
optional

AccommodationKind

brand
optional

label associated with the accommodationtype by which an accommodationtype can be sold out. It can vary from website to website for same accommodationtype.

string

archivedFrom
optional

date from which the accommodationtype was archived. The accommodationtypes will not be displayed if the accommodationtype is archived. Thus for all accommodationtypes which are being displayed the value will be null. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

ledgerId
optional

integer (int64)

parentId
optional

integer (int64)

numberOfPersons
optional

integer (int32)

accotypeKindId
optional

integer (int64)

origin
optional

string

originId
optional

string

powerplayGroupId
optional

integer (int64)

resourcegroupId
optional

Write only (field is only accessible in the request body)

integer (int64)

resourceGroup
optional

ResourceGroup

qualityLevelId
optional

integer (int64)

previousPmsId
optional

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

string

accotypeDoorlock
optional

Number cards/keys for accommodation

integer (int64)

accotypeBarrier
optional

Number of access cards for entry barrier at a location

integer (int64)

i18n
optional

Write only (field is only accessible in the request body)

< I18nResource
> array

accommodationTypeKindCode
optional

unique code associated with each accommodationtypekind

string

6.8. AccommodationTypeImply

Properties
Name Description Schema

resourceId
optional

integer (int64)

resortId
optional

integer (int64)

bookDateFrom
optional

string (date)

bookDateTo
optional

string (date)

translations
optional

< I18nImply
> array

arrivalDateFrom
optional

string (date)

arrivalDateTo
optional

string (date)

required
optional

boolean

prices
optional

< ImplyPrice
> array

stayDate
optional

Mandatory stay dates for the applicable rates

< string > array

minQuantity
optional

Minimum quantity of the mandatory add-on that needs to be available in the reservation

integer (int64)

maxQuantity
optional

Maximum quantity of the mandatory add-on that can be available in the reservation

integer (int64)

subjectsMin
optional

Linked mandatory add-on is applicable for specific subjects(specified in prices → subjectIds field) and/or should be added in the reservation only for a minimum subject quantity specified here.

integer (int64)

subjectsMax
optional

Linked mandatory add-on is applicable for specific subjects(specified in prices → subjectIds field) and/or should be added in the reservation only for a maximum subject quantity specified here.

integer (int64)

included
optional

Mandatory add-on can be marked as included/not included in bill. If marked as 'included in bill' then guests are not charged for the add-on separately

boolean

addToParent
optional

If the value is true, the price will be added to the accommodation type base price and will not be shown separately.In case the value is false the price will be shown separately on the bill and not be part of the accommodation type base price.

boolean

6.9. AccommodationTypePreference

Properties
Name Description Schema

resourceId
optional

Id of preference addon.

integer (int64)

resortId
optional

integer (int64)

preferenceTypes
optional

List of preference type this addon applies to. Possible values: UNIT,ADJACENT,MISCELLANEOUS

< string > array

prices
optional

< PreferencePrice
> array

6.10. AccommodationTypePriority

Properties
Name Description Schema

accommodationtypePriorityId
optional

integer (int64)

resourceId
optional

integer (int64)

fiscalYear
optional

FiscalYearResponse

fiscalyearId
optional

Write only (field is only accessible in the request body)

integer (int64)

reservationFrom
optional

string (date)

reservationTo
optional

string (date)

useContractPriority
optional

boolean

useVsi
optional

boolean

useOccupation
optional

boolean

useTargetAmount
optional

boolean

usePlanboardFitting
optional

boolean

useQuestionnaire
optional

boolean

prioritySequence
optional

string

6.11. AccommodationTypeRangeSearchFilterOption

Properties
Name Description Schema

arrivals
optional

unique items

< string > array

departures
optional

unique items

< string > array

qualityLevels
optional

quality level ids on which user can filter data

unique items

< integer > array

6.12. AccommodationTypeRelease

Properties
Name Description Schema

releaseId
optional

integer (int64)

maxArrivalDate
optional

string (date)

minArrivalDate
optional

string (date)

releasedDays
optional

integer (int64)

status
optional

enum (CLOSED,OPEN_TEST,OPEN_OWNER,OPEN)

resourceId
optional

integer (int64)

createdDate
optional

string (date-time)

modifiedDate
optional

string (date-time)

6.13. AccommodationTypeSearchFilterOption

Properties
Name Description Schema

arrivals
optional

unique items

< string > array

departures
optional

unique items

< string > array

resorts
optional

If includeFilterOptionCounts is "true" in request body, then all the available resortIds and their respective counts as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the resortIds are displayed in response.

unique items

< object > array

amenities
optional

If includeFilterOptionCounts is "true" in request body, then all the available amenities and their respective counts(No of accommodations in which that amenity is available) as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the amenityIds are displayed in response.

unique items

< object > array

accommodationKinds
optional

accommodationkind ids on which user can filter data

unique items

< object > array

qualityLevels
optional

quality level ids on which user can filter data

unique items

< integer > array

6.14. Account

Properties
Name Description Schema

accountId
optional

integer (int64)

name
optional

string

currencyId
optional

integer (int64)

currencyCode
optional

string

bankAccount
optional

BankAccount

6.15. AccountCurrency

Properties
Name Description Schema

debitVatIncluded
optional

number

debitVatExcluded
optional

number

creditVatExcluded
optional

number

getcreditVatIncluded
optional

number

currencyId
optional

integer (int64)

currencyCode
optional

string

exchangeRate
optional

integer (int64)

6.16. AddOn_Detail

Properties
Name Description Schema

resourceId
optional

integer (int64)

code
optional

string

resortId
optional

integer (int64)

parentId
optional

integer (int64)

path
optional

string

cashflowManagerId
optional

integer (int64)

allowPriceOverride
optional

boolean

addonType
optional

string

translations
optional

< I18nResource_Detail
> array

source
optional

string

showNilPriceOnBill
optional

boolean

powerplaygroupId
optional

integer (int64)

allowMovingToMainBill
optional

boolean

archivedFrom
optional

string (date)

searchCode
optional

string

excludePriceCache
optional

boolean

specialPriority
optional

integer (int32)

name
optional

Write only (field is only accessible in the request body)

string

shortDescription
optional

Write only (field is only accessible in the request body)

string

description
optional

Write only (field is only accessible in the request body)

string

autoValidateValue
optional

Write only (field is only accessible in the request body)

integer (int32)

type
optional

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

resortArticle
optional

If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately.

boolean

stayArticle
optional

boolean

reservationArticle
optional

boolean

cashArticle
optional

boolean

ownerArticle
optional

boolean

invoiceArticle
optional

boolean

perDay
optional

boolean

customizable
optional

boolean

stockType
optional

string

dayAddon
optional

boolean

withholdingArticle
optional

boolean

warrant
optional

boolean

correction
optional

boolean

commission
optional

boolean

vatCommission
optional

boolean

cancelPremium
optional

boolean

cancelCompensation
optional

boolean

adjustment
optional

boolean

repaymentVoucher
optional

boolean

earlyCheckin
optional

boolean

showDatesOnInternet
optional

boolean

allowToAddInCiCo
optional

boolean

tax
optional

boolean

maxQuantity
optional

integer (int64)

commissionVatIncluded
optional

boolean

implicationManagerId
optional

integer (int64)

ledgerId
optional

integer (int64)

ledgerGroupId
optional

integer (int64)

dependsOnLedgerGroup
optional

boolean

dependencyMask
optional

enum (NONE,ARRIVAL,DEPARTURE,ARRIVAL_DEPARTURE)

i18n
optional

Write only (field is only accessible in the request body)

< I18nResource_Detail
> array

autoValidate
optional

boolean

6.17. Addition

Properties
Name Description Schema

resourceId
optional

integer (int64)

type
optional

enum (PRODUCTTYPE,RESOURCEACTIVITY,ACTIVITY,ACCOMMODATIONTYPE,EXTRA,SPECIAL,COMPOSITION)

name
optional

string

shortDescription
optional

string

description
optional

string

price
optional

number (double)

minQuantity
optional

integer (int32)

maxQuantity
optional

integer (int32)

completed
optional

Write only (field is only accessible in the request body)

boolean

code
optional

Write only (field is only accessible in the request body)

string

supplierId
optional

Write only (field is only accessible in the request body)

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

addonType
optional

string

allowPriceOverride
optional

Write only (field is only accessible in the request body)

boolean

resortArticle
optional

If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately.

boolean

6.18. AdditionAccommodationType

Properties
Name Description Schema

arrivalDate
required

string (date)

duration
required

integer (int32)

rateTypeId
optional

integer (int64)

resourceId
required

integer (int64)

unitId
optional

integer (int64)

subjects
required

ReservationProposalSubjectCriteria

6.19. AdditionRequest

Properties
Name Description Schema

resourceId
required

integer (int64)

startDate
required

string (date)

endDate
required

string (date)

quantity
required

integer (int32)

memo
optional

Maximum Length: 500
Minimum Length: 0

string

name
optional

string

price
optional

number (double)

6.20. AddonPrice

Properties
Name Description Schema

price
optional

Single value rate and qrv resourcebase rate

number (double)

priceArrivalDateFrom
optional

string (date)

priceArrivalDateTo
optional

string (date)

perDay
optional

string

duration
optional

Number of minutes in a day times the applicable duration of the rate, that is weekly or nightly or per booking or custom.

integer (int32)

daysOfWeek
optional

Denotes the days of week. Calculated as Sum of 2^N where N is 0 = Monday, 1 = Tuesday, …​ , 6 = Sunday

< string > array

minQuantity
optional

Deprecated. not part of addon price

deprecated

integer (int64)

maxQuantity
optional

Deprecated. not part of addon price

deprecated

integer (int64)

subjectIds
optional

deprecated
unique items

< integer > array

dependsOnOffer
optional

Flag to indicate if the price depend on offers

boolean

offerIds
optional

Offer ids of offers on which the addon price depends on

< integer > array

dependsOnAddon
optional

Flag to indicate if the price depend on addons

boolean

addonIds
optional

Addon ids of addons on which the addon price depends on

< integer > array

dependsOnAccommodationtypes
optional

Depends on accommodationtype provided in request

boolean

percentagePrice
optional

Show if the price is a flat value or a percentage

boolean

subjectPrices
optional

Subject based rates for groups of persons

< SubjectPrice
> array

appliedPerSubject
optional

boolean

6.21. Address

details of the visit address of the user

Properties
Name Description Schema

addressId
optional

unique id associated with each address

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

address1
optional

the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address2
optional

the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address3
optional

the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

boxNumber
optional

number used as an address

string

houseNumberSuffix
optional

a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

zipCode
optional

zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBox
optional

numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxZipcode
optional

zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxCity
optional

city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

city
optional

city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

countryId
optional

unique id associated with each country

integer (int64)

municipality
optional

name of the general-purpose administrative subdivision

string

mobilePhone2
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

latitude
optional

latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

longitude
optional

longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

email
optional

email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

stateId
optional

unique id associated with each state

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

mobilePhone
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

houseNumber
optional

house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

district
optional

district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

privatePhone
optional

the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

workPhone
optional

the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

exposeLocation
optional

if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false

boolean

dateEnd
optional

date when the accommodationtype/resort/unit is archived

string (date)

dateBegin
optional

date on which the accommodationtype/resort/unit was created

string (date)

fax
optional

fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateContactPerson
optional

name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

accuracy
optional

Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE

enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE)

country
optional

Country

altContactPerson
optional

Write only (field is only accessible in the request body)

string

6.22. AddressUpdate

Properties
Name Description Schema

email
optional

string

address1
optional

string

address2
optional

string

address3
optional

string

city
optional

string

countryCode
optional

string

district
optional

string

houseNumber
optional

string

houseNumberSuffix
optional

string

mobilePhone
optional

string

mobilePhone2
optional

string

poBox
optional

string

poBoxCity
optional

string

poBoxZipcode
optional

string

privatePhone
optional

string

workPhone
optional

string

zipCode
optional

string

stateId
optional

integer (int64)

boxNumber
optional

string

municipality
optional

string

latitude
optional

number (double)

longitude
optional

number (double)

6.23. Address_Id

details of the address where the unit is located

Properties
Name Description Schema

addressId
optional

unique id associated with each address

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

address1
optional

the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address2
optional

the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address3
optional

the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

boxNumber
optional

number used as an address

string

houseNumberSuffix
optional

a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

zipCode
optional

zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBox
optional

numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxZipcode
optional

zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxCity
optional

city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

city
optional

city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

countryId
optional

unique id associated with each country

integer (int64)

municipality
optional

name of the general-purpose administrative subdivision

string

mobilePhone2
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

latitude
optional

latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

longitude
optional

longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

email
optional

email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

stateId
optional

unique id associated with each state

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

mobilePhone
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

houseNumber
optional

house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

district
optional

district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

privatePhone
optional

the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

workPhone
optional

the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

exposeLocation
optional

if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false

boolean

dateEnd
optional

date when the accommodationtype/resort/unit is archived

string (date)

dateBegin
optional

date on which the accommodationtype/resort/unit was created

string (date)

fax
optional

fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateContactPerson
optional

name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

accuracy
optional

Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE

enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE)

country
optional

Country_Id

altContactPerson
optional

Write only (field is only accessible in the request body)

string

6.24. AdminOrganisation

Properties
Name Description Schema

adminOrganisationId
optional

integer (int64)

name
optional

string

description
optional

string

code
optional

string

currencyId
optional

integer (int64)

currencyCode
optional

string

origin
optional

string

originId
optional

string

journalId
optional

integer (int64)

6.25. AdminOrganisationCurrency

Properties
Name Description Schema

debitVatIncluded
optional

number

debitVatExcluded
optional

number

creditVatExcluded
optional

number

creditVatIncluded
optional

number

currencyId
optional

integer (int64)

currencyCode
optional

string

6.26. Allotment

Properties
Name Description Schema

allotmentId
optional

integer (int64)

distributionChannelId
optional

integer (int64)

resourceId
optional

integer (int64)

name
optional

string

description
optional

string

type
optional

string

exceedLimit
optional

integer (int64)

expirePeriod
optional

integer (int64)

hasObjects
optional

boolean

amount
optional

integer (int64)

modified
optional

string (date)

isEnactive
optional

boolean

periods
optional

< AllotmentPeriod
> array

6.27. AllotmentPeriod

Properties
Name Description Schema

unitIds
optional

unique items

< integer > array

startDate
optional

string (date)

endDate
optional

string (date)

quantity
optional

integer (int64)

6.28. AllotmentRelease

Properties
Name Description Schema

allotmentReleaseId
optional

integer (int64)

distributionChannelId
optional

integer (int64)

name
optional

string

startDate
optional

string (date)

endDate
optional

string (date)

releasePeriod
optional

integer (int64)

releaseDate
optional

string (date)

performedDate
optional

string (date)

resourceId
optional

integer (int64)

resortId
optional

integer (int64)

isEnactive
optional

boolean

6.29. Amenity

Properties
Name Description Schema

amenityId
optional

integer (int64)

type
optional

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

metricDetail
optional

Metric

identifier
optional

string

listMulti
optional

boolean

numberMinimum
optional

integer (int64)

numberMaximum
optional

integer (int64)

percentageDiscountPriority
optional

integer (int64)

source
optional

string

standardCodeAmenityId
optional

integer (int64)

linkedAmenityId
optional

integer (int64)

parentAmenityId
optional

integer (int64)

archivedFrom
optional

string (date)

endDate
optional

Write only (field is only accessible in the request body)

string (date)

translations
optional

< I18nAmenity
> array

amenityCategoryIds
optional

Write only (field is only accessible in the request body)

< integer > array

categories
optional

< AmenityCategory
> array

metric
optional

Metric

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenity
> array

6.30. AmenityCategory

details related to group of amenities

Properties
Name Description Schema

amenityCategoryId
optional

Write only (field is only accessible in the request body)

integer (int64)

code
optional

unique code associated with each group of amenities

string

translations
optional

information of the group of amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenityCategory
> array

isInternalUse
optional

Write only (field is only accessible in the request body)

boolean

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenityCategory
> array

6.31. AmenityCategorySetDetail

details related to group of amenity categories

Properties
Name Description Schema

code
optional

unique code associated with each amenity category group

string

translations
optional

information of the set of amenity categories available in the unit which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenityCategory
> array

categories
optional

details related to group of amenities

< CategoryDetail
> array

6.32. AmenityCategory_Basic

details related to group of amenities

Properties
Name Description Schema

amenityCategoryId
optional

Write only (field is only accessible in the request body)

integer (int64)

code
optional

unique code associated with each group of amenities

string

translations
optional

information of the group of amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenityCategory_Basic
> array

isInternalUse
optional

Write only (field is only accessible in the request body)

boolean

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenityCategory_Basic
> array

6.33. AmenityDetail_Basic

Properties
Name Description Schema

amenityLinkId
optional

unique id associated with each amenity link

integer (int64)

amenityId
optional

unique id associated with each amenity

integer (int64)

endDate
optional

date till which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

startDate
optional

date from which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

visible
optional

if the amenity should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

origin
optional

the field tells if the amenity is of the resource itself or is inherited from the parent resource. Possible values can be: SELF, PARENT, CHILD

enum (SELF,PARENT,CHILD)

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity_Basic
> array

type
optional

type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

archivedFrom
optional

date from which the amenity was archived. The amenities will not be displayed if the amenity is archived. Thus for all amenities which are being displayed the value will be null.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

identifier
optional

value of the identifier associated with an amenity linked

string

metric
optional

Metric_Basic

parentAmenityId
optional

if the amenity has a parent then the id of the parent amenity is displayed in this field

integer (int64)

categories
optional

details related to group of amenities

< AmenityCategory_Basic
> array

6.34. AmenityGroupLinkDetail

desirable or accessible properties that a customer can possess in the resource. The value that will be encountered is GROUP

Properties
Name Description Schema

amenityLinkId
optional

unique id associated, which tells the amenity is linked to a resource

integer (int64)

amenityId
optional

unique id associated with each amenity

integer (int64)

endDate
optional

date till which the amenity is accessible.Date format will be displayed and added using ISO 8601 standard(yyyy-MM-dd)

string (date)

startDate
optional

date from which the amenity can be accessed.Date format will be displayed and added using ISO 8601 standard(yyyy-MM-dd)

string (date)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

visible
optional

if the amenity should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

origin
optional

the field tells if the amenity is of the resource itself or is inherited from the parent resource. Possible values can be:SELF,PARENT,CHILD

enum (SELF,PARENT,CHILD)

translations
optional

information of the amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

managerId
optional

Write only (field is only accessible in the request body)

integer (int64)

metricDetail
optional

Metric

type
optional

type of the amenity. Possible values can be : GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

parentAmenityId
optional

if the amenity has a parent then the id of the parent amenity is displayed in this field

integer (int64)

code
optional

unique code associated with each amenity

string

archivedFrom
optional

date from which the amenity was archived. The amenities will not be displayed if the amenity is archived. Thus for all amenities which are being displayed the value will be null.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

amenities
optional

desirable or accessible properties that a customer can possess in the resource.These are child amenities. Possible values encountered: Simple,Text, Number

< AmenityLinkDetail
> array

metric
optional

Metric

identifier
optional

Write only (field is only accessible in the request body)

string

6.35. AmenityLink

Properties
Name Description Schema

amenityLinkId
optional

unique id associated which tells the amenity is linked to a resource

integer (int64)

type
optional

type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

visible
optional

if the amenity linked should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

startDate
optional

date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

amenityId
optional

unique id associated with each amenity

integer (int64)

code
optional

unique code associated with each amenity

string

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

6.36. AmenityLinkDetail

desirable or accessible properties that a customer can possess in the resource.These are child amenities. Possible values encountered: Simple,Text, Number

Properties
Name Description Schema

amenityLinkId
optional

unique id associated which tells the amenity is linked to a resource

integer (int64)

amenityId
optional

unique id associated with each amenity

integer (int64)

endDate
optional

date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

startDate
optional

date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

visible
optional

if the amenity should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

origin
optional

the field tells if the amenity is of the resource itself or is inherited from the parent resource. Possible values can be: SELF, PARENT, CHILD

enum (SELF,PARENT,CHILD)

managerId
optional

Write only (field is only accessible in the request body)

integer (int64)

metricDetail
optional

Metric

type
optional

type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

parentAmenityId
optional

if the amenity has a parent then the id of the parent amenity is displayed in this field

integer (int64)

code
optional

unique code associated with each amenity

string

archivedFrom
optional

date from which the amenity was archived. The amenities will not be displayed if the amenity is archived. Thus for all amenities which are being displayed the value will be null.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

images
optional

< Image
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenity
> array

identifier
optional

Write only (field is only accessible in the request body)

string

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

6.37. AmenityResponse

Properties
Name Description Schema

amenityId
optional

integer (int64)

code
optional

string

type
optional

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

numberMinimum
optional

integer (int64)

numberMaximum
optional

integer (int64)

linkedAmenityId
optional

integer (int64)

translations
optional

< I18nAmenity
> array

amenityCategoryIds
optional

< integer > array

childAmenityIds
optional

< integer > array

amenityStandardCode
optional

string

origin
optional

string

originId
optional

string

6.38. AmenityTreeDetail

Properties
Name Description Schema

amenityCategorySetId
optional

integer (int64)

code
optional

string

priority
optional

integer (int64)

translations
optional

< I18nAmenityCategory
> array

parentId
optional

Write only (field is only accessible in the request body)

integer (int64)

isInternalUse
optional

Write only (field is only accessible in the request body)

boolean

amenityCategories
optional

< CategoryDetail
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenityCategory
> array

6.39. Area

Properties
Name Description Schema

areaId
optional

integer (int64)

translations
optional

< I18nArea
> array

i18nArea
optional

Write only (field is only accessible in the request body)

< I18nArea
> array

6.40. AuthorizationResponse

Properties
Name Description Schema

scope
optional

string

details
optional

object

jti
optional

string

access_token
optional

string

token_type
optional

string

expires_in
optional

integer (int64)

6.41. AvailabilityResult

Properties
Name Description Schema

resourceId
optional

The unique id of the accommodationtype

integer (int64)

resortId
optional

The unique id associated with the resort to which the accommodationtype belong

integer (int64)

accommodationKindId
optional

The accommodation Kind id associated with each accommodationtype

integer (int64)

arrivalDate
optional

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

departureDate
optional

The date on which customer/guest will leave. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

offerCode
optional

Basis accommodationtype rent price without any additional costs or addons included

string

offerName
optional

The name of the offer

string

basePrice
optional

Basis accommodationtype rent price without any additional costs or addons included

number (double)

basePriceInclusive
optional

Basis accommodationtype rent price including mandatory additional costs configured as internet additional cost

number (double)

offerPrice
optional

The lowest offer price available for the particular stay without any additional costs or addons included

number (double)

offerPriceInclusive
optional

The lowest offer price available for the particular stay including mandatory additional costs configured as internet additional cost

number (double)

units
optional

List of unit ids associated currently available for the the accommodationtype. For the accommodationtype search this list is limited to 100 unit ids to avoid any performance impact. Incase a full list exceeding 100 unit ids is needed consider using the reservation proposal call or unit search

< integer > array

totalCapacity
optional

Total capacity accommodated in the accommodationtype

integer (int32)

rating
optional

Average rating guests have given for the accommodation through surveys

number (double)

referencePrice
optional

The highest accommodationtype rent price ever available for the particular stay(can be used as from price)

number (double)

referencePriceInclusive
optional

The highest accommodationtype rent price ever available for the particular stay(can be used as from price) including mandatory additional costs configured as internet additional cost

number (double)

duration
optional

The duration(number of nights) for which a user will stay at the accommodationtype

integer (int32)

rateTypeId
optional

The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type

integer (int64)

priority
optional

Write only (field is only accessible in the request body)

integer (int32)

nrOfBathrooms
optional

Number of bathrooms in the accommodationtype

number (double)

nrOfBedrooms
optional

Number of bedrooms in the accommodationtype

integer (int32)

loyaltyPrice
optional

Price including offers and loyalty

number (double)

loyaltyPriceInclusive
optional

Price including offers, loyalty and additional costs

number (double)

requiredLoyaltyPoints
optional

The required number of points for this loyalty price

integer (int32)

freeLoyaltyDuration
optional

The number of free nights for this number of loyalty points

integer (int32)

qualityLevelId
optional

integer (int64)

6.42. BankAccount

the bank account associated with the credit card authorisation record.

Properties
Name Description Schema

bankAccountName
optional

Write only (field is only accessible in the request body)

string

code
optional

Write only (field is only accessible in the request body)

string

name
optional

the bank account name.

string

currencyCode
optional

the bank account currency code.

string

paymentMethodDefinition
optional

PaymentMethodDefinition

6.43. Brand

Properties
Name Description Schema

brandId
optional

unique id associated with each brand

integer (int64)

defaultBrand
optional

if the brand is the default one then the value of the field is true else false

boolean

name
optional

name of the brand

string

reservationCategoryId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.44. CalculatePriceRequest

Properties
Name Description Schema

distributionChannelId
required

If the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown.

integer (int64)

reservationCategoryId
required

Specifies the categoryId of the reservation

integer (int64)

arrivalDate
required

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

duration
required

The number of days starting from the arrivalDate for which the price range search has been carried out and the duration should be passed in days ex: 7.

integer (int32)

rateTypeId
optional

Rate type id which will be used to fetch availability. If not provided, then the first rate type will be picked up from the rate types linked to distribution channel and ordered in ascending order of priority.

integer (int64)

offerCode
optional

Unique code associated with offer on the bases of which accommodationtype is to be filtered

string

subjects
optional

PriceEngineSubject

petQuantity
optional

Quantity of the pets for which search is to be made

Write only (field is only accessible in the request body)

integer (int32)

redeemableLoyaltyPoints
optional

Loyalty points to be used for the price calculation of the accommmodationtype

integer (int32)

6.45. CalculatePriceResponse

Properties
Name Description Schema

basePrice
optional

Accommodation type price + mandatory costs

number

offerPrice
optional

The discount that is received through offer(s)

number

loyaltyDiscount
optional

The discount that is received through loyalty

number

totalPrice
optional

The total price including discounts (if no offer code is provided: cheapest option among open offers, otherwise price for requested offer code)

number

warrantTotalPrice
optional

Write only (field is only accessible in the request body)

number

6.46. Capacity

Properties
Name Description Schema

capacityId
optional

unique id associated with each capacity

integer (int64)

managerId
optional

Write only (field is only accessible in the request body)

integer (int64)

capacity
optional

number of subjects(people) who will come for stay

integer (int32)

subjectId
optional

unique id asociated with each subject

integer (int64)

startDate
optional

date from which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

name
optional

name of the subject

string

6.47. CapacityDetail

The maximum number of subjects for which the unit can be booked including all the younger subjects than adult for e.g Child and Infant

Properties
Name Description Schema

capacityId
optional

unique id associated with each capacity

integer (int64)

managerId
optional

Write only (field is only accessible in the request body)

integer (int64)

capacity
optional

The maximum number of subjects for which the accommodation can be booked

integer (int32)

subjectId
optional

unique id asociated with each subject

integer (int64)

startDate
optional

date from which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

subject
optional

Subject

6.48. CashAccount

Properties
Name Description Schema

accountId
optional

integer (int64)

name
optional

string

description
optional

string

companyId
optional

integer (int64)

accountType
optional

enum (NORMAL,UNASSIGNABLE,FREE,DEVIATION,CASH,RECEPTION,ROUNDOFF,CARD,INTERNET,DEBITCARD,FUND_DEBITCARD,ZEROBALANCE,CCARD_AUTHORIZATION,CHEQUE_INCOMING,CHEQUE_OUTGOING,TRANSFER_PAYMENTS,MISCELLANEOUS)

6.49. CashClearance

Properties
Name Description Schema

cashClearanceId
optional

integer (int64)

reportNumber
optional

integer (int64)

creationDate
optional

string (date-time)

companyId
optional

integer (int64)

employeeId
optional

integer (int64)

totalValueAmount
optional

number (double)

totalCardAmount
optional

number (double)

startBalanceNextDay
optional

number (double)

tillAmountNextDay
optional

number (double)

safeWithdrawalAmount
optional

number (double)

safeDepositAmount
optional

number (double)

receivedAmount
optional

number (double)

totalMutationAmount
optional

number (double)

cashDifference
optional

number (double)

reasonCashDifference
optional

string

currencyId
optional

integer (int64)

6.50. CashFlowRuleResource

Properties
Name Description Schema

resourceType
optional

string

accommodationKindId
optional

integer (int64)

resourceId
optional

integer (int64)

6.51. Cashflowrule

rate for resource to insert

Properties
Name Description Schema

value
optional

Actual rate value, price.

number (double)

remark
optional

Optional remark/comment about the specific rate

string

quantifier
optional

Possible values are: ABSOLUTE ( +/- an amount to the rate), OVERRIDE (override the rate), RELATIVE( +/- a percentage to the rate).

string

valueType
optional

Type of value, price. This can be "single" (base )

string

priority
optional

Priority, the rate with the highest priority will be the preferred one

integer (int64)

bookdateFrom
optional

The reservation book date should be greater than equal to this date.

string (date-time)

bookdateTo
optional

The reservation book date should be less than equal to this date.

string (date-time)

resourceId
optional

The resource(accommodationtype, addon) the rate applies to.

integer (int64)

repeatable
optional

Defines if the rate be used again between the valid from and to period

integer (int64)

status
optional

integer (int64)

rateLevelId
optional

Deprecated

integer (int64)

rateTypeIds
optional

Ratetypes the rate is linked to

< integer > array

rateOptionId
optional

The rate option which is linked to the rate type. A rate option defines if the price is per night or any other length of stay. If it’s not per night, the rate is depending on the minimum length of stay. When creating a rate, the correct rateOptionId is selected based on the provided values of rateTypeIds, minDuration, maxDuration, duration, usageDurationFrom, usageDurationTo.
In case rateOptionId is provided the other fields will be blocked.
In case both are filled that is rateOptionId and minUnit, maxUnit, usageUnitFrom, usageUnitTo, duration and rateTypeIds will throw an error.
In case other fields are provided without a rateOptionId, rateOptionId will select automatically.

integer (int64)

minDeviation
optional

Minimal number of days between book date and arrival date when the price will be valid.

integer (int64)

maxDeviation
optional

Maximum number of days between book date and arrival date when the price will be valid.

integer (int64)

translations
optional

< I18nRate
> array

validFrom
optional

The arrival date of reservation should be geater than or equal to this date.

Write only (field is only accessible in the request body)

string (date)

validTo
optional

The arrival date of reservation should be less than or equal to this date.

Write only (field is only accessible in the request body)

string (date)

daysOfWeek
optional

The day the rate is applicable/valid

Write only (field is only accessible in the request body)

< string > array

duration
optional

Stay for which the cashflow rule

Write only (field is only accessible in the request body)

integer (int64)

usageDurationFrom
optional

The usage of the unit should be greater than or equal to the this date.

Write only (field is only accessible in the request body)

integer (int64)

usageDurationTo
optional

The usage of the unit should be less than or equal to the this date.

Write only (field is only accessible in the request body)

integer (int64)

minDuration
optional

Minimal length of stay(number of nights) the price is valid for(only applies in case of nightly rates).

Write only (field is only accessible in the request body)

integer (int64)

maxDuration
optional

Maximum length of stay(number of nights) the price is valid for(only applies in case of nightly rates).

Write only (field is only accessible in the request body)

integer (int64)

cashflowruleId
optional

The id of the cashflow rule.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

arrivalDateFrom
optional

The arrival date of reservation should be geater than or equal to this date.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

string (date)

arrivalDateTo
optional

The arrival date of reservation should be less than or equal to this date.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

string (date)

usageDowList
optional

List of usageDow

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

< string > array

stay
optional

Stay for which the cashflow rule

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

minUnit
optional

Number of units should be greater than or equal to this amount.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

maxUnit
optional

Number of units should be less than or equal to this amount.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

usageUnitFrom
optional

The usage of the unit should be greater than or equal to the this date.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

usageUnitTo
optional

The usage of the unit should be less than or equal to the this date.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

6.52. Category

Properties
Name Description Schema

amenityCategoryId
optional

integer (int64)

code
optional

string

priority
optional

integer (int64)

translations
optional

< I18nAmenityCategory
> array

isInternalUse
optional

Write only (field is only accessible in the request body)

boolean

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenityCategory
> array

6.53. CategoryDetail

details related to group of amenities

Properties
Name Description Schema

code
optional

unique code associated with each amenity group

string

amenityCategoryId
optional

unique id associated with each amenity group

integer (int64)

priority
optional

priority of the amenity category

integer (int64)

amenities
optional

desirable or accessible properties that a customer can possess in the resource. Possible values encountered: SIMPLE, TEXT, NUMBER

< AmenityLinkDetail
> array

amenityGroups
optional

desirable or accessible properties that a customer can possess in the resource. The value that will be encountered is GROUP

< AmenityGroupLinkDetail
> array

translations
optional

information of the group of amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenityCategory
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenityCategory
> array

6.54. CategorySet

Properties
Name Description Schema

amenityCategorySetId
optional

integer (int64)

code
optional

string

priority
optional

integer (int64)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

images
optional

< Image
> array

translations
optional

< I18nAmenityCategory
> array

parentId
optional

Write only (field is only accessible in the request body)

integer (int64)

amenityCategories
optional

< Category
> array

isInternalUse
optional

Write only (field is only accessible in the request body)

boolean

i18n
optional

Write only (field is only accessible in the request body)

< I18nAmenityCategory
> array

6.55. Communication

Properties
Name Description Schema

customerCommunicationId
optional

integer (int64)

sendDate
optional

string (date-time)

sendingType
optional

string

reservationId
optional

integer (int64)

message
optional

string

senderEmail
optional

string

subject
optional

string

attachments
optional

< Filebase
> array

reportUrls
optional

Write only (field is only accessible in the request body)

< ReportUrl
> array

report
optional

Report

staticAttachments
optional

Write only (field is only accessible in the request body)

< Filebase
> array

reportUrl
optional

Write only (field is only accessible in the request body)

< ReportUrl
> array

reportType
optional

enum (GENERAL,EMPLOYEE,CUSTOMER,AGENT,OWNER)

reportCode
optional

string

6.56. Company

Properties
Name Description Schema

companyId
optional

integer (int64)

companyNumber
optional

string

name
optional

string

description
optional

string

adminOrganisationId
optional

string

currencyId
optional

integer (int64)

6.57. Contract

Properties
Name Description Schema

contractId
optional

integer (int64)

code
required

string

name
required

string

ownerId
required

integer (int64)

unitId
optional

integer (int64)

startDate
required

string (date)

endDate
optional

string (date)

targetAmount
optional

number (double)

contractTypeId
required

integer (int64)

resourceId
optional

integer (int64)

poolOwnerId
optional

integer (int64)

origin
optional

string

originId
optional

string

rentAssurance
optional

number (double)

contractRenewalReminder
optional

string (date)

6.58. ContractRule

Properties
Name Description Schema

contractRuleId
optional

integer (int64)

contractTypeId
optional

integer (int64)

archivedFrom
optional

string (date)

arrivalDateEnd
optional

string (date)

arrivalDateStart
optional

string (date)

baseSumIncludingTax
optional

boolean

beneficiary
optional

string

calculateAbsolutePerNight
optional

boolean

calculationSource
optional

string

commissionOnly
optional

boolean

commissionInculdingTax
optional

boolean

departureDateStart
optional

string (date-time)

departureDateEnd
optional

string (date-time)

introducerInOwnObject
optional

boolean

ledgerId
optional

integer (int64)

name
optional

string

ownerSpecific
optional

boolean

priority
optional

integer (int64)

purchaseLedgerId
optional

integer (int64)

purchaseSecondLedgerId
optional

integer (int64)

reservationDateStart
optional

string (date)

reservationDateEnd
optional

string (date)

resourceType
optional

string

resourceTypeSelected
optional

boolean

resourceBeneficiary
optional

boolean

resourceId
optional

integer (int64)

secondLedgerId
optional

integer (int64)

settlementOwnerId
optional

integer (int64)

settlementOwnerResortId
optional

integer (int64)

stayDateFrom
optional

string (date)

stayDateTo
optional

string (date)

substractDistributionChannelCommission
optional

boolean

substractDistributionChannelIncludingTax
optional

boolean

taxSumInCommission
optional

integer (int64)

time
optional

integer (int64)

type
optional

enum (ABSOLUTE,RELATIVE)

unit
optional

enum (RESERVATION,SUBJECT,TIME)

value
optional

integer (int64)

vatForPrivateOwner
optional

boolean

ownerVatRateExclude
optional

integer (int64)

ledgerGroupId
optional

integer (int64)

purchaseLedgerGroupId
optional

integer (int64)

dependsOnLedgerGroup
optional

boolean

validity
optional

Validity

owners
optional

Write only (field is only accessible in the request body)

< Owner
> array

valueOnStayBasis
optional

boolean

resort
optional

Write only (field is only accessible in the request body)

< ContractRuleResort
> array

commissionTaxrate
optional

integer (int64)

6.59. ContractRuleResort

Properties
Name Description Schema

contractRuleResortId
optional

integer (int64)

resortId
optional

integer (int64)

contractruleId
optional

integer (int64)

6.60. ContractType

Properties
Name Description Schema

contractTypeId
optional

integer (int64)

code
optional

string

remark
optional

string

settlementMethod
optional

string

settlementPct
optional

integer (int64)

redirectionMinAmount
optional

integer (int64)

contractKind
optional

enum (EMPTY,OWNER_SPECIFIC,POOL,RENT_ASSURANCE,POOL_SHARE)

priority
optional

integer (int64)

round
optional

boolean

ownUsageAllowed
optional

boolean

archivedFrom
optional

string (date)

resourceGroupId
optional

integer (int64)

translations
optional

< I18nContractType
> array

nonRentable
optional

boolean

i18n
optional

Write only (field is only accessible in the request body)

< I18nContractType
> array

6.61. CostCenter

Properties
Name Description Schema

costCenterId
optional

integer (int64)

name
optional

string

description
optional

string

costCenterNumber
optional

string

6.62. CostPrice

Properties
Name Description Schema

costPriceId
optional

integer (int64)

resourceId
optional

integer (int64)

stayDateFrom
optional

string (date)

stayDateTo
optional

string (date)

bookDateFrom
optional

string (date-time)

bookDateTo
optional

string (date-time)

usageUnit
optional

integer (int64)

usageUnitFrom
optional

integer (int64)

usageUnitTo
optional

integer (int64)

value
optional

number (double)

currency
optional

Currency

remark
optional

string

costPriceSpecials
optional

< CostPriceSpecial
> array

6.63. CostPriceSpecial

Properties
Name Description Schema

resourceId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

6.64. Country

details of the country in which the accommodationtype/resort/unit is situated

read only

Properties
Name Description Schema

countryId
optional

unique id associated with each country

integer (int64)

shortName
optional

Write only (field is only accessible in the request body)

string

priority
optional

integer (int32)

defaultLanguageId
optional

Write only (field is only accessible in the request body)

integer (int64)

translations
optional

< I18NCountry
> array

default
optional

boolean

code
optional

country code represents shortname of country, 2 letter code(ISO 3166).

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

string

6.65. Country_Id

details of the country in which the accommodationtype/resort/unit is situated

read only

Properties
Name Description Schema

countryId
optional

unique id associated with each country

integer (int64)

shortName
optional

Write only (field is only accessible in the request body)

string

priority
optional

integer (int32)

defaultLanguageId
optional

Write only (field is only accessible in the request body)

integer (int64)

translations
optional

< I18NCountry_Id
> array

default
optional

boolean

code
optional

country code represents shortname of country, 2 letter code(ISO 3166).

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

string

6.66. CreateAccommodationTypeRequest

Properties
Name Description Schema

accotypeKindId
optional

unique id associated with each kind of accommodationtype

integer (int64)

brandId
optional

unique id associated with each brand

integer (int64)

code
optional

unique code associated with each accommodationtype

string

nrOfBathrooms
optional

number of bathrooms that an accommodationtype can possess

number (double)

nrOfBedrooms
optional

number of bedrooms that an accommodationtype possess

number (double)

parentId
optional

if the accommodationtype is child to another accommodationtype

string

priority
optional

the sequence in which the accommodationtype will be visible to the user

integer (int64)

resortId
required

unique id associated with each resort to which the accommodationtype belong

integer (int64)

translations
optional

information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nAccommodationType
> array

address
optional

CreateAddressRequest

origin
optional

Origin name of the resource

Maximum Length: 10
Minimum Length: 0

string

originId
optional

Origin Id of the resource

string

6.67. CreateAddressRequest

Properties
Name Description Schema

accuracy
optional

Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE

enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE)

address1
optional

the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address2
optional

the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address3
optional

the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateContactPerson
optional

name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

boxNumber
optional

number used as an address

string

city
optional

city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

countryId
optional

unique id associated with each country

integer (int64)

dateEnd
optional

date when the accommodationtype/resort/unit is archived

string (date)

dateBegin
optional

date on which the accommodationtype/resort/unit was created

string (date)

district
optional

district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

email
optional

email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

exposeLocation
optional

if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false

boolean

fax
optional

fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

houseNumber
optional

house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

houseNumberSuffix
optional

a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

latitude
optional

latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

longitude
optional

longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

mobilePhone
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

mobilePhone2
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

municipality
optional

name of the general-purpose administrative subdivision

string

poBox
optional

numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxZipcode
optional

zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxCity
optional

city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

privatePhone
optional

the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

stateId
optional

unique id associated with each state

integer (int64)

workPhone
optional

the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

zipCode
optional

zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

6.68. CreateAdminOrganisationRequest

Request Body for new adminorganisation

Properties
Name Description Schema

name
required

Maximum Length: 50
Minimum Length: 0

string

description
required

Maximum Length: 4000
Minimum Length: 0

string

code
required

unique code of the admin organisation

Maximum Length: 50
Minimum Length: 0

string

currencyId
required

currencyId of the admin organisation

integer (int64)

origin
required

string

originId
required

string

6.69. CreateAmenity

Properties
Name Description Schema

amenityCategoryIds
optional

< integer > array

childAmenityIds
optional

< integer > array

type
optional

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

code
optional

string

numberMinimum
optional

integer (int32)

numberMaximum
optional

integer (int32)

linkedAmenityId
optional

integer (int64)

translations
optional

< CreateAmenityTranslation
> array

amenityStandardCode
optional

string

origin
optional

string

originId
optional

string

6.70. CreateAmenityTranslation

Properties
Name Description Schema

language
optional

language in which the given information is stored

string

name
optional

name of the amenity

string

description
optional

description related to the amenity

string

6.71. CreateLockRequest

Properties
Name Description Schema

detailDescription
optional

string

endDate
required

string (date)

unitId
optional

integer (int64)

reasonId
required

integer (int64)

startDate
required

string (date)

type
required

enum (FINAL,PHASING,TEMPORARY,PHASINGGROUP)

6.72. CreateOwnerRequest

request body to create owner

Properties
Name Description Schema

accountNr
optional

string

alternateName
optional

string

attentionOf
optional

string

bicSwift
optional

string

birthDate
optional

string (date)

company
optional

boolean

companyName
optional

string

emailAllowed
optional

boolean

firstName
optional

string

fiscalTypes
optional

< OwnerFiscalType
> array

ibanNumber
optional

string

lastName
optional

string

mailAddress
optional

CreateAddressRequest

mailAllowed
optional

boolean

middle
optional

string

sendMethodId
optional

integer (int64)

sex
optional

string

titleId
optional

integer (int64)

origin
optional

string

originId
optional

string

ownerPool
optional

enum (OWNER,POOL,RENT_ASSURANCE_POOL,YEAR_ROUND_GUEST,BUSINESS,LOCATION,MAINTAINANCE_FUND,VENDOR,POOL_CONSUMPTION,POOL_SHARE)

ownerGroupId
optional

integer (int64)

questionnaireUnsubscribed
optional

boolean

owner
optional

boolean

6.73. CreateRepresentationRequest

Properties
Name Description Schema

resourceId
optional

integer (int64)

visible
optional

boolean

bookable
optional

boolean

distributionChannelIds
optional

< integer > array

translations
optional

< I18nRepresentation
> array

6.74. CreateReservationEquipment

Properties
Name Description Schema

value
optional

string

remark
optional

string

reservedResourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.75. CreateReservationPersonSubject

Properties
Name Description Schema

firstName
optional

string

middleName
optional

string

lastName
optional

string

birthDate
optional

string (date)

sex
optional

string

email
optional

string

street
optional

string

houseNumber
optional

string

houseNumberSuffix
optional

string

zipCode
optional

string

city
optional

string

countryId
optional

integer (int64)

guest
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

boolean

companion
optional

boolean

personAlreadyLeft
optional

boolean

arrivalDate
optional

string (date)

departureDate
optional

string (date)

identityCardNumber
optional

Identity card number of travel party member

Maximum Length: 50
Minimum Length: 0

string

identityType
optional

enum (PASSPORT,IDENTITY_CARD,DRIVERS_LICENCE)

identityNumber
optional

string

identityCountryId
optional

integer (int64)

identityDateIssued
optional

string (date)

gender
optional

Write only (field is only accessible in the request body)

string

6.76. CreateReservationVehicleSubject

Properties
Name Description Schema

remark
optional

string

registrationMark
optional

Maximum Length: 15
Minimum Length: 0

string

subjectId
optional

Write only (field is only accessible in the request body)

integer (int64)

reservedResourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.77. CreateResortRequest

Request body to create a new resort.

Properties
Name Description Schema

adminOrganisationId
optional

integer (int64)

code
optional

string

internalResortNumber
optional

string

origin
optional

string

originId
optional

string

parentId
optional

integer (int64)

resortNumber
optional

integer (int64)

resortPriority
optional

integer (int64)

visitAddress
optional

CreateAddressRequest

mailAddress
optional

CreateAddressRequest

translations
optional

< CreateResortTranslation
> array

6.78. CreateResortTranslation

Properties
Name Description Schema

language
optional

code of the language in which the above information is stored

string

name
optional

name of the resort

string

description
optional

description related to the resort

string

shortDescription
optional

short description related to the resort

string

6.79. CreateUnitAmenitylinkRequest_Basic

Properties
Name Description Schema

amenityId
optional

Unique id associated with each amenity

integer (int64)

startDate
optional

Date from which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

Date till which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

numberValue
optional

If the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

If the amenity is of type text then the value provided to the amenity is displayed here

string

visible
optional

If the amenity should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

The id associated to the extra

integer (int64)

6.80. CreateUnitRequest

Properties
Name Description Schema

resourceId
required

accommodationtype the unit applies to

integer (int64)

address
optional

CreateAddressRequest

code
optional

unique code of the unit

string

nrOfBathrooms
optional

number (double)

nrOfBedrooms
optional

integer (int32)

translations
optional

< I18nUnit
> array

origin
optional

system the unit is created in

string

originId
optional

identifier from the origin system

string

rentableUnitId
optional

integer (int64)

groupPriority
optional

integer (int32)

6.81. CreditCardAuthorisation

Properties
Name Description Schema

creditCardAuthorisationId
optional

unique id associated with each credit card authorisation

integer (int64)

status
optional

Write only (field is only accessible in the request body)

enum (OPEN,CLOSED,CANCEL,PARTIAL)

type
optional

the type of the authorisation.

enum (DEBITCARD,RESERVATION)

authorisedAmount
optional

the total amount that is authorised on a reservation.

number (double)

availableAmount
optional

the amount remaining and is not captured yet from authorised amount.

number (double)

creationDate
optional

the date on which the authorisation is created.

string (date)

capturedAmount
optional

the amount captured till now from the authorised amount.

number (double)

payerType
optional

the payer who paid the authorised amount.

enum (CUSTOMER,PAYING_CUSTOMER,AGENT)

bankAccount
optional

BankAccount

authorisationStatus
optional

enum (OPEN,CLOSED,CANCEL,PARTIAL)

paymentMethod
optional

PaymentMethodDefinition

6.82. Currency

Properties
Name Description Schema

currencyId
optional

integer (int64)

code
optional

string

name
optional

string

symbol
optional

string

currencyLanguage
optional

string

currencyCountry
optional

string

6.83. CustomField

Custom field for reservation

Properties
Name Description Schema

fieldId
optional

integer (int64)

textValue
optional

Applicable only when custom field is of type text

string

booleanValue
optional

Applicable only when custom field is of type boolean

boolean

dateValue
optional

Applicable only when custom field is of type date

string (date)

numericValue
optional

Applicable only when custom field is of type numeric

number

selectValues
optional

Applicable only when custom field is of type selection incl. or selection excl.

< string > array

6.84. Customer

Properties
Name Description Schema

customerId
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

customerGroupId
optional

integer (int64)

titleId
optional

integer (int64)

firstName
optional

first name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

middle
optional

middle name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

lastName
optional

last name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateName
optional

alternate name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

mailAddress
optional

Address

emailAllowed
optional

boolean

mailAllowed
optional

boolean

phoneCallAllowed
optional

This field indicates if the customer has given us permission to contact them via phone call.

boolean

textMsgAllowed
optional

This field indicates if we can send text messages to the customer.

boolean

signatureDate
optional

string (date)

socialSecurityNumber
optional

social security number of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

sex
optional

gender of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

languageId
optional

integer (int64)

language
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

string

ibanNumber
optional

ibanNumber of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

bicSwift
optional

string

birthDate
optional

birth date of customer and this is a restricted field. If you don’t have access to this field, then 1800-01-01 will be returned as value.

string (date)

companyName
optional

company name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

login
optional

Login id for the customer. Login field should be same as the email field in the customer address entity.

string

previousPmsId
optional

integer (int64)

creationDate
optional

string (date-time)

owner
optional

boolean

questionnaireUnsubscribed
optional

boolean

6.85. CustomerBill

The bill of agent or tour operator or any third party who made the reservation on behalf of the customer.

Properties
Name Description Schema

resourceId
optional

The unique id of resource for which the bill is generated.

integer (int64)

name
optional

The name of resource for which the bill is generated.

string

endDate
optional

The date till which the bill is generated for resource as part of the reservation.

string (date)

startDate
optional

The date from which the bill is start as part of the reservation.

string (date)

billLineType
optional

Possible bill-line type can be encountered :
RESERVED_RESOURCE(10): resources that are reserved in a reservation.
RESORT_ARTICLE(20): the article which belongs to the resort and the customer can purchase it during the stay.
SUBTOTAL(40): total of all reserved resources included in reservation.
WARRANT(50): It is an extra which is taken from the customer as a deposit.
VAT(60): It is a type of tax which is applied on a reservation.
TOTAL(70): total amount of all reserved resources in reservation.
PAID_AMOUNT(80): amount which is already paid in reservation.
DUE_AMOUNT(90): amount which is left to be paid in reservation by the customer.
STAY_ARTICLE(130): article which is booked in a reservation applicable throughout the stay of the customer.
WITHHOLDINGARTICLE(140): this is used for deposit purpose ex: the customer paid a deposit of 200 euros, they did not removed the trash bag thus they have to pay 10 euros. So the extra with the withholding article setting will be added in the reservation by the user. The customer will get back an amount of 190 euros via the repayment module.
TAX(250): tax which is to be paid by the customer applied on a reservation.
TOTAL_EXCL_TAX(260): total amount excluding the tax which is to be paid by the customer for a reservation.

integer (int32)

description
optional

Description of the resource for which the bill is generated.

Write only (field is only accessible in the request body)

string

total
optional

Total amount of the bill.

number (double)

vatRate
optional

Value of the applied configured vat-rate for the resource.

number (double)

redeemedLoyaltyPoints
optional

Number of points needed to get this discount

integer (int32)

redeemedLoyaltyNights
optional

Number of nights given free by the resource

integer (int32)

6.86. CustomerCluster

Properties
Name Description Schema

clusterId
optional

integer (int64)

categoryId
optional

integer (int64)

name
optional

deprecated

string

code
optional

string

description
optional

string

translations
optional

< I18nCrmCluster
> array

6.87. CustomerClusterCategory_Basic

Properties
Name Description Schema

categoryId
optional

integer (int64)

updateMode
optional

string

manualOverrideAllowed
optional

boolean

code
optional

string

enableManualEndDate
optional

boolean

customerCluster
optional

< CustomerClusterDetail_Basic
> array

translations
optional

< I18nCrmClusterCategory_Basic
> array

6.88. CustomerClusterDetail_Basic

Properties
Name Description Schema

clusterId
optional

integer (int64)

name
optional

deprecated

string

code
optional

string

description
optional

string

translations
optional

< I18nCrmCluster_Basic
> array

badgeColor
optional

string

iconName
optional

string

evaluate
optional

boolean

minReservations
optional

integer (int64)

maxReservations
optional

integer (int64)

minDays
optional

integer (int64)

maxDays
optional

integer (int64)

6.89. CustomerCluster_Detail

Properties
Name Description Schema

clusterId
optional

integer (int64)

categoryId
optional

integer (int64)

name
optional

deprecated

string

code
optional

string

description
optional

string

translations
optional

< I18nCrmCluster_Detail
> array

6.90. CustomerCredential

Properties
Name Description Schema

login
required

string

password
optional

string

6.91. CustomerLogin

Properties
Name Description Schema

customerId
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

customerGroupId
optional

integer (int64)

titleId
optional

integer (int64)

firstName
optional

first name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

middle
optional

middle name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

lastName
optional

last name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateName
optional

alternate name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

mailAddress
optional

Address

emailAllowed
optional

boolean

mailAllowed
optional

boolean

phoneCallAllowed
optional

This field indicates if the customer has given us permission to contact them via phone call.

boolean

textMsgAllowed
optional

This field indicates if we can send text messages to the customer.

boolean

signatureDate
optional

string (date)

socialSecurityNumber
optional

social security number of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

sex
optional

gender of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

languageId
optional

integer (int64)

language
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

string

ibanNumber
optional

ibanNumber of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

bicSwift
optional

string

birthDate
optional

birth date of customer and this is a restricted field. If you don’t have access to this field, then 1800-01-01 will be returned as value.

string (date)

companyName
optional

company name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

login
optional

Login id for the customer. Login field should be same as the email field in the customer address entity.

string

previousPmsId
optional

integer (int64)

creationDate
optional

string (date-time)

passwordModifiedDate
optional

Password Modification Date of Customer Credentials

string (date-time)

owner
optional

boolean

questionnaireUnsubscribed
optional

boolean

6.92. CustomerLoyaltyBalance

Properties
Name Description Schema

customerId
optional

integer (int64)

activePoints
optional

sum of all points that are redeemable for this customer

integer (int32)

spentPoints
optional

sum of all points already spent (redeemed) by this customer

integer (int32)

pendingPoints
optional

sum of all points which will become active in the future (where the activationDate is in the future) for this customer

integer (int32)

expiredPoints
optional

sum of all points that have already been expired for this customer (expiration date in the past)

integer (int32)

transactions
optional

< Transaction
> array

6.93. CustomerPhoneCall

Properties
Name Description Schema

customerPhoneCallId
optional

integer (int64)

type
optional

enum (INCOMING,OUTGOING)

customerId
optional

integer (int64)

employeeId
optional

integer (int64)

startTime
optional

string (date-time)

endTime
optional

string (date-time)

phoneNumber
optional

string

memoCategoryId
optional

integer (int64)

note
optional

string

resortId
optional

integer (int64)

6.94. CustomerStatus

Properties
Name Description Schema

customerId
optional

integer (int64)

customerClusters
optional

< CustomerCluster
> array

6.95. CustomerStatus_Detail

Properties
Name Description Schema

customerId
optional

integer (int64)

customerClusters
optional

< CustomerCluster_Detail
> array

6.96. CustomerTitle

Properties
Name Description Schema

titleId
optional

unique id associated with each title linked to the customer

integer (int64)

code
optional

unique code associated with each customer title

string

priority
optional

sequence in which the title will be displayed to the user.

integer (int32)

translations
optional

information of the customer title which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nCustomerTitle
> array

6.97. CustomerUpdate

Properties
Name Description Schema

firstName
optional

string

middle
optional

string

lastName
optional

string

alternateName
optional

string

birthDate
optional

string (date)

emailAllowed
optional

boolean

mailAllowed
optional

boolean

textMsgAllowed
optional

boolean

phoneCallAllowed
optional

boolean

ibanNumber
optional

string

bicSwift
optional

string

language
optional

string

sex
optional

string

titleId
optional

integer (int64)

mailAddress
optional

AddressUpdate

6.98. DCPaymentMethod

Properties
Name Description Schema

distributionChannelCode
optional

unique id associated with distributionChannel.

string

paymentMethods
optional

list of payment methods of distributionChannel.

< PaymentMethod
> array

6.99. DistributionChannelCurrency

Properties
Name Description Schema

debitVatIncluded
optional

number

debitVatExcluded
optional

number

creditVatExcluded
optional

number

creditVatIncluded
optional

number

currencyId
optional

integer (int64)

currencyCode
optional

string

exchangeRate
optional

integer (int64)

6.100. DistributionChannelRepresentation

Distribution channel representation that needs to be updated

Properties
Name Description Schema

distributionChannelRepresentationId
optional

integer (int64)

distributionChannelId
optional

integer (int64)

representationId
optional

integer (int64)

allotment
optional

integer (int64)

distributionChannelRepresentationParentId
optional

integer (int64)

6.101. DistributionChannel_Id

Properties
Name Description Schema

distributionChannelId
optional

unique id associated with the distributionChannel.

integer (int64)

code
optional

unique code associated with the distributionChannel.

string

name
optional

name associated with the distributionChannel.

string

representationSetParentId
optional

if the representation set is a child of another representation set then the id of the parent is displayed in representationSetParentId.

integer (int64)

allotmentOnly
optional

if distrubition channel is created for allotments then true will be displayed, otherwise false will be displayed in allotmentOnly.

deprecated

boolean

activeStartDate
optional

the date from which distributionChannel can be used.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

activeEndDate
optional

the date till which distributionChannel can be used.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

type
optional

type of the distributionChannel.Possible values that can be encountered are:DIRECT,RESELLER,TOUROPERATOR

string

inheritedType
optional

Write only (field is only accessible in the request body)

string

parentId
optional

if the distributionChannel is child of another distributionChannel then distributionChannelId of parent distributionChannel will be displayed in parentId.

integer (int64)

resellerId
optional

id of the reseller associated with distributionChannel.

integer (int64)

showAgentBill
optional

the amount which is paid by the agent will be displayed in showAgentBill.

integer (int32)

brandId
optional

unique id associated with brand.

integer (int64)

currencyId
optional

id associated with Currency.

integer (int64)

brand
optional

label associated with the distributionChannel.

string

archivedFrom
optional

date from which the distributionChannel was archived. The distributionChannels will not be displayed if the distributionChannel is archived.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

mailAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mailAddress
optional

MailAddress_Id

invoiceaddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

invoiceAddress
optional

MailAddress_Id

customerRequiredFieldsSetId
optional

Write only (field is only accessible in the request body)

integer (int64)

allotmentSetting
optional

it returns the allotment setting options.

enum (FREESALE,ALLOTMENT_ONLY,FREESALE_AND_ALLOTMENT)

communicationPermission
optional

Communication permission is a level which can be set on a distribution channel. It displays the agreement the client has with the distributionchannel and if it’s allowed to contact the customer of the reservations made by the respective distributionchannel. There are different levels which can be assigned and the levels are as follows : (1) full_permission, (2) partial_permission, (3) no_permission, (4) special_permission

string

currencyCode
optional

unique code associated with the currency.

string

6.102. DocumentBase

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

fileId
optional

integer (int64)

name
optional

string

fileName
optional

string

fileSize
optional

integer (int64)

fileType
optional

string

uploadDate
optional

string (date)

language
optional

string

endDate
optional

string (date)

shortDescription
optional

string

validFrom
optional

string (date)

validTo
optional

string (date)

6.103. DocumentUrl

Properties
Name Description Schema

downloadLink
optional

string

6.104. DoorLock

Properties
Name Description Schema

doorLockCode
optional

string

bluetoothLowEnergy
optional

boolean

6.105. DoorLockType

SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty.

Properties
Name Description Schema

doorlockTypeId
optional

integer (int64)

lockType
optional

enum (SAFLOKCARD,KOOLECONTROLS)

startDate
optional

string (date)

endDate
optional

string (date)

doorlocks
optional

< DoorLock
> array

6.106. DoorlockCode

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

unitId
optional

integer (int64)

validDateFrom
optional

string (date)

validDateTo
optional

string (date)

code1
optional

string

code2
optional

string

code1Active
optional

string

code2Active
optional

string

earlyCheckInCode1
optional

string

earlyCheckInCode2
optional

string

6.107. DoorlockPincodesContainer

Properties
Name Description Schema

doorlockId
optional

integer (int64)

unitId
optional

integer (int64)

lockCode
optional

string

codeLength
optional

integer (int32)

bluetoothLowEnergy
optional

boolean

pincodes
optional

< Pincode
> array

6.108. DynamicField

Properties
Name Description Schema

fieldId
optional

unique id associated with each dynamic field

integer (int64)

code
optional

unique id associated with each dynamic field

string

type
optional

type of the accommodationtype configured in dynamic field ex: house, bungalow etc

string

eventmanagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

translations
optional

information of the dynamic fields of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nDynamicField
> array

6.109. DynamicFieldDataCriteria

Properties
Name Description Schema

language
required

string

text
required

string

6.110. EmergencyContact

Emergency contact for reservation which contain the memo detail

Properties
Name Description Schema

emergencyContactId
optional

integer (int64)

reservationId
optional

integer (int64)

firstName
optional

string

middleName
optional

string

lastName
optional

string

phone
optional

string

relationship
optional

enum (PARENTS,CHILDREN_NOT_LIVING_AT_HOME,CHILDREN_LIVING_AT_HOME,FAMILY,FRIENDS,NEIGHBOURS)

6.111. Employee

Properties
Name Description Schema

employeeId
optional

integer (int64)

firstName
optional

string

lastName
optional

string

middleName
optional

string

empEmailId
optional

string

clientGroupId
optional

integer (int64)

employeeGroup
optional

EmployeeGroup

6.112. EmployeeCreateRequest

Properties
Name Description Schema

employeeGroupId
required

integer (int64)

clientType
required

enum (EMPLOYEE,MAXXTON,APPLICATION,EXTERNAL)

sex
optional

enum (M,F,U)

type
optional

enum (I,T,P)

locale
required

enum (en_US,en_GB,nl_NL,de_DE,fr_FR)

privacyAccessLevel
optional

enum (GDPR_1,GDPR_2,GDPR_3)

privacyDbAccessLevel
optional

enum (GDPR_1,GDPR_2,GDPR_3)

reservationcategoryCode
required

string

distributionchannelCode
required

string

firstName
required

string

lastName
required

string

middleName
optional

string

email
required

string

login
optional

string

onDuty
optional

string (date)

offDuty
optional

string (date)

cashAccountIds
optional

< integer > array

permissionGroupIds
optional

< integer > array

resortIds
optional

< integer > array

adminorganisationIds
optional

< integer > array

sectorIds
optional

< integer > array

unifiedInboxIds
optional

< integer > array

6.113. EmployeeGroup

Properties
Name Description Schema

employeeGroupId
optional

integer (int64)

code
optional

string

description
optional

string

name
optional

string

6.114. EmployeeResponse

Properties
Name Description Schema

employeeId
optional

integer (int64)

distributionchannelId
optional

integer (int64)

firstName
optional

string

lastName
optional

string

groupId
optional

integer (int64)

login
optional

string

middleName
optional

string

reservationcategoryId
optional

integer (int64)

sex
optional

string

type
optional

string

empEmailId
optional

string

onDuty
optional

string (date)

offDuty
optional

string (date)

privacyAccessLevel
optional

enum (GDPR_1,GDPR_2,GDPR_3)

privacyDbAccessLevel
optional

enum (GDPR_1,GDPR_2,GDPR_3)

locale
optional

string

clientType
optional

enum (EMPLOYEE,MAXXTON,APPLICATION,EXTERNAL)

cashAccountIds
optional

< integer > array

resortIds
optional

< integer > array

adminorganisationIds
optional

< integer > array

permissionGroupIds
optional

< integer > array

sectorIds
optional

< integer > array

unifiedInboxIds
optional

< integer > array

6.115. EmployeeUpdateRequest

Properties
Name Description Schema

employeeGroupId
optional

integer (int64)

sex
optional

enum (M,F,U)

locale
optional

enum (en_US,en_GB,nl_NL,de_DE,fr_FR)

type
optional

enum (I,T,P)

privacyAccessLevel
optional

enum (GDPR_1,GDPR_2,GDPR_3)

privacyDbAccessLevel
optional

enum (GDPR_1,GDPR_2,GDPR_3)

reservationcategoryCode
optional

string

distributionchannelCode
optional

string

firstName
optional

string

lastName
optional

string

middleName
optional

string

email
optional

string

login
optional

string

onDuty
optional

string (date)

offDuty
optional

string (date)

cashAccountIds
optional

< integer > array

resortIds
optional

< integer > array

adminorganisationIds
optional

< integer > array

permissionGroupIds
optional

< integer > array

sectorIds
optional

< integer > array

unifiedInboxIds
optional

< integer > array

6.116. ErrorCode

Properties
Name Description Schema

errorCode
optional

string

message
optional

string

httpStatus
optional

enum (100 CONTINUE,101 SWITCHING_PROTOCOLS,102 PROCESSING,103 CHECKPOINT,200 OK,201 CREATED,202 ACCEPTED,203 NON_AUTHORITATIVE_INFORMATION,204 NO_CONTENT,205 RESET_CONTENT,206 PARTIAL_CONTENT,207 MULTI_STATUS,208 ALREADY_REPORTED,226 IM_USED,300 MULTIPLE_CHOICES,301 MOVED_PERMANENTLY,302 FOUND,302 MOVED_TEMPORARILY,303 SEE_OTHER,304 NOT_MODIFIED,305 USE_PROXY,307 TEMPORARY_REDIRECT,308 PERMANENT_REDIRECT,400 BAD_REQUEST,401 UNAUTHORIZED,402 PAYMENT_REQUIRED,403 FORBIDDEN,404 NOT_FOUND,405 METHOD_NOT_ALLOWED,406 NOT_ACCEPTABLE,407 PROXY_AUTHENTICATION_REQUIRED,408 REQUEST_TIMEOUT,409 CONFLICT,410 GONE,411 LENGTH_REQUIRED,412 PRECONDITION_FAILED,413 PAYLOAD_TOO_LARGE,413 REQUEST_ENTITY_TOO_LARGE,414 URI_TOO_LONG,414 REQUEST_URI_TOO_LONG,415 UNSUPPORTED_MEDIA_TYPE,416 REQUESTED_RANGE_NOT_SATISFIABLE,417 EXPECTATION_FAILED,418 I_AM_A_TEAPOT,419 INSUFFICIENT_SPACE_ON_RESOURCE,420 METHOD_FAILURE,421 DESTINATION_LOCKED,422 UNPROCESSABLE_ENTITY,423 LOCKED,424 FAILED_DEPENDENCY,425 TOO_EARLY,426 UPGRADE_REQUIRED,428 PRECONDITION_REQUIRED,429 TOO_MANY_REQUESTS,431 REQUEST_HEADER_FIELDS_TOO_LARGE,451 UNAVAILABLE_FOR_LEGAL_REASONS,500 INTERNAL_SERVER_ERROR,501 NOT_IMPLEMENTED,502 BAD_GATEWAY,503 SERVICE_UNAVAILABLE,504 GATEWAY_TIMEOUT,505 HTTP_VERSION_NOT_SUPPORTED,506 VARIANT_ALSO_NEGOTIATES,507 INSUFFICIENT_STORAGE,508 LOOP_DETECTED,509 BANDWIDTH_LIMIT_EXCEEDED,510 NOT_EXTENDED,511 NETWORK_AUTHENTICATION_REQUIRED)

applicationException
optional

boolean

6.117. Event

Properties
Name Description Schema

eventId
optional

unique id associated with each event

integer (int64)

entityId
optional

the id of the entity that changed

integer (int64)

entityType
optional

the entity that was changed which led to the generation of this event. entityId is the id of this entity

string

entityAction
optional

type of change whether the entity was updated, created, deleted or merged(in the case when a customer data is merged to a new customer id). The possible values are INSERT, UPDATE, DELETE, MERGE

string

eventTimestamp
optional

the time at which this event occured

string (date-time)

type
optional

type of event

string

oldEntityId
optional

in case of a merge type of event, like in the case of customer, this will return the old entity id

integer (int64)

6.118. Facility

Properties
Name Description Schema

facilityId
optional

unique id associated with each facility

integer (int64)

code
optional

code of the facility

string

internalUse
optional

if the facility is for internal use

boolean

resortId
optional

resort id of the facility

integer (int64)

priority
optional

priority of the facility

integer (int32)

translations
optional

information of the facility which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nFacility
> array

openingTimes
optional

< FacilityOpeningTime
> array

6.119. FacilityOpeningTime

Properties
Name Description Schema

openingTimeId
optional

integer (int64)

managerId
optional

Write only (field is only accessible in the request body)

integer (int64)

day
optional

Write only (field is only accessible in the request body)

string (date)

startTime
optional

string (date-time)

endTime
optional

string (date-time)

openingComment
optional

string

published
optional

boolean

translations
optional

< I18nFacilityOpeningTime
> array

date
optional

string (date)

6.120. Fields

Properties
Name Description Schema

fieldId
optional

integer (int64)

dataTypeName
optional

string

type
optional

string

value
optional

string

i18n
optional

Write only (field is only accessible in the request body)

< I18nFields
> array

translations
optional

< I18nFields
> array

6.121. Filebase

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

fileId
optional

integer (int64)

name
optional

string

fileName
optional

string

fileSize
optional

integer (int64)

fileType
optional

string

uploadDate
optional

string (date-time)

language
optional

string

endDate
optional

string (date-time)

shortDescription
optional

string

validFrom
optional

string (date-time)

validTo
optional

string (date-time)

6.122. FilterOption

Properties
Name Description Schema

arrivals
optional

unique items

< string > array

departures
optional

unique items

< string > array

resorts
optional

If includeFilterOptionCounts is "true" in request body, then all the available resortIds and their respective counts as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the resortIds are displayed in response.

unique items

< object > array

amenities
optional

If includeFilterOptionCounts is "true" in request body, then all the available amenities and their respective counts(No of accommodations in which that amenity is available) as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the amenityIds are displayed in response.

unique items

< object > array

accommodationKinds
optional

accommodationkind ids on which user can filter data

unique items

< object > array

6.123. FinancialTransactionJournalsReport

Properties
Name Description Schema

status
optional

string

description
optional

string

journalType
optional

string

journalNumber
optional

string

journalPeriodNumber
optional

string

statementNumber
optional

string

statementDate
optional

string (date)

ledgerNumber
optional

string

costCenter
optional

string

costUnit
optional

string

secondLedgerNumber
optional

string

debitVatIncluded
optional

Write only (field is only accessible in the request body)

number

creditVatIncluded
optional

Write only (field is only accessible in the request body)

number

debitVatExcluded
optional

Write only (field is only accessible in the request body)

number

creditVatExcluded
optional

Write only (field is only accessible in the request body)

number

debitVatIncludedAccCurr
optional

Write only (field is only accessible in the request body)

number

creditVatIncludedAccCurr
optional

Write only (field is only accessible in the request body)

number

debitVatExcludedAccCurr
optional

Write only (field is only accessible in the request body)

number

creditVatExcludedAccCurr
optional

Write only (field is only accessible in the request body)

number

accountCurrencyId
optional

Write only (field is only accessible in the request body)

integer (int64)

exchangeValue
optional

Write only (field is only accessible in the request body)

integer (int64)

accountId
optional

integer (int64)

accountCurrencyCode
optional

Write only (field is only accessible in the request body)

string

adminCurrencyCode
optional

Write only (field is only accessible in the request body)

string

adminCurrencyId
optional

Write only (field is only accessible in the request body)

integer (int64)

adminOrganistationCurrency
optional

AdminOrganisationCurrency

accountCurrency
optional

AccountCurrency

statementHeader
optional

boolean

financialTransactionReportJournalId
optional

integer (int64)

adminOrganisationId
optional

integer (int64)

financialTransactionReportId
optional

integer (int64)

6.124. FinancialTransactionReport

Properties
Name Description Schema

financialTransactionReportId
optional

integer (int64)

reportNumber
optional

integer (int64)

creationDate
optional

string (date-time)

status
optional

string

adminOrganisationId
optional

integer (int64)

companyId
optional

integer (int64)

6.125. FiscalYearResponse

Properties
Name Description Schema

arrivalLimit
optional

string (date)

departureLimit
optional

string (date)

financiallyClosed
optional

boolean

fiscalYear
optional

integer (int32)

fiscalYearId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.126. GeoLocation

Properties
Name Description Schema

latitude
optional

number (double)

longitude
optional

number (double)

6.127. Group

Properties
Name Description Schema

groupId
optional

integer (int64)

code
optional

string

type
optional

enum (CONTRACT_TYPE,PHASING,ACCOMMODATION_TYPE,RESORT,EXCLUDE_RESOURCE,POWERPLAY,DISTRIBUTION_CHANNEL,MARKETING,REPORTING_CONTRACT_TYPE,DEBITCARD_PRODUCT,BILL,PURPOSE,DUTIES,DISTRIBUTION_CHANNEL_SETTLEMENT,DISTRIBUTION_CHANNEL_SELECTION,INTERNET_ADDITIONAL_COST)

parentId
optional

integer (int64)

priority
optional

integer (int64)

resortId
optional

integer (int64)

translations
optional

< I18nGroup
> array

linkedIds
optional

< integer > array

6.128. Housekeeping

Properties
Name Description Schema

resortId
optional

integer (int64)

resourceId
optional

integer (int64)

unitId
optional

integer (int64)

executionDate
optional

string (date)

executionMoment
optional

enum (ARRIVAL,DEPARTURE,CHANGEOVER,STAY,RESCHEDULE,MANUAL)

sector
optional

Sector

tasks
optional

< Task
> array

6.129. HousekeepingTask

Properties
Name Description Schema

taskId
optional

integer (int64)

code
optional

string

translations
optional

< I18nHousekeepingTask
> array

6.130. I18NCountry

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nCountryId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the country

string

language
optional

code of the language in which the above information is stored

string

longName
optional

Write only (field is only accessible in the request body)

string

6.131. I18NCountry_Id

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nCountryId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the country

string

language
optional

code of the language in which the above information is stored

string

longName
optional

Write only (field is only accessible in the request body)

string

6.132. I18NRegion

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

description
optional

string

name
optional

string

shortDescription
optional

string

language
optional

string

6.133. I18nAccommodationKind

information of the accommodation kind which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nAccommodationkindId
optional

integer (int64)

accommodationkindId
optional

integer (int64)

name
optional

string

description
optional

string

6.134. I18nAccommodationType

information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Properties
Name Description Schema

description
optional

description related to the accommodation type

string

description2
optional

alternate description related to the accommodation type

string

language
optional

code of the language in which the given information is stored

string

name
optional

name of the accommodation type

string

shortDescription
optional

short description related to the accommodation type

string

6.135. I18nAddition

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the resource

string

shortDescription
optional

short description related to the resource

string

description
optional

description related to the resource

string

description2
optional

alternate description related to the resource

string

6.136. I18nAddon

Properties
Name Description Schema

name
optional

string

language
optional

string

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

resourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.137. I18nAmenity

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

language in which the given information is stored

string

name
optional

name of the amenity

string

description
optional

description related to the amenity

string

6.138. I18nAmenityCategory

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the amenity category

string

language
optional

language in which the given information is stored

string

description
optional

description of the amenity category

string

6.139. I18nAmenityCategory_Basic

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the amenity category

string

language
optional

language in which the given information is stored

string

description
optional

description of the amenity category

string

6.140. I18nAmenity_Basic

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

language in which the given information is stored

string

name
optional

name of the amenity

string

description
optional

description related to the amenity

string

6.141. I18nArea

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

areaId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

description2
optional

string

6.142. I18nContractType

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

contractTypeId
optional

integer (int64)

language
optional

string

name
optional

string

6.143. I18nCrmCluster

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

6.144. I18nCrmClusterCategory_Basic

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the above information is stored

string

name
optional

string

description
optional

string

6.145. I18nCrmCluster_Basic

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

6.146. I18nCrmCluster_Detail

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

6.147. I18nCustomerTitle

information of the customer title which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

title
optional

title associated with the customer

string

language
optional

code of the language in which the above information is stored

string

6.148. I18nDynamicField

information of the dynamic fields of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nFieldId
optional

Write only (field is only accessible in the request body)

integer (int64)

fieldId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the specific accommodation type in dynamic field in the translated language

string

language
optional

code of the language in which the above information is stored

string

shortDescription
optional

short description of the related accommodationtype in dynamic field

string

description
optional

detailed description of the related accommodationtype in dynamic field

string

text
optional

text configured for specific accommodationtype in dynamic field

string

6.149. I18nFacility

information of the facility which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

description
optional

string

language
optional

string

shortDescription
optional

string

6.150. I18nFacilityOpeningTime

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

openingComment
optional

Write only (field is only accessible in the request body)

string

6.151. I18nFields

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the resource

string

description
optional

description related to the resource

string

6.152. I18nGroup

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

description
optional

string

shortDescription
optional

string

language
optional

string

6.153. I18nHousekeepingTask

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

6.154. I18nImage

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the image

string

description
optional

description associated with the image in translated language

string

language
optional

code of the language in which the translation information is shown

string

6.155. I18nImply

Properties
Name Description Schema

name
optional

string

language
optional

string

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.156. I18nIssueCategory

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

6.157. I18nIssueItem

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

6.158. I18nLedgerGroup

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

description
optional

string

name
optional

string

language
optional

string

6.159. I18nMemoCategory

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

description
optional

string

language
optional

string

6.160. I18nMetric

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the metric

string

language
optional

language in which the above information is stored

string

6.161. I18nMetric_Basic

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the metric

string

language
optional

language in which the above information is stored

string

6.162. I18nPackageItem

information of the packages available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

packageItemId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the packages

string

language
optional

language in which the given information is stored

string

6.163. I18nPaymentMethod

information of the payment methods which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the payment method

string

language
optional

code of the language in which the translation information is shown

string

6.164. I18nPaymentTermSet

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

description
optional

string

language
optional

string

6.165. I18nPeriodicalTask

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

description2
optional

string

6.166. I18nPointsOfInterest

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

headText
optional

string

text
optional

string

description
optional

string

description2
optional

string

6.167. I18nPointsOfInterestCategory

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

shortDescription
optional

string

6.168. I18nPredefinedMemo

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

description
optional

string

language
optional

string

6.169. I18nQualityLevel

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

6.170. I18nRate

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

6.171. I18nRateType

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

language
optional

string

6.172. I18nRentabilitySet

information of the rentability which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the above information is stored

string

name
optional

name of the rentability set

string

6.173. I18nRepresentation

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nRepresentationId
optional

Write only (field is only accessible in the request body)

integer (int64)

representationId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

string

language
optional

string

shortDescription
optional

string

description
optional

string

description2
optional

string

6.174. I18nReservationCategory

information of the reservationCategory which depends on a language and is translatable by the user. Multiple entries for different languages can exists.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which reservationCategory information is stored.

string

name
optional

name of the country.

string

description
optional

desciption of the reservationCategory.

string

6.175. I18nResort

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the above information is stored

string

name
optional

name of the resort

string

description
optional

description related to the resort

string

shortDescription
optional

short description related to the resort

string

6.176. I18nResortActivity

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

title
optional

string

headText
optional

string

text
optional

string

description
optional

string

6.177. I18nResource

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the resource

string

shortDescription
optional

short description related to the resource

string

description
optional

description related to the resource

string

description2
optional

alternate description related to the resource

string

resourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

namePath
optional

name of the path of an accommodationtype

string

accotypeKind
optional

field under description which depicts the kind of accommodationtype

string

6.178. I18nResourceGroup

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

shortDescription
optional

string

description
optional

string

description2
optional

string

6.179. I18nResourceLockReason

Properties
Name Description Schema

languageId
required

integer (int64)

langauge
optional

string

name
optional

string

description
optional

string

6.180. I18nResource_Detail

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the resource

string

shortDescription
optional

short description related to the resource

string

description
optional

description related to the resource

string

description2
optional

alternate description related to the resource

string

namePath
optional

name of the path of an accommodationtype

string

6.181. I18nRoom

information of the rooms accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the room

string

description
optional

description associated with the room

string

6.182. I18nRoomType

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the room type

string

description
optional

description associated with the room type

string

6.183. I18nSendMethod

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nSendMethodId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

sendMethodId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.184. I18nSource

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

6.185. I18nSubject

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

name of the subject

string

shortDescription
optional

short description associated with the subject

string

subjectId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the translation information is shown

string

6.186. I18nTask

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

description2
optional

string

6.187. I18nUnit

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

description2
optional

string

shortDescription
optional

string

unitId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.188. I18nUnit_Id

information of the unit which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

description2
optional

string

shortDescription
optional

string

unitId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.189. IcalUrl

Properties
Name Description Schema

downloadLink
optional

string

6.190. Image

Properties
Name Description Schema

fileName
optional

name of the file uploaded

string

imageId
optional

unique id associated with each image

integer (int64)

startDate
optional

date from which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

endDate
optional

date till which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

mimeType
optional

type of the image. Possible values that can be encountered are:IMAGE_JPG, IMAGE_JPEG, IMAGE_GIF, IMAGE_PNG, IMAGE_SVG, IMAGE_ICO, IMAGE_TIFF, UNKNOWN

enum (IMAGE_JPG,IMAGE_JPEG,IMAGE_GIF,IMAGE_PNG,IMAGE_SVG,IMAGE_ICO,IMAGE_TIFF,UNKNOWN)

version
optional

version of the image

integer (int64)

url
optional

url of the image

string

urls
optional

different urls related to the image based on the size

object

uploadDate
optional

date when the image was uploaded. The format of the date will be YYYY-MM-DDThh:mm:ss

string (date-time)

imageType
optional

type of image ex: if the image depicts the exterior of the accommodationtype/unit/resort then it gives 'EXTERIOR', if the image denotes the interior of the accommodationtype/unit/resort the value of this field is 'INTERIOR'

enum (LOGO,FLOORPLAN,ROADMAP,INTERIOR,EXTERIOR,MUGSHOT,PICTURE,MAP,IMPRESSION,UNKNOWN,LOCATION_MAP,HEADER,VIDEO360,ICON,OPERATIONS,STATUSICON)

imageOrientation
optional

orientation of the image i.e horizontal, vertical etc

string

modifiedDate
optional

date when the image was last modified. The format of the date will be YYYY-MM-DDThh:mm:ss.

string (date-time)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mediaType
optional

Write only (field is only accessible in the request body)

enum (IMAGE,VIDEO,VIDEO360)

isUploaded
optional

Write only (field is only accessible in the request body)

boolean

hostType
optional

Write only (field is only accessible in the request body)

enum (YOUTUBE,VIDEO23,CLOUDINARY,EXTERNAL,MATTERPORT)

isActive
optional

Write only (field is only accessible in the request body)

boolean

isWebPresentation
optional

Write only (field is only accessible in the request body)

boolean

mediaLanguageId
optional

Write only (field is only accessible in the request body)

integer (int64)

thumbnailUrl
optional

Write only (field is only accessible in the request body)

string

sequenceNumber
optional

sequence in which the image will be visible to the user

integer (int32)

imageManagerIds
optional

Write only (field is only accessible in the request body)

< integer > array

translations
optional

information of the images which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nImage
> array

tags
optional

details related to the tags attached to the image

< Tag
> array

6.191. Images

Properties
Name Description Schema

fileName
optional

string

imageId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

mimeType
optional

enum (IMAGE_JPG,IMAGE_JPEG,IMAGE_GIF,IMAGE_PNG,IMAGE_SVG,IMAGE_ICO,IMAGE_TIFF,UNKNOWN)

version
optional

integer (int64)

url
optional

string

urls
optional

object

uploadDate
optional

string (date-time)

imageType
optional

enum (LOGO,FLOORPLAN,ROADMAP,INTERIOR,EXTERIOR,MUGSHOT,PICTURE,MAP,IMPRESSION,UNKNOWN,LOCATION_MAP,HEADER,VIDEO360,ICON,OPERATIONS,STATUSICON)

imageOrientation
optional

string

modifiedDate
optional

string (date-time)

imageManagerId
optional

integer (int64)

sequenceNumber
optional

integer (int32)

translations
optional

< I18nImage
> array

tags
optional

< Tag
> array

6.192. Implied

Properties
Name Description Schema

resourceId
optional

integer (int64)

objectId
optional

integer (int64)

6.193. Implies

Properties
Name Description Schema

impliesId
optional

integer (int64)

addToParent
optional

integer (int64)

bookDateFrom
optional

string (date)

bookDateTo
optional

string (date)

countFromMin
optional

boolean

ignoreRentability
optional

boolean

implicationManagerId
optional

integer (int64)

implyOnce
optional

boolean

included
optional

boolean

onBill
optional

boolean

parentId
optional

integer (int64)

priority
optional

integer (int32)

quantityMax
optional

integer (int64)

quantityMin
optional

integer (int64)

removable
optional

boolean

required
optional

boolean

showOnAllInPriceBill
optional

boolean

showPrice
optional

boolean

subjectsMax
optional

integer (int64)

subjectsMin
optional

integer (int64)

supplierImpliesId
optional

integer (int64)

validFrom
optional

string (date)

validTo
optional

string (date)

implied
optional

< Implied
> array

resourceIds
optional

< integer > array

resourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

stay
optional

boolean

parent
optional

boolean

6.194. ImplyPrice

Properties
Name Description Schema

price
optional

This field returns a price for a single mandatory add-on which is not subject based. In case of a subject based add-on see the subjectPrices array. In case of a subject based price this price value will be 0.

number (double)

priceArrivalDateFrom
optional

string (date)

priceArrivalDateTo
optional

string (date)

perDay
optional

string

duration
optional

Number of minutes in a day times the applicable duration of the rate, that is weekly or nightly or per booking or custom.

integer (int32)

daysOfWeek
optional

Denotes the days of week. Calculated as Sum of 2^N where N is 0 = Monday, 1 = Tuesday, …​ , 6 = Sunday

< string > array

minQuantity
optional

Deprecated. not part of imply price

deprecated

integer (int64)

maxQuantity
optional

Deprecated. not part of imply price

deprecated

integer (int64)

minNights
optional

Minimum number of nights. Applicable only when rates are varying with the number of days booked.

integer (int32)

maxNights
optional

Maximum number of nights. Applicable only when rates are varying with the number of days booked.

integer (int32)

included
optional

Deprecated. not part of imply price

deprecated

boolean

subjectIds
optional

Set of subjectId’s for which prices are configured

deprecated
unique items

< integer > array

subjectPrices
optional

If a subjectprices entry is available the regular price field is not used and will return 0.

< SubjectPrice
> array

dependsOnOffer
optional

Flag to indicate if the price depend on offers

boolean

offerIds
optional

Offer ids of offers on which the imply price depends on

< integer > array

dependsOnAddon
optional

Flag to indicate if the price depend on addons

boolean

addonIds
optional

Addon ids of addons on which the imply price depends on

< integer > array

dependsOnAccommodationtypes
optional

Depends on accommodationtype provided in request

boolean

percentagePrice
optional

Show if the price is a flat value or a percentage

boolean

appliedPerSubject
optional

boolean

6.195. InfoText

Properties
Name Description Schema

infoTextId
optional

integer (int64)

code
optional

string

name
optional

string

description
optional

string

reservations
optional

< ReservationLink
> array

display
optional

boolean

reservedResourceId
optional

integer (int64)

6.196. InfoTextItem

represent the any information that is related to the accommodationtype.

Properties
Name Description Schema

name
optional

name of the configured infotext.

string

display
optional

shows that infotext will be shown while creating reservation or not based on the configured conditions.

string

description
optional

this field contains the brief information, for which this infotext is configured.

string

6.197. Infotext

Properties
Name Description Schema

description
optional

Description associated with the infotext.

string

6.198. InfotextResponse

Properties
Name Description Schema

name
optional

string

description
optional

string

display
optional

boolean

6.199. Instalment

Properties
Name Description Schema

name
optional

string

priority
optional

integer (int32)

dueDate
optional

string (date)

dueAmount
optional

number (double)

6.200. IssueCategory

Properties
Name Description Schema

translations
optional

< I18nIssueCategory
> array

6.201. IssueItem

Properties
Name Description Schema

translations
optional

< I18nIssueItem
> array

6.202. IssueTaskSchedule

Properties
Name Description Schema

resortId
optional

integer (int64)

scheduleType
optional

enum (WEEKLY,MONTHLY,YEARLY,X_DAYS,X_YEARS)

schedules
optional

< Schedule
> array

6.203. JournalResponse

Properties
Name Description Schema

reportId
optional

integer (int64)

type
optional

enum (MUTATION_REPORT,REVENUE_DISTRIBUTION,OWNER_MUTATION_REPORT,PURCHASE_DISTRIBUTION,AR_AP_POSITION_OVERVIEW,AR_AP_REVALUATION_OVERVIEW)

reservationId
optional

integer (int64)

reportNumber
optional

integer (int64)

mutationDate
optional

string (date-time)

resortId
optional

integer (int64)

reservationNumber
optional

string

resourceCode
optional

string

ledgerNumber
optional

string

costCenter
optional

string

debitVatIncluded
optional

number

creditVatIncluded
optional

number

debitVatExcluded
optional

number

creditVatExcluded
optional

number

secondLedgerNumber
optional

string

ownerName
optional

string

accountName
optional

string

statementNumber
optional

string

statementDate
optional

string (date)

comments
optional

string

settlementNumber
optional

integer (int64)

contractType
optional

string

customerId
optional

integer (int64)

distributionChannelId
optional

integer (int64)

distributionChannelCountryCode
optional

string

workOrderId
optional

integer (int64)

referenceNumber
optional

integer (int64)

reservedResourceId
optional

integer (int64)

6.204. Language

Properties
Name Description Schema

languageId
optional

string

shortName
optional

string

defaultLanguage
optional

boolean

6.205. Ledger

Properties
Name Description Schema

ledgerId
optional

Unique id associated with each ledger.

integer (int64)

description
optional

Description of the ledger.

string

ledgerNumber
optional

Ledger number associated with each ledger.

string

name
optional

Name of the ledger.

string

6.206. LedgerGroup

Properties
Name Description Schema

ledgerGroupId
optional

integer (int64)

code
optional

string

translations
optional

< I18nLedgerGroup
> array

resortsGroups
optional

< ResortGroup
> array

6.207. LocalTime

Properties
Name Description Schema

hour
optional

integer (int32)

minute
optional

integer (int32)

second
optional

integer (int32)

nano
optional

integer (int32)

6.208. Lock

Properties
Name Description Schema

resourceLockId
optional

integer (int64)

resourceManagerId
optional

integer (int64)

reasonId
optional

integer (int64)

detailDescription
optional

string

clientId
optional

integer (int64)

accoCreatedLock
optional

integer (int64)

blockDate
optional

string (date)

startDate
optional

string (date)

endDate
optional

string (date)

type
optional

string

created
optional

string (date-time)

objectId
optional

deprecated

integer (int64)

unitId
optional

integer (int64)

resourceId
optional

integer (int64)

createdOn
optional

Write only (field is only accessible in the request body)

string (date-time)

6.209. MailAddress

Properties
Name Description Schema

zipCode
optional

zip code of the place where the accommodationtype/resort/unit/customer is located

string

poBoxZipcode
optional

zip code of the post office box

string

houseNumberSuffix
optional

a letter that might come after an address number

string

address1
optional

the field is expected to have street number, name

string

address2
optional

the field refers to apartment, floor, etc

string

address3
optional

the field expects other details related to the location

string

poBoxCity
optional

city where the post office box exist

string

city
optional

zip code of the post office box

string

mobilePhone2
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

latitude
optional

latitude in which the accommodationtype/resort/unit lies

number (double)

houseNumber
optional

house number associated to the accommodationtype/resort/unit

string

boxNumber
optional

number used as an address

string

municipality
optional

name of the general-purpose administrative subdivision

string

exposeLocation
optional

if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false

boolean

poBox
optional

numbered box in a post office where letters for an organization or person can be called for

string

mobilePhone
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

district
optional

district in which the accommodationtype/resort/unit is situated

string

privatePhone
optional

the private contact number of the owner

string

workPhone
optional

the contact number which the owner uses at work

string

email
optional

email of the contact person of the accommodationtype/resort/unit

string

longitude
optional

longitude in which the accommodationtype/resort/unit lies

number (double)

countryId
optional

Write only (field is only accessible in the request body)

integer (int64)

country
optional

ReservationDetailCountry

fax
optional

fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateContactPerson
optional

name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

6.210. MailAddress_Id

the address to which payment details needs to send.

Properties
Name Description Schema

zipCode
optional

zip code of the place where the accommodationtype/resort/unit/customer is located

string

poBoxZipcode
optional

zip code of the post office box

string

houseNumberSuffix
optional

a letter that might come after an address number

string

address1
optional

the field is expected to have street number, name

string

address2
optional

the field refers to apartment, floor, etc

string

address3
optional

the field expects other details related to the location

string

poBoxCity
optional

city where the post office box exist

string

city
optional

zip code of the post office box

string

mobilePhone2
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

latitude
optional

latitude in which the accommodationtype/resort/unit lies

number (double)

houseNumber
optional

house number associated to the accommodationtype/resort/unit

string

boxNumber
optional

number used as an address

string

municipality
optional

name of the general-purpose administrative subdivision

string

exposeLocation
optional

if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false

boolean

poBox
optional

numbered box in a post office where letters for an organization or person can be called for

string

mobilePhone
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

district
optional

district in which the accommodationtype/resort/unit is situated

string

privatePhone
optional

the private contact number of the owner

string

workPhone
optional

the contact number which the owner uses at work

string

email
optional

email of the contact person of the accommodationtype/resort/unit

string

longitude
optional

longitude in which the accommodationtype/resort/unit lies

number (double)

countryId
optional

Write only (field is only accessible in the request body)

integer (int64)

country
optional

ReservationDetailCountry_Id

fax
optional

fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateContactPerson
optional

name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

6.211. MaxxtonException

Properties
Name Description Schema

cause
optional
Properties
Name Description Schema

stackTrace
optional

< object > array

message
optional

string

localizedMessage
optional

string

suppressed
optional

< object > array

object

stackTrace
optional

< object > array

errorCode
optional

ErrorCode

fields
optional

object

internalFields
optional

object

messageWithoutFields
optional

string

message
optional

string

is1xxInformational
optional

boolean

is2xxSuccessful
optional

boolean

is3xxRedirection
optional

boolean

is4xxClientError
optional

boolean

is5xxServerError
optional

boolean

localizedMessage
optional

string

suppressed
optional

< object > array

6.212. Memo

Properties
Name Description Schema

memoId
optional

integer (int64)

memoCategoryId
optional

integer (int64)

employeeId
optional

integer (int64)

content
optional

string

creationDate
optional

string (date-time)

predefinedMemoId
optional

integer (int64)

6.213. MemoCategory

Properties
Name Description Schema

memoCategoryId
optional

integer (int64)

code
optional

string

translations
optional

< I18nMemoCategory
> array

6.214. MemoRequest

Memo for reservation which contain the memo detail

Properties
Name Description Schema

text
required

string

memoCategoryId
optional

integer (int64)

sensitive
optional

boolean

onCheckin
optional

boolean

onInvoice
optional

boolean

6.215. MemoResponse

Properties
Name Description Schema

reservationId
optional

integer (int64)

memo
optional

< Memo
> array

6.216. Metric

Properties
Name Description Schema

metricId
optional

unique id associated with each metric

integer (int64)

code
optional

unique code associated with each metric

string

translations
optional

information of the metrics which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nMetric
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nMetric
> array

6.217. Metric_Basic

details of metric

Properties
Name Description Schema

metricId
optional

unique id associated with each metric

integer (int64)

code
optional

unique code associated with each metric

string

translations
optional

information of the metrics which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nMetric_Basic
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nMetric_Basic
> array

6.218. Occupancy

Properties
Name Description Schema

resourceId
optional

integer (int64)

reserved
optional

integer (int32)

total
optional

integer (int32)

startDate
optional

string (date)

endDate
optional

string (date)

locked
optional

integer (int32)

allotted
optional

integer (int32)

bookedAllotment
optional

integer (int32)

freeAllotment
optional

integer (int32)

6.219. OfferContractType

Contract type of Offers

Properties
Name Description Schema

contracttypeId
optional

integer (int64)

resourceId
optional

integer (int64)

6.220. OfferPrice

Properties
Name Description Schema

offerCode
optional

string

offerPrice
optional

number (double)

offerPriceInclusive
optional

number (double)

minAge
optional

integer (int32)

offerPolicy
optional

string

maxAge
optional

integer (int32)

offerId
optional

integer (int64)

minCapacity
optional

integer (int32)

6.221. Offer_Detail

A offer to be added

Properties
Name Description Schema

resourceId
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

code
optional

string

resortId
optional

integer (int64)

parentId
optional

integer (int64)

path
optional

string

lowestLevel
optional

boolean

allowPriceOverride
optional

boolean

translations
optional

< I18nResource_Detail
> array

source
optional

string

showNilPriceOnBill
optional

boolean

powerplaygroupId
optional

integer (int64)

allowMovingToMainBill
optional

boolean

archivedFrom
optional

string (date)

offerExactPeriodOnly
optional

boolean

offerType
optional

string

offerPolicy
optional

string

secretOffer
optional

boolean

searchCode
optional

string

excludePriceCache
optional

boolean

offerPriority
optional

integer (int32)

allowToPublish
optional

boolean

type
optional

string

poolWeightage
optional

integer (int32)

customizableResource
optional

boolean

autovalidate
optional

boolean

6.222. OperationTask

Properties
Name Description Schema

issueIncidentId
optional

integer (int64)

resortId
optional

integer (int64)

reportedWorkOrder
optional

string

translations
optional

< I18nTask
> array

reportedBy
optional

string

onHoldReason
optional

string

workTime
optional

integer (int32)

priority
optional

integer (int32)

status
optional

enum (DECLINED,ERROR_IN_INVOICE,MAY_BE_DECLINED,BLANK,NEW,ASSIGNED,ON_HOLD,CLOSED,READY_FOR_INVOICE,BILLED,NOT_TO_BE_BILLED,ADMIN_ON_HOLD,ON_HOLD_QUOTE,INTERNAL,IN_PROGRESS,UNDEFINED)

employeeId
optional

integer (int64)

reportedDate
optional

string (date-time)

workTimeAddedDateTime
optional

string (date-time)

type
optional

enum (ISSUE_INCIDENT,CHECKIN_CHECKOUT,TASK)

issueTaskConfigId
optional

integer (int64)

expectedStartDate
optional

string (date)

expectedEndDate
optional

string (date)

resourceId
optional

integer (int64)

modifiedDate
optional

string (date-time)

parentId
optional

integer (int64)

referenceNumber
optional

integer (int64)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.223. Owner

Properties
Name Description Schema

ownerId
optional

integer (int64)

accountNr
optional

string

firstName
optional

string

lastName
optional

string

middle
optional

string

alternateName
optional

string

attentionOf
optional

string

birthDate
optional

string (date)

languageId
optional

integer (int64)

mailAllowed
optional

boolean

sendMethodId
optional

integer (int64)

sex
optional

string

origin
optional

string

originId
optional

string

socialSecurityNumber
optional

string

company
optional

deprecated

boolean

emailAllowed
optional

boolean

titleId
optional

integer (int64)

ibanNumber
optional

string

bicSwift
optional

string

companyName
optional

string

ownerGroupId
optional

integer (int64)

mailAddress
optional

Address

mailAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

fiscalTypes
optional

< OwnerFiscalType
> array

sharedOwnerShips
optional

< SharedOwnerShip
> array

ownerPool
optional

enum (OWNER,POOL,RENT_ASSURANCE_POOL,YEAR_ROUND_GUEST,BUSINESS,LOCATION,MAINTAINANCE_FUND,VENDOR,POOL_CONSUMPTION,POOL_SHARE)

birthPlace
optional

string

companyIdentificationNumber
optional

string

socialSecurityNumberIssuingCountryId
optional

integer (int64)

taxNumberIssuingCountryId
optional

integer (int64)

taxNumber
optional

string

ownerType
optional

string

dac7OwnerVerified
optional

boolean

birthCountryId
optional

integer (int64)

owner
optional

boolean

questionnaireUnsubscribed
optional

boolean

6.224. OwnerAccommodationType

Properties
Name Description Schema

ownerId
optional

integer (int64)

resourceId
optional

integer (int64)

type
optional

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

code
optional

string

resortId
optional

integer (int64)

parentId
optional

integer (int64)

path
optional

string

hasObjects
optional

boolean

dependsOnLedgerGroup
optional

boolean

priority
optional

integer (int32)

numberOfPersons
optional

integer (int32)

nrOfBedrooms
optional

number (double)

nrOfBathrooms
optional

number (double)

accotypeKindId
optional

integer (int64)

supplierOrigin
optional

string

translations
optional

< I18nResource
> array

archivedFrom
optional

string (date)

accommodationAddress
optional

Address

brand
optional

string

6.225. OwnerFinancialTransaction

Properties
Name Description Schema

ownerFinancialTransactionReportId
optional

integer (int64)

reportNumber
optional

integer (int64)

creationDate
optional

string (date-time)

bookDate
optional

string (date)

status
optional

string

6.226. OwnerFinancialTransactionJournalsDetails

Properties
Name Description Schema

ownerFinancialTransactionReportId
optional

integer (int64)

settlementId
optional

integer (int64)

settlementEntryId
optional

integer (int64)

ledgerId
optional

integer (int64)

ledgerNumber
optional

string

ledgerName
optional

string

costCenterId
optional

integer (int64)

costCenterNumber
optional

string

costCenterName
optional

string

costUnitId
optional

integer (int64)

costUnitNumber
optional

string

costUnitName
optional

string

secondLedgerId
optional

integer (int64)

secondLedgerNumber
optional

string

secondLedgerName
optional

string

debitVatIncluded
optional

number (double)

creditVatIncluded
optional

number (double)

debitVatExcluded
optional

number (double)

creditVatExcluded
optional

number (double)

ownerCurrencyId
optional

integer (int64)

6.227. OwnerFinancialTransactionJournalsReport

Properties
Name Description Schema

status
optional

string

description
optional

string

journalType
optional

string

journalNumber
optional

string

journalPeriodNumber
optional

integer (int64)

statementNumber
optional

string

statementDate
optional

string (date)

ledgerNumber
optional

string

costCenter
optional

string

costUnit
optional

string

secondLedgerNumber
optional

string

debitVatIncluded
optional

Write only (field is only accessible in the request body)

number

creditVatIncluded
optional

Write only (field is only accessible in the request body)

number

debitVatExcluded
optional

Write only (field is only accessible in the request body)

number

creditVatExcluded
optional

Write only (field is only accessible in the request body)

number

debitVatIncludedInAdminOrganisationCurrency
optional

Write only (field is only accessible in the request body)

number

creditVatIncludedInAdminOrganisationCurrency
optional

Write only (field is only accessible in the request body)

number

debitVatExcludedInAdminOrganisationCurrency
optional

Write only (field is only accessible in the request body)

number

creditVatExcludedInAdminOrganisationCurrency
optional

Write only (field is only accessible in the request body)

number

ownerCurrencyId
optional

integer (int64)

ownerCrrencyCode
optional

Write only (field is only accessible in the request body)

string

exchangeValue
optional

Write only (field is only accessible in the request body)

integer (int64)

accountId
optional

integer (int64)

adminOrganisationCurrencyId
optional

Write only (field is only accessible in the request body)

integer (int64)

adminOrganisationCurrencyCode
optional

Write only (field is only accessible in the request body)

string

adminOrganisationCurrency
optional

AdminOrganisationCurrency

ownerCurrency
optional

AccountCurrency

6.228. OwnerFiscalType

Properties
Name Description Schema

ownerFiscalTypeId
required

integer (int64)

fiscalType
optional

enum (PRIVATE_OWNER,DOMESTIC_VAT_COMPANY,FOREIGN_VAT_COMPANY)

startDate
optional

string (date)

endDate
optional

string (date)

fiscalVat
optional

string

6.229. OwnerGroup

Properties
Name Description Schema

ownerGroupId
optional

integer (int64)

name
optional

string

6.230. OwnerReservationCustomer

details related to the customer for which the reservation has been created.

Properties
Name Description Schema

customerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mailAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

firstName
optional

it specifies the first name of customer/guest.

string

lastName
optional

it specifies the last name of customer/guest.

string

countryCode
required

unique id represent the country, from where the customer belong.

string

6.231. OwnerReservedResource

the list of resources which are booked as part of the reservation.

Properties
Name Description Schema

reservedResourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

resourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

rateTypeId
optional

Write only (field is only accessible in the request body)

integer (int64)

startDate
optional

Write only (field is only accessible in the request body)

string (date)

endDate
optional

Write only (field is only accessible in the request body)

string (date)

ownerId
optional

the unique id represents the the owner of unit.

integer (int64)

unitCode
optional

the unique code associated unit.

string

unitId
optional

the unique id of unit.

integer (int64)

addonType
optional

Write only (field is only accessible in the request body)

enum (PRODUCTTYPE,RESOURCEACTIVITY,ACTIVITY,ACCOMMODATIONTYPE,EXTRA,SPECIAL,COMPOSITION)

addons
optional

field specifies the addon list applied on the reservation.

< OwnerReservedResourceAddon
> array

6.232. OwnerReservedResourceAddon

field specifies the addon list applied on the reservation.

Properties
Name Description Schema

resourceId
required

unique id associated with the addon.

integer (int64)

code
optional

unique code of addon linked to the resource which booked in the reservation.

string

parentReservedResourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

translations
optional

information of the addon which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< ReservedResourceTranslation
> array

addonType
optional

it specifies the type of the addon. Possible addon types are BREAKFAST, CLEANING, CASH_ADDONS, DEPOSIT, CUSTOM_ADDONS etc.

string

6.233. OwnerSettlement

Properties
Name Description Schema

ownerMutationReportNumber
optional

integer (int64)

settlementId
optional

integer (int64)

savePreviousBalance
optional

boolean

createdAt
optional

string (date-time)

isPoolSettlement
optional

boolean

adminOrganisationId
optional

integer (int64)

madePermanentAt
optional

string (date)

comments
optional

string

settleInvoicesUntilDate
optional

string (date)

resortId
optional

integer (int64)

overridePercentageDepartureDate
optional

string (date)

settleRedirectionUntilDate
optional

string (date)

madePermanentByEmployeeId
optional

integer (int64)

settlementDate
optional

string (date-time)

settlementNumber
optional

integer (int64)

settlementPercentage
optional

integer (int64)

settleReservationPaymentDepartureDate
optional

string (date)

settlementName
optional

string

createdByEmployeeId
optional

integer (int64)

invoicesReservationPaymentDepartureDate
optional

string (date)

status
optional

boolean

6.234. OwnerSettlementEntry

Properties
Name Description Schema

baseLedgerId
optional

integer (int64)

commissionSecondLedgerId
optional

integer (int64)

resourceId
optional

integer (int64)

reservedresourceId
optional

integer (int64)

vatDeductionBase
optional

number (double)

resourceRedirectionId
optional

integer (int64)

discount
optional

number (double)

vatDeductionBaseNow
optional

number (double)

ownerId
optional

integer (int64)

type
optional

string

fiscalVat
optional

string

entryId
optional

integer (int64)

ownerAmountVatPercentage
optional

integer (int64)

maxOwnerAmount
optional

number (double)

reservationId
optional

integer (int64)

totalPreviousOwnerAmounts
optional

number (double)

baseSecondLedgerId
optional

integer (int64)

rentAmount
optional

number (double)

ownerBillNumber
optional

string

commissionCostCenterId
optional

integer (int64)

commissionLedgerId
optional

integer (int64)

contractRuleId
optional

integer (int64)

blockedDays
optional

integer (int64)

previousCommission
optional

number (double)

invoicenumber
optional

string

advancePercentage
optional

integer (int64)

excludedDays
optional

integer (int64)

entryDate
optional

string (date-time)

realOwnerId
optional

integer (int64)

roundDifference
optional

number (double)

settlementPercentage
optional

integer (int64)

vatCommission
optional

number (double)

baseCostCenterId
optional

integer (int64)

beneficiary
optional

string

fiscalType
optional

string

previousOwnerAmount
optional

number (double)

ownerAmountDeduction
optional

number (double)

totalPrevVatOwnerAmounts
optional

number (double)

ownerCurrencyId
optional

integer (int64)

description
optional

string

vatPercentageDeductionBase
optional

integer (int64)

settlementId
optional

integer (int64)

basesumIncltax
optional

integer (int64)

commission
optional

number (double)

ownerAmount
optional

number (double)

unitId
optional

integer (int64)

contracttypeId
optional

integer (int64)

pooldistributionId
optional

integer (int64)

deductionBase
optional

number (double)

resortId
optional

integer (int64)

contraId
optional

integer (int64)

currentDeductionBase
optional

number (double)

deductionSettlementId
optional

integer (int64)

vatPercentageCommission
optional

integer (int64)

distributionChannelCurrencyId
optional

integer (int64)

deductionBaseNow
optional

number (double)

contractId
optional

integer (int64)

vatOwnerAmount
optional

number (double)

finalContractrule
optional

boolean

daysInDistribution
optional

integer (int64)

invoiceId
optional

integer (int64)

status
optional

boolean

6.235. OwnerUnit

Properties
Name Description Schema

ownerId
optional

integer (int64)

unitId
optional

integer (int64)

brand
optional

string

startDate
optional

string (date)

endDate
optional

string (date)

ownerGroupId
optional

integer (int64)

resourceGroupId
optional

integer (int64)

resourceId
optional

integer (int64)

code
optional

string

nrOfBathrooms
optional

number (double)

path
optional

string

excludeQuestionnaireStats
optional

boolean

choosableOnInternet
optional

boolean

cleaningStatus
optional

enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP)

roomCode
optional

string

nrOfBedrooms
optional

integer (int64)

archivedFrom
optional

string (date)

translations
optional

< I18nUnit
> array

accommodationAddress
optional

Address

vsi
optional

integer (int64)

origin
optional

string

originId
optional

string

6.236. OwnerUnitReservation

Properties
Name Description Schema

reservationId
optional

unique id of the reservation.

integer (int64)

distributionChannelId
optional

Write only (field is only accessible in the request body)

integer (int64)

distributionChannelCode
optional

unique code associated with distribution channel.

string

reservationCategoryId
optional

Write only (field is only accessible in the request body)

integer (int64)

categoryCode
optional

unique code associated with reservation category.

string

arrivalDate
optional

the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

departureDate
optional

unique code represent the currency in which the reservation payment is done.

string (date)

duration
optional

Write only (field is only accessible in the request body)

integer (int64)

reservationDate
optional

date on which the reservation is created.

string (date-time)

reservationNumber
optional

represent the unique number of the reservation.

string

status
optional

this field holds the status, in which reservation is created. Possible values for reservation status : DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41)

integer (int32)

expectedArrivalDateTime
optional

the date and time on which the customer is expected to arrive.

string (date-time)

expectedDepartureDateTime
optional

the date and time on which the customer departure is expected.

string (date-time)

customerId
optional

Write only (field is only accessible in the request body)

integer (int64)

customer
optional

OwnerReservationCustomer

reservedResources
optional

the list of resources which are booked as part of the reservation.

< OwnerReservedResource
> array

subjects
optional

details related to the subjects(people) and the number of subjects who will come for stay to the unit in reservation period.

< ReservedResourceSubject
> array

expectedArrivalTime
optional

Write only (field is only accessible in the request body)

string (date-time)

expectedDepartureTime
optional

Write only (field is only accessible in the request body)

string (date-time)

statusValue
optional

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

6.237. Ownership

Properties
Name Description Schema

ownershipId
optional

integer (int64)

unitId
required

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

origin
optional

string

originId
optional

string

isReportToAuth
optional

boolean

6.238. OwnershipResponse

Properties
Name Description Schema

ownershipId
optional

integer (int64)

unitId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

origin
optional

string

originId
optional

string

6.239. PackageItem

Properties
Name Description Schema

packageResourceId
optional

package resource Id associated with the package.

integer (int64)

parentId
optional

parent id associated with the package.

integer (int64)

resourceId
optional

resource id associated with the package.

integer (int64)

sequence
optional

sequence associated with the package.

integer (int64)

duration
optional

duration of the package.

integer (int32)

quantity
optional

quantity of the package.

integer (int32)

translations
optional

information of the packages available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nPackageItem
> array

6.240. PageAccommodationKindDetail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationKindDetail
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.241. PageAccommodationType

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationType
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.242. PageAccommodationTypeAddon

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypeAddon
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.243. PageAccommodationTypeAmenityLink

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypeAmenityLink
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.244. PageAccommodationTypeCostPrice

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypeCostPrice
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.245. PageAccommodationTypeDetail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypeDetail
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.246. PageAccommodationTypeImply

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypeImply
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.247. PageAccommodationTypePriority

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypePriority
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.248. PageAccommodationTypeRelease

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AccommodationTypeRelease
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.249. PageAccount

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Account
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.250. PageAddOn_Detail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AddOn_Detail
> array

sort
optional

SortObject_Detail

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.251. PageAddition

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Addition
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.252. PageAdminOrganisation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AdminOrganisation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.253. PageAllotment

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Allotment
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.254. PageAllotmentRelease

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AllotmentRelease
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.255. PageAmenity

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Amenity
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.256. PageAmenityLink

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AmenityLink
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.257. PageAmenityTreeDetail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AmenityTreeDetail
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.258. PageAvailabilityResult

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< AvailabilityResult
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.259. PageBrand

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Brand
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.260. PageCashAccount

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CashAccount
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.261. PageCashClearance

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CashClearance
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.262. PageCategorySet

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CategorySet
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.263. PageCommunication

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Communication
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.264. PageCompany

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Company
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.265. PageContract

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Contract
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.266. PageContractRule

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ContractRule
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.267. PageContractType

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ContractType
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.268. PageCreditCardAuthorisation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CreditCardAuthorisation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.269. PageCurrency

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Currency
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.270. PageCustomer

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Customer
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.271. PageCustomerClusterCategory_Basic

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CustomerClusterCategory_Basic
> array

sort
optional

SortObject_Basic

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.272. PageCustomerPhoneCall

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CustomerPhoneCall
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.273. PageCustomerStatus_Detail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< CustomerStatus_Detail
> array

sort
optional

SortObject_Detail

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.274. PageDCPaymentMethod

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< DCPaymentMethod
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.275. PageDistributionChannel_Id

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< DistributionChannel_Id
> array

sort
optional

SortObject_Id

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.276. PageDocumentBase

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< DocumentBase
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.277. PageDoorlockPincodesContainer

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< DoorlockPincodesContainer
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.278. PageDynamicField

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< DynamicField
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.279. PageEmployee

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Employee
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.280. PageEvent

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Event
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.281. PageFacility

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Facility
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.282. PageFinancialTransactionJournalsReport

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< FinancialTransactionJournalsReport
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.283. PageFinancialTransactionReport

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< FinancialTransactionReport
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.284. PageGroup

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Group
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.285. PageHousekeeping

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Housekeeping
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.286. PageHousekeepingTask

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< HousekeepingTask
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.287. PageImage

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Image
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.288. PageImages

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Images
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.289. PageImplies

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Implies
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.290. PageLedger

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Ledger
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.291. PageLedgerGroup

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< LedgerGroup
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.292. PageLock

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Lock
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.293. PageMemo

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Memo
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.294. PageMemoCategory

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< MemoCategory
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.295. PageMemoResponse

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< MemoResponse
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.296. PageOccupancy

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Occupancy
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.297. PageOfferContractType

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OfferContractType
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.298. PageOffer_Detail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Offer_Detail
> array

sort
optional

SortObject_Detail

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.299. PageOperationTask

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OperationTask
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.300. PageOwner

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Owner
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.301. PageOwnerAccommodationType

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerAccommodationType
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.302. PageOwnerFinancialTransaction

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerFinancialTransaction
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.303. PageOwnerFinancialTransactionJournalsDetails

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerFinancialTransactionJournalsDetails
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.304. PageOwnerFinancialTransactionJournalsReport

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerFinancialTransactionJournalsReport
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.305. PageOwnerGroup

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerGroup
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.306. PageOwnerSettlement

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerSettlement
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.307. PageOwnerSettlementEntry

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerSettlementEntry
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.308. PageOwnerUnit

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerUnit
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.309. PageOwnerUnitReservation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnerUnitReservation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.310. PageOwnershipResponse

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< OwnershipResponse
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.311. PagePackageItem

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PackageItem
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.312. PagePaymentMethod

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PaymentMethod
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.313. PagePaymentTermSet

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PaymentTermSet
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.314. PagePeriodicalTask

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PeriodicalTask
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.315. PagePointsOfInterest

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PointsOfInterest
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.316. PagePointsOfInterestCategory

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PointsOfInterestCategory
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.317. PagePredefinedMemo

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< PredefinedMemo
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.318. PageQualityLevel

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< QualityLevel
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.319. PageRangeAvailabilityResult

list of filtered result as per the given criterias provided by the user

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RangeAvailabilityResult
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.320. PageRate

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Rate
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.321. PageRateResource

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RateResource
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.322. PageRateType

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RateType
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.323. PageRegion

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Region
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.324. PageRentability

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Rentability
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.325. PageRentabilitySet

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RentabilitySet
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.326. PageRepresentation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Representation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.327. PageRepresentationDistributionChannel

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RepresentationDistributionChannel
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.328. PageReseller

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Reseller
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.329. PageResellerStopSell

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResellerStopSell
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.330. PageReservation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Reservation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.331. PageReservationAdditionResponse

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationAdditionResponse
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.332. PageReservationAmenity

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationAmenity
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.333. PageReservationBill

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationBill
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.334. PageReservationCategory

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationCategory
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.335. PageReservationCostPrice

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationCostPrice
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.336. PageReservationCustomField

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationCustomField
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.337. PageReservationDetailResponse

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationDetailResponse
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.338. PageReservationDoorlock

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationDoorlock
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.339. PageReservationInstalmentResponse

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationInstalmentResponse
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.340. PageReservationPayment

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationPayment
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.341. PageReservationPaymentContainer

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationPaymentContainer
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.342. PageReservationReminder

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationReminder
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.343. PageReservationReservedResourceSubject

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationReservedResourceSubject
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.344. PageReservationSnapshot

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationSnapshot
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.345. PageReservationTermAndCondition

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservationTermAndCondition
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.346. PageReservedResourceOfReservation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservedResourceOfReservation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.347. PageReservedResourcePerReservation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservedResourcePerReservation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.348. PageReservedResourcePreferencePerReservation

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservedResourcePreferencePerReservation
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.349. PageReservedResourceSubjectQuantity

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservedResourceSubjectQuantity
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.350. PageReservedResourceUnitAllotment

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ReservedResourceUnitAllotment
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.351. PageResort

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Resort
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.352. PageResortActivity

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResortActivity
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.353. PageResortAmenityLink

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResortAmenityLink
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.354. PageResortDC

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResortDC
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.355. PageResortDetailWithUnitMap

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResortDetailWithUnitMap
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.356. PageResortPriority

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResortPriority
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.357. PageResortSearchList

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResortSearchList
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.358. PageResourceAddition

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResourceAddition
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.359. PageResourceBudget

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResourceBudget
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.360. PageResourceLockReason

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResourceLockReason
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.361. PageResourceReservability

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResourceReservability
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.362. PageResourceReservabilityAllotment

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ResourceReservabilityAllotment
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.363. PageRevenueDistribution

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RevenueDistribution
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.364. PageRevenueDistributionJournal

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RevenueDistributionJournal
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.365. PageRoom

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Room
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.366. PageRoomAmenityLink

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RoomAmenityLink
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.367. PageRoomType

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< RoomType
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.368. PageSearchInfoTextResponse

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< SearchInfoTextResponse
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.369. PageSendMethod

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< SendMethod
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.370. PageShowMoment

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< ShowMoment
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.371. PageSource

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Source
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.372. PageSourceCategory

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< SourceCategory
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.373. PageState

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< State
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.374. PageStaySummary

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< StaySummary
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.375. PageSubjectCategory

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< SubjectCategory
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.376. PageTargetAmount

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< TargetAmount
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.377. PageTemporaryResourceAddition

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< TemporaryResourceAddition
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.378. PageTransaction

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Transaction
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.379. PageUnitAmenityLink

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitAmenityLink
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.380. PageUnitAvailabilityResult

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitAvailabilityResult
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.381. PageUnitDetail

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitDetail
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.382. PageUnitDetail_Id

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitDetail_Id
> array

sort
optional

SortObject_Id

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.383. PageUnitDoorlock

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitDoorlock
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.384. PageUnitReservability

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitReservability
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.385. PageUnitReservabilityPeriod

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< UnitReservabilityPeriod
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.386. PageVideo

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Video
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.387. PageWorkorder

Properties
Name Description Schema

totalPages
optional

integer (int32)

totalElements
optional

integer (int64)

number
optional

integer (int32)

size
optional

integer (int32)

numberOfElements
optional

integer (int32)

content
optional

< Workorder
> array

sort
optional

SortObject

first
optional

boolean

last
optional

boolean

empty
optional

boolean

6.388. Pageable

Properties
Name Description Schema

page
optional

Minimum: 0

integer (int32)

size
optional

Minimum: 1

integer (int32)

sort
optional

< string > array

6.389. PageableObject

Properties
Name Description Schema

paged
optional

boolean

unpaged
optional

boolean

pageNumber
optional

integer (int32)

pageSize
optional

integer (int32)

offset
optional

integer (int64)

sort
optional

SortObject

6.390. PageableObject_Basic

Properties
Name Description Schema

paged
optional

boolean

unpaged
optional

boolean

pageNumber
optional

integer (int32)

pageSize
optional

integer (int32)

offset
optional

integer (int64)

sort
optional

SortObject_Basic

6.391. PageableObject_Detail

Properties
Name Description Schema

paged
optional

boolean

unpaged
optional

boolean

pageNumber
optional

integer (int32)

pageSize
optional

integer (int32)

offset
optional

integer (int64)

sort
optional

SortObject_Detail

6.392. PageableObject_Id

Properties
Name Description Schema

paged
optional

boolean

unpaged
optional

boolean

pageNumber
optional

integer (int32)

pageSize
optional

integer (int32)

offset
optional

integer (int64)

sort
optional

SortObject_Id

6.393. PaymentLink

Properties
Name Description Schema

url
optional

string

6.394. PaymentMethod

Properties
Name Description Schema

paymentMethod
optional

name of the payment method.

string

code
optional

unique code associated with the payment method.

string

paymentType
optional

type of the payment method.

string

paymentProvider
optional

service provider of the payment method.

string

minDaysBeforeArrival
optional

payment method is applicable on or before x days of arrival date.

integer (int32)

maxDaysBetweenBookAndArrivalDate
optional

payment method is applicable when difference between reservation book date and arrival date is less than or equal to max days specified with this field value.

integer (int64)

translations
optional

information of the payment methods which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nPaymentMethod
> array

6.395. PaymentMethodDefinition

the payment method used for payment

Properties
Name Description Schema

brandName
optional

Write only (field is only accessible in the request body)

string

code
optional

the payment method code.

string

name
optional

the payment method name.

string

6.396. PaymentOption

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 instalments. In case no payment option is set, it will take the one with the highest priority for the instalments.

Properties
Name Description Schema

paymentTermSetId
optional

integer (int64)

name
optional

string

description
optional

string

priority
optional

integer (int32)

autoPay
optional

boolean

nonRefundable
optional

boolean

customerInstalments
optional

< Instalment
> array

agentInstalments
optional

< Instalment
> array

6.397. PaymentTermSet

Properties
Name Description Schema

paymentTermSetId
optional

integer (int64)

priority
optional

integer (int32)

minArrivalDeviation
optional

integer (int32)

maxArrivalDeviation
optional

integer (int32)

validFrom
optional

string (date)

validTo
optional

string (date)

arrivalDateFrom
optional

string (date)

arrivalDateTo
optional

string (date)

minStayLength
optional

integer (int32)

maxStayLength
optional

integer (int32)

paymentTermSetType
optional

enum (GENERAL,ENERGY)

nonRefundable
optional

boolean

preBooking
optional

boolean

translations
optional

< I18nPaymentTermSet
> array

6.398. PeriodicalTask

Properties
Name Description Schema

issueTaskConfigId
optional

integer (int64)

code
optional

string

comments
optional

string

resortIds
optional

< integer > array

scheduleType
optional

enum (WEEKLY,MONTHLY,YEARLY,X_DAYS,X_YEARS)

individualWorkorder
optional

boolean

issueCategories
optional

IssueCategory

i18nIssueCategory
optional

Write only (field is only accessible in the request body)

< I18nIssueCategory
> array

issueItem
optional

IssueItem

i18nIssueItem
optional

Write only (field is only accessible in the request body)

< I18nIssueItem
> array

translations
optional

< I18nPeriodicalTask
> array

areas
optional

< Area
> array

areaId
optional

Write only (field is only accessible in the request body)

integer (int64)

i18nArea
optional

Write only (field is only accessible in the request body)

< I18nArea
> array

workOrderTaskConfigurationResorts
optional

Write only (field is only accessible in the request body)

< WorkOrderTaskConfigurationResort
> array

issueTaskSchedules
optional

< IssueTaskSchedule
> array

6.399. Person

the details of the person accommodated in an accommodationtype

Properties
Name Description Schema

persons
optional

list of details of person on which search is to be applied on

< PersonDetail
> array

6.400. PersonDetail

list of details of person on which search is to be applied on

Properties
Name Description Schema

maxAge
optional

Max age of the subject for which search is to be made. In the case of the oldest subject without a maxAge configured the value 'null' can be provided instead of the actual max Age.

string

quantity
optional

quantity of the subject for which search is to be made

integer (int32)

6.401. Persons

details related to the persons for whom the accommodationtype is booked in reservation.

Properties
Name Description Schema

age
optional

Age of the person or maxAge of the subject. In the case of the oldest subject without a maxAge configured, the value 'null' can be provided instead of the actual age.

integer (int32)

quantity
required

specify the no. of persons are for which the accommodation is booked.

integer (int32)

6.402. Pincode

Properties
Name Description Schema

doorlockPincodeId
optional

integer (int64)

pincode1
optional

string

pincode2
optional

string

arrivalDate
optional

string (date)

statusCode1
optional

boolean

statusCode2
optional

boolean

6.403. PointsOfInterest

Properties
Name Description Schema

pointsOfInterestId
optional

integer (int64)

code
optional

string

startDate
optional

string (date)

endDate
optional

string (date)

visibleFrom
optional

string (date)

visibleTo
optional

string (date)

pointsOfInterestCategoryId
optional

integer (int64)

url
optional

string

resortIds
optional

< integer > array

priority
optional

integer (int32)

price
optional

string

startTime
optional

LocalTime

endTime
optional

LocalTime

priceChildren
optional

string

priceAdult
optional

string

priceValuePoint
optional

string

translations
optional

< I18nPointsOfInterest
> array

6.404. PointsOfInterestCategory

Properties
Name Description Schema

pointsOfInterestCategoryId
optional

integer (int64)

code
optional

string

translations
optional

< I18nPointsOfInterestCategory
> array

6.405. PredefinedMemo

Properties
Name Description Schema

preDefinedMemoId
optional

integer (int64)

memoCategoryId
optional

integer (int64)

code
optional

string

priority
optional

integer (int64)

validFrom
optional

string (date-time)

validTo
optional

string (date-time)

content
optional

string

translations
optional

< I18nPredefinedMemo
> array

6.406. Preference

a preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit.

Properties
Name Description Schema

id
optional

it specifies the id of the amenity or unit based on the type field value is amenity or unit respectively.

integer (int64)

type
required

it specifies the type of preference : AMENITY, UNIT or ADJACENT.

enum (UNIT,AMENITY,ADJACENT)

remark
optional

Remark to be added with the ADJACENT type preferences.

string

6.407. PreferencePrice

Properties
Name Description Schema

price
optional

This field returns single value rate and qrv resourcebase rate. In case of a subject based preference add-on see the subjectPrices array. In case of a subject based price this price value will be 0.

number (double)

priceArrivalDateFrom
optional

string (date)

priceArrivalDateTo
optional

string (date)

priceBookDateFrom
optional

string (date-time)

priceBookDateTo
optional

string (date-time)

subjectIds
optional

Set of subjectId’s for which prices are configured

unique items

< integer > array

subjectPrices
optional

subject based rates for groups of persons. If a subjectprices entry is available the regular price field will not be used and will return 0.

< SubjectPrice
> array

appliedPerSubject
optional

boolean

6.408. PriceEnginePersons

List of details of person on which search is to be applied on

Properties
Name Description Schema

maxAge
optional

Max age of the subject for which search is to be made. In the case of the oldest subject without a maxAge configured the value 'null' can be provided instead of the actual max Age.

integer (int64)

quantity
optional

Quantity of the subject for which search is to be made

integer (int32)

6.409. PriceEngineSubject

The details of the person accommodated in an accommodationtype

Properties
Name Description Schema

persons
optional

List of details of person on which search is to be applied on

< PriceEnginePersons
> array

6.410. PriceRangeSearchRequest

Properties
Name Description Schema

distributionChannelId
required

if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown.

integer (int64)

arrivalDateFrom
required

the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

numberOfDaysInResult
optional

the number of days starting from the arrivalDate for which the price range search has been carried out and the numberOfDaysInResult should be passed in days ex: 7. Maximum set limit is 30 days.

integer (int32)

offerCode
optional

unique code associated with offer on the bases of which accommodationtype is to be filtered

string

offerId
optional

unique id associated with offer on the bases of which accommodationtype is to be filtered

integer (int64)

subjects
optional

Person

resortIds
optional

list of resort ids passed to fetch accommodationtypes which belong to the provided resorts

unique items

< integer > array

resourceIds
optional

The accommodationtype ids which user wants to apply search on and this field accepts only single resource Id.

unique items

< integer > array

petQuantity
optional

the number of pets accommodated in the accommodationtype

integer (int32)

amenityIds
optional

list of amenity ids which are linked to the accommodationtype

unique items

< integer > array

accommodationKindIds
optional

list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched

unique items

< integer > array

filterOptions
optional

filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals' and 'departures'.If a user is passing these filter options then all the possible departures and arrivals available for the requested criteria are displayed in response.

< string > array

preBooking
optional

an option to return prebooking prices along with normal prices. By default the value of preBooking is false, if not specified in the request. To enable preBooking support, set the value as true in the request.

boolean

voucherCode
optional

unique code associated with voucher on the bases of which accommodationtype is to be filtered

string

unitId
optional

unitId passed to fetch accommodationtypes which belong to the provided unitId

integer (int64)

rateTypeId
optional

Rate type id which will be used to fetch availability. If not provided, then the first rate type will be picked up from the rate types linked to distribution channel and ordered in ascending order of priority.

integer (int64)

redeemableLoyaltyPoints
optional

Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter.

integer (int32)

qualityLevelIds
optional

unique items

< integer > array

6.411. QrvValue

this field should be used in relation with valueType field when it’s value is QRV

Properties
Name Description Schema

minQuantity
optional

integer (int64)

value
optional

number (double)

6.412. QualityLevel

Properties
Name Description Schema

qualityLevelId
optional

integer (int64)

code
optional

string

archivedFrom
optional

string (date)

priority
optional

integer (int32)

translations
optional

< I18nQualityLevel
> array

6.413. RangeAvailabilityResult

Properties
Name Description Schema

resourceId
optional

integer (int64)

basePrice
optional

number (double)

basePriceInclusive
optional

number (double)

referencePrice
optional

number (double)

referencePriceInclusive
optional

number (double)

offerPrice
optional

number (double)

offerPriceInclusive
optional

number (double)

offerCode
optional

string

offerName
optional

string

offerPolicy
optional

string

arrivalDate
optional

string (date)

departureDate
optional

string (date)

arrivalDowMask
optional

string

duration
optional

integer (int32)

accommodationKindId
optional

integer (int64)

resourceCode
optional

string

resortId
optional

integer (int64)

maxCapacity
optional

integer (int32)

maxPetCapacity
optional

integer (int32)

rateTypeId
optional

The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type

integer (int64)

preBooking
optional

Defines if the stay has a preBooking price

boolean

loyaltyPrice
optional

Price including offers and loyalty

number (double)

loyaltyPriceInclusive
optional

Price including offers, loyalty and additional costs

number (double)

requiredLoyaltyPoints
optional

The required number of points for this loyalty price

integer (int32)

freeLoyaltyDuration
optional

The number of free nights for this number of loyalty points

integer (int32)

qualityLevelId
optional

integer (int64)

6.414. Rate

Properties
Name Description Schema

rateId
optional

Ratetype the rate is linked to

integer (int64)

value
optional

Actual rate value, price.

number (double)

remark
optional

Optional remark/comment about the specific rate

string

quantifier
optional

Possible values are: ABSOLUTE ( +/- an amount to the rate), OVERRIDE (override the rate), RELATIVE( +/- a percentage to the rate).

string

valueType
optional

Type of value, price. This can be "single" (base ) /price "qrv" (price depending on another resource or subject)

string

qrvType
optional

this field should be used in relation with valueType field when it’s value is QRV

enum (EQUAL,RESOURCE,SUBJECT,AMENITY)

duration
optional

Usage_unit, which length of stay the price is valid for

integer (int64)

minDuration
optional

Minimal length of stay(number of nights) the price is valid for(only applies in case of nightly rates).

integer (int64)

maxDuration
optional

Maximum length of stay(number of nights) the price is valid for(only applies in case of nightly rates).

integer (int64)

priority
optional

Priority, the rate with the highest priority will be the preferred one

integer (int64)

bookdateFrom
optional

The reservation book date should be greater than equal to this date.

string (date-time)

bookdateTo
optional

The reservation book date should be less than equal to this date.

string (date-time)

usageDurationFrom
optional

Defines the minium part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2.

integer (int64)

usageDurationTo
optional

Defines the maximum part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2.

integer (int64)

daysOfWeek
optional

The day the rate is applicable/valid

< string > array

rateTypes
optional

Write only (field is only accessible in the request body)

< RateTypeForRate
> array

validFrom
optional

Valid from arrivaldate. the arrival date needs to be greater than equal to validFrom date

string (date)

validTo
optional

Valid till arrivaldate. The arrivaldate needs to less than the provided date.

string (date)

resourceId
optional

The resource(accommodationtype, addon) the rate applies to

integer (int64)

maxDeviation
optional

Maximum number of days between book date and arrival date when the price will be valid.

integer (int64)

minDeviation
optional

Minimal number of days between book date and arrival date when the price will be valid.

integer (int64)

rateTypeIds
optional

Ratetypes the rate is linked to

< integer > array

translations
optional

< I18nRate
> array

qrvValues
optional

this field should be used in relation with valueType field when it’s value is QRV

< QrvValue
> array

usageDowList
optional

Write only (field is only accessible in the request body)

< string > array

minDurationMinutes
optional

integer (int64)

maxDurationMinutes
optional

integer (int64)

6.415. RateResource

Properties
Name Description Schema

rateId
optional

Ratetype the rate is linked to

integer (int64)

value
optional

Actual rate value, price.

number (double)

remark
optional

Optional remark/comment about the specific rate

string

quantifier
optional

Possible values are: ABSOLUTE ( +/- an amount to the rate), OVERRIDE (override the rate), RELATIVE( +/- a percentage to the rate).

string

valueType
optional

Type of value, price. This can be "single" (base ) /price "qrv" (price depending on another resource or subject)

string

qrvType
optional

this field should be used in relation with valueType field when it’s value is QRV

enum (EQUAL,RESOURCE,SUBJECT,AMENITY)

duration
optional

Usage_unit, which length of stay the price is valid for

integer (int64)

minDuration
optional

Minimal length of stay(number of nights) the price is valid for(only applies in case of nightly rates).

integer (int64)

maxDuration
optional

Maximum length of stay(number of nights) the price is valid for(only applies in case of nightly rates).

integer (int64)

priority
optional

Priority, the rate with the highest priority will be the preferred one

integer (int64)

bookdateFrom
optional

The reservation book date should be greater than equal to this date.

string (date-time)

bookdateTo
optional

The reservation book date should be less than equal to this date.

string (date-time)

usageDurationFrom
optional

Defines the minium part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2.

integer (int64)

usageDurationTo
optional

Defines the maximum part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2.

integer (int64)

daysOfWeek
optional

The day the rate is applicable/valid

< string > array

rateTypes
optional

Write only (field is only accessible in the request body)

< RateTypeForRate
> array

validFrom
optional

Valid from arrivaldate. the arrival date needs to be greater than equal to validFrom date

string (date)

validTo
optional

Valid till arrivaldate. The arrivaldate needs to less than the provided date.

string (date)

resourceId
optional

The resource(accommodationtype, addon) the rate applies to

integer (int64)

maxDeviation
optional

Maximum number of days between book date and arrival date when the price will be valid.

integer (int64)

minDeviation
optional

Minimal number of days between book date and arrival date when the price will be valid.

integer (int64)

rateTypeIds
optional

Ratetypes the rate is linked to

< integer > array

translations
optional

< I18nRate
> array

qrvValues
optional

this field should be used in relation with valueType field when it’s value is QRV

< QrvValue
> array

applicableTo
optional

< CashFlowRuleResource
> array

resources
optional

Write only (field is only accessible in the request body)

< CashFlowRuleResource
> array

usageDowList
optional

Write only (field is only accessible in the request body)

< string > array

minDurationMinutes
optional

integer (int64)

maxDurationMinutes
optional

integer (int64)

6.416. RateType

Properties
Name Description Schema

rateTypeId
optional

integer (int64)

code
optional

string

priority
optional

integer (int64)

isDefault
optional

boolean

translations
optional

< I18nRateType
> array

rateTypeDchannel
optional

Write only (field is only accessible in the request body)

< RateTypeDchannel
> array

name
optional

string

currencyId
optional

integer (int64)

currencyCode
optional

string

endDate
optional

string (date-time)

distributionChannels
optional

< RateTypeDchannel
> array

6.417. RateTypeDchannel

Properties
Name Description Schema

distributionChannelId
optional

Write only (field is only accessible in the request body)

integer (int64)

bookdateFrom
optional

string (date-time)

bookdateTo
optional

string (date-time)

startDate
optional

string (date-time)

endDate
optional

string (date-time)

id
optional

integer (int64)

6.418. RateTypeForRate

Properties
Name Description Schema

rateTypeId
optional

integer (int64)

6.419. Region

Properties
Name Description Schema

regionId
optional

integer (int64)

code
optional

string

name
optional

Write only (field is only accessible in the request body)

string

parentId
optional

integer (int64)

priority
optional

integer (int64)

lowestLevel
optional

boolean

geoShapePoints
optional

< array > array

translations
optional

< I18NRegion
> array

childIds
optional

< integer > array

breadCrumbs
optional

string

i18n
optional

Write only (field is only accessible in the request body)

< I18NRegion
> array

6.420. Rentability

Properties
Name Description Schema

rentabilityId
optional

integer (int64)

managerId
optional

integer (int64)

dateBegin
optional

string (date)

dateEnd
optional

string (date)

minDeviationArrDepDate
optional

integer (int64)

maxDeviationArrDepDate
optional

integer (int64)

isTemporary
optional

integer (int64)

bookDateFrom
optional

string (date-time)

bookDateTo
optional

string (date-time)

maxTimeAfterBookDate
optional

integer (int64)

minTimeAfterBookDate
optional

integer (int64)

gap
optional

integer (int64)

distributionChannelIds
optional

< integer > array

resourceIds
optional

< integer > array

rentabilityMarkers
optional

< RentabilityMarkerDetail
> array

6.421. RentabilityDetail

Rentability for accommodation which contain the rentability configuration detail

Properties
Name Description Schema

managerId
optional

integer (int64)

dateBegin
required

The date from when the rentability is valid

string (date)

dateEnd
required

he date till when the rentability is valid

string (date)

bookdateFrom
optional

string (date-time)

bookdateTo
optional

string (date-time)

minDeviationArrDepDate
optional

The minimum difference (in days) between the booking date and arrival date

integer (int64)

maxDeviationArrDepDate
optional

The maximum difference (in days) between the booking date and arrival date

integer (int64)

isTemporary
optional

integer (int64)

maxTimeAfterBookDate
optional

integer (int64)

minTimeAfterBookDate
optional

integer (int64)

isArrival
optional

boolean

isDeparture
optional

boolean

dayMin
optional

integer (int64)

dayMax
optional

integer (int64)

daysOfWeek
optional

The days on which the rentability is valid

< string > array

6.422. RentabilityMarkerDetail

Properties
Name Description Schema

rentabilityMarkerId
optional

integer (int64)

type
optional

string

timeMin
optional

This property is in the form of minutes that denotes number of days the rentability marker applies.

integer (int64)

dowMask
optional

This property is a bitmask in the form of a number that denotes which weekdays the rentability marker applies. The value of Monday(1), Tuesday(2), Wednesday(4), Thursday(8), Friday(16), Saturday(32), and Sunday(64) are represented by the numbers 1,2,4,8,16,32,64. For example, a dowMask value of 17 means Monday and Friday are applicable. This can be calculated by summing the separate values(16+1=17).

integer (int64)

timeMax
optional

integer (int64)

6.423. RentabilitySet

Properties
Name Description Schema

rentabilitySetId
optional

integer (int64)

resortId
optional

integer (int64)

rentabilityManagerId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

code
optional

string

preBooking
optional

boolean

translations
optional

information of the rentability which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nRentabilitySet
> array

6.424. Report

Properties
Name Description Schema

reportCode
optional

string

6.425. ReportUrl

Properties
Name Description Schema

reportType
optional

enum (GENERAL,EMPLOYEE,CUSTOMER,AGENT,OWNER)

6.426. Representation

Properties
Name Description Schema

representationId
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

resourceId
optional

integer (int64)

visible
optional

boolean

bookable
optional

boolean

distributionChannelIds
optional

< integer > array

translations
optional

< I18nRepresentation
> array

6.427. RepresentationDistributionChannel

Distribution channels detail which is to be added to a representation

Properties
Name Description Schema

distributionChannelId
optional

integer (int64)

name
optional

string

code
optional

string

path
optional

string

representationId
optional

integer (int64)

channelId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.428. Requirement

The minimum number of subjects which are mandatory for making a reservation. If requirement of 4 adults is configured then 4 adults are mandatory for making a reservation

Properties
Name Description Schema

managerId
optional

Write only (field is only accessible in the request body)

integer (int64)

required
optional

The minimum number of subjects which are mandatory to book the accommodation/unit

integer (int32)

subject
optional

details related to the subject

< Subject
> array

6.429. Reseller

Properties
Name Description Schema

resellerId
optional

integer (int64)

code
optional

string

description
optional

string

distributionChannelId
optional

integer (int64)

name
optional

string

6.430. ResellerStopSell

Properties
Name Description Schema

resellerStopSellId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

resellerId
optional

integer (int64)

reservableValue
optional

integer (int32)

resourceId
optional

integer (int64)

stopSellType
optional

enum (BLOCKING,LOWERING,RESTRICTION)

6.431. Reservation

Properties
Name Description Schema

reservationId
optional

integer (int64)

categoryName
optional

string

categoryCode
optional

string

arrivalDate
optional

string (date)

customerId
optional

integer (int64)

departureDate
optional

string (date)

distributionChannelId
optional

integer (int64)

modifiedDate
optional

string (date-time)

reservationCategoryId
optional

integer (int64)

reservationDate
optional

string (date-time)

reservationNumber
optional

string

resortId
optional

integer (int64)

status
optional

Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41)

integer (int32)

supplierVoucher
optional

If a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier booking reference number will be available in this field.

string

tncSigned
optional

boolean

tncSignedDate
optional

string (date)

tncSigneeCustomerName
optional

string

type
optional

Possible values for reservation type
1.RESERVATION:The RESERVATION is a regular reservation.
2.INVOICE:The INVOICE is used to create an invoice for example for owners.
3.CASH:CASH is a cash transaction done on location for example in a shop.
4.ALLOTMENT:ALLOTMENT is an open stay for allotment, this needs to be booked as a regular booking by a channel that is based on this allotment.

string

expectedArrivalDateTime
optional

string (date-time)

expectedDepartureDateTime
optional

string (date-time)

validationStatus
optional

PARK 111(-101)
PARK 222(-99)
PARK 333(-86)
PARK 444(-42)
PARK 555(-23)
PARK 666(-22)
PARK 777(-21)
PARK 888(-20)
PARK 999(-19)
NEVER TO BE SENT(-5)
UNVALIDATED(0)
VALIDATING(11)
TO BE PROCESSED(15)
SEMI AUTOMATICALLY VALIDATED(16)
TO BE VALIDATED(20)
VALID(21)
AUTOMATICALLY VALIDATED(22)
SENT(31)
TO BE INVOICED(41)
INFORMATION NOT SEND(51)
INFORMATION SEND(55)

integer (int64)

voucher
optional

It’s an external booking reference number of the system, from where the reservation was made.

string

parentId
optional

integer (int64)

cancelDate
optional

string (date)

originId
optional

string

origin
optional

string

expireDate
optional

string (date-time)

printedDate
optional

string (date)

resellerId
optional

integer (int64)

statusValue
optional

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

sendMethodId
optional

integer (int64)

memoManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

paymentTermSetId
optional

integer (int64)

reservationKind
optional

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

enum (ACCOMMODATION_RESERVATION,ADDON_RESERVATION,GROUP_RESERVATION)

payingCustomerId
optional

integer (int64)

externalBookingReference
optional

string

expectedArrivalTime
optional

Write only (field is only accessible in the request body)

string (date-time)

expectedDepartureTime
optional

Write only (field is only accessible in the request body)

string (date-time)

6.432. ReservationAccommodationType

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

Properties
Name Description Schema

resourceId
required

unique id associated with each accommodationtype.

integer (int64)

unitId
optional

unique id associated with each unit.

integer (int64)

arrivalDate
required

the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

duration
required

the duration for which a user wants to make a reservation and the duration should be passed in days ex: 7.

integer (int32)

offerCode
optional

it is a discount code which can be applied in a reservation.

string

useLoyaltyPoints
optional

Loyalty points to be used for the reservation

integer (int32)

useLoyaltyFreeNights
optional

Nights to redeem on saved loyalty points

integer (int32)

additions
optional

the product and extras which a user wants to book in a reservation.

< ReservationAddition
> array

preferences
optional

a preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit.

< Preference
> array

subjects
optional

ReservationSubjectCriteria

travelParties
optional

The list of travel parties staying

< ReservationTravelPartyCriteria
> array

vehicles
optional

The list of vehicles with the booking

< ReservationVehicleCriteria
> array

rateTypeId
optional

unique id of the rate types, for which the cashflow is applicable.

integer (int64)

removeImplies
optional

list of impliesId which want to be removed.

< integer > array

voucherCode
optional

Voucher code which can be applied to a reservation. This code is case sensitive. Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.

string

6.433. ReservationAddition

the product and extras which a user wants to book in a reservation.

Properties
Name Description Schema

additionResourceId
required

unique id represent the addition linked to the resource.

integer (int64)

startDate
required

the date from which the addition is accessed in the accommodationtype. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

endDate
required

the date till which the addition can be accessed in the accommodationtype. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

quantity
required

this field specify the no. of additions which are applied to accommodationtype.

Minimum: 1

integer (int32)

memo
optional

memo for the addition

Maximum Length: 500
Minimum Length: 0

string

6.434. ReservationAdditionCriteria

request body to fetch reservation addition groups.

Properties
Name Description Schema

accommodationTypes
optional

< AdditionAccommodationType
> array

categoryCode
required

string

distributionChannelCode
required

string

6.435. ReservationAdditionResponse

Properties
Name Description Schema

code
optional

string

groupId
optional

integer (int64)

additions
optional

< ReservationAddition
> array

parentId
optional

integer (int64)

priority
optional

integer (int64)

translations
optional

< I18nResourceGroup
> array

6.436. ReservationAddress

it specify the address information of customer.

Properties
Name Description Schema

zipCode
required

zip code of the place from where the customer belong.

string

poBoxZipcode
optional

zip code of the post office box.

string

houseNumberSuffix
optional

a letter that might come after an address number. Max allowed length: 25 characters.

string

address1
required

the field is expected to have street number, name

string

address2
optional

the field refers to apartment, floor and allows a maximum length of 100 characters

string

address3
optional

the field expects other details related to the location and allows a maximum length of 100 characters.

string

poBoxCity
optional

it specify the city, where post office box exist and allows a maximum length of 100 characters.

string

city
required

it represent the city of customer/guest and allows a maximum length of 100 characters.

string

mobilePhone2
optional

alternative mobilephone number through which the customer/guest in the accommodationtype can be contacted and allows a maximum length of 25 characters.

string

latitude
optional

specify the latitude of customer’s/guest’s home location.

number (double)

longitude
optional

specify the longitude of customer’s/guest’s home location.

number (double)

stateId
optional

unique id represents the state of the customer’s home is located.

integer (int64)

houseNumber
optional

it is the house number of customer. Max allowed length: 10 characters.

string

countryCode
required

unique id represent the country, from where the customer belong.

string

poBox
optional

numbered box in a post office where letters for an organization or person can be called for and allows a maximum length of 20 characters.

string

mobilePhone
optional

mobilephone number through which the customer/guest coming for stay in the accommodationtype can be contacted and allows a maximum length of 25 characters.

string

district
required

district name in which the customer city is located and allows a maximum length of 100 characters.

string

privatePhone
optional

the private contact number of the customer and allows a maximum length of 25 characters.

string

workPhone
optional

the contact number at work by which the customer can be reached and allows a maximum length of 25 characters.

string

email
required

email of the customer/guest.

string

6.437. ReservationAmenity

Properties
Name Description Schema

reservationId
optional

integer (int64)

amenities
optional

< ReservedResourceAmenity
> array

6.438. ReservationBill

Properties
Name Description Schema

reservationId
optional

integer (int64)

reservationBillLines
optional

< ReservationBillLine
> array

6.439. ReservationBillLine

Properties
Name Description Schema

reservationBillId
optional

integer (int64)

reservationId
optional

integer (int64)

cashflowRuleName
optional

string

resourceName
optional

string

description
optional

string

quantity
optional

integer (int32)

multiplier
optional

integer (int32)

value
optional

number (double)

total
optional

number (double)

billLineType
optional

RESERVED_RESOURCE(10)
RESORT_ARTICLE(20)
SUBTOTAL(40)
WARRANT(50)
VAT(60)
TOTAL(70)
PAID_AMOUNT(80)
DUE_AMOUNT(90)
STAY_ARTICLE(130)
WITHHOLDINGARTICLE(140)
COST_TYPE(180)
TAX(250)
TOTAL_EXCL_TAX(260)
CANCEL_COMPENSATION(190)
TO_PAY(120)
COMMISSION(100)
COMMISSION_VAT(110)

integer (int32)

totalBottomSequenceNr
optional

integer (int32)

reservedResourceId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

payerType
optional

enum (CUSTOMER,PAYING_CUSTOMER,AGENT)

virtualOverrideValue
optional

number (double)

resourceId
optional

integer (int64)

reservationBillLineId
optional

integer (int64)

resourceType
optional

string

resourceDescription
optional

string

type
optional

string

vatRate
optional

number (double)

redeemedLoyaltyPoints
optional

Number of points needed to get this discount

integer (int32)

redeemedLoyaltyNights
optional

Number of nights given free by the resource

integer (int32)

resourceTypeSequenceNr
optional

integer (int64)

overrideValue
optional

number (double)

replacesParentResource
optional

Boolean field which indicates if the bill line resource will replace the parent resource or not .

boolean

6.440. ReservationBillResponse

Properties
Name Description Schema

resourceId
optional

integer (int64)

name
optional

string

endDate
optional

string (date)

vatRate
optional

number (double)

billLineType
optional

integer (int32)

quantity
optional

integer (int32)

multiplier
optional

integer (int32)

value
optional

number (double)

total
optional

number (double)

startDate
optional

string (date)

reservationBillId
optional

integer (int64)

reservedResourceId
optional

integer (int64)

overrideValue
optional

number (double)

reservationBillLineId
optional

integer (int64)

virtualOverrideValue
optional

number (double)

6.441. ReservationCategory

Properties
Name Description Schema

reservationCategoryId
optional

unique id associated with the reservationCategory.

integer (int64)

name
optional

name associated with the reservationCategory.

string

code
optional

unique code associated with the reservationCategory.

string

endDate
optional

the date till which reservationCategory is available.

string

markForOwnUse
optional

the reservation category is reserved for owners own use.

boolean

translations
optional

information of the reservationCategory which depends on a language and is translatable by the user. Multiple entries for different languages can exists.

< I18nReservationCategory
> array

reservationCategory
optional

ReservationCategory

6.442. ReservationCostPrice

Properties
Name Description Schema

reservationId
optional

integer (int64)

costs
optional

< ResourceCostPrice
> array

6.443. ReservationCriteria

Properties
Name Description Schema

distributionChannelCode
required

unique code associated with distribution channel.

string

categoryCode
required

unique code associated with reservation category.

string

accommodationTypes
required

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

< ReservationAccommodationType
> array

remark
optional

if guest wants to specify some feedback to the resort, then the feedback given by the customer is displayed.

string

externalBookingReference
optional

if the tour operator wants to store their reservation reference number, then it is displayed under this field.

string

employee
optional

This is not changing the employee who created the reservation, as this is still the employee linked to the API key. This field will set the initials in the reservation.

string

sendMethodCode
optional

this field specifies how the guest can be communicated to i.e via email or post

string

statusValue
optional

this field hold the status, in which reservation will create. We create reservation with OPTIONAL or QUOTATION status.
Note: To create a confirm booking this field should not be passed. The fields statusValue and status are the same and they are here for legacy reasons.

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

customerId
optional

unique id associated with the customer. In case a reservation for an existing/logged in customer is created this field can be used. The customer Id is provided when the customer login using POST /maxxton/v1/customers/login.

integer (int64)

customer
optional

ReservationCustomer

paymentTermSetId
optional

integer (int64)

6.444. ReservationCustomField

Properties
Name Description Schema

fieldId
required

integer (int64)

dataType
required

enum (MEMO,TEXT,NUMERIC,SELECTION_INCL,SELECTION_EXCL,DATE,BOOLEAN)

allowedValues
optional

< string > array

textValue
optional

Applicable only when custom field is of type text

string

booleanValue
optional

Applicable only when custom field is of type boolean

boolean

dateValue
optional

Applicable only when custom field is of type date

string (date)

numericValue
optional

Applicable only when custom field is of type numeric

number

selectValues
optional

Applicable only when custom field is of type selection incl. or selection excl.

< string > array

translations
optional

< I18nFields
> array

type
optional

enum (NORMAL,RESERVATION,REVENUE,EXTRA)

6.445. ReservationCustomer

details related to the customer. This entity will create a new customer, in case the customer needs to login use customerId field instead.

Properties
Name Description Schema

firstName
required

it specifies the first name of customer/guest and allows a maximum length of 50 characters.

string

lastName
required

it specifies the last name of customer/guest and allows a maximum length of 100 characters.

string

middle
optional

it specifies the middle name of customer/guest and allows a maximum length of 20 characters..

string

socialSecurityNumber
optional

the social security number associated with the customer and allows a maximum length of 15 characters.

string

titleId
optional

unique id associated with each title linked to the customer. This id can be fetched using GET /maxxton/v1/titles

integer (int64)

sex
optional

specify the gender of customer/guest.

enum (M,F,U)

language
optional

code of language in which the given information is stored. This language is the shortcode of the language and can be fetched using GET /maxxton/v1/languages. This language is also the language used for all communication with the customer.

string

mailAddress
required

ReservationAddress

alternateName
optional

it specifies the alternate name of customer/guest and allows a maximum length of 100 characters.

string

emailAllowed
optional

it specifies the permission for email communication with customer.

boolean

birthDate
optional

it specifies the birth date of customer. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string (date)

mailAllowed
optional

it specifies the permission for postal communication with customer.

boolean

companyName
optional

it specifies the company name of customer/guest and allows a maximum length of 100 characters.

string

questionnaireUnsubscribed
optional

boolean

6.446. ReservationCustomerResponse

Properties
Name Description Schema

customerId
optional

integer (int64)

firstName
optional

string

lastName
optional

string

middle
optional

string

socialSecurityNumber
optional

string

title
optional

ReservationCustomerTitle

sex
optional

string

language
optional

string

ibanNumber
optional

string

bicSwift
optional

string

mailAddress
optional

MailAddress

alternateName
optional

string

emailAllowed
optional

boolean

birthDate
optional

string (date)

questionnaireUnsubscribed
optional

boolean

mailAllowed
optional

boolean

owner
optional

boolean

companyName
optional

string

creationDate
optional

string (date-time)

6.447. ReservationCustomerStatus

Properties
Name Description Schema

customerClusters
optional

< CustomerCluster
> array

customerCluseters
optional

Write only (field is only accessible in the request body)

< CustomerCluster
> array

6.448. ReservationCustomerTitle

Properties
Name Description Schema

translations
optional

< I18nCustomerTitle
> array

6.449. ReservationDetailCountry

details of the country in which the accommodationtype/resort/unit is situated

Properties
Name Description Schema

countryId
optional

country id of the mail address.

integer (int64)

code
optional

country code represents shortname of country, 2 letter code(ISO 3166).

string

translations
optional

information of the country which depends on a language and is translatable by the user. Multiple entries for different languages can exists.

< I18NCountry
> array

default
optional

if the country is the default one then this field is true else false.

boolean

6.450. ReservationDetailCountry_Id

details of the country in which the accommodationtype/resort/unit is situated

Properties
Name Description Schema

countryId
optional

country id of the mail address.

integer (int64)

code
optional

country code represents shortname of country, 2 letter code(ISO 3166).

string

translations
optional

information of the country which depends on a language and is translatable by the user. Multiple entries for different languages can exists.

< I18NCountry_Id
> array

default
optional

if the country is the default one then this field is true else false.

boolean

6.451. ReservationDetailResponse

Properties
Name Description Schema

resortId
optional

integer (int64)

externalBookingReference
optional

string

distributionChannelId
optional

integer (int64)

distributionChannelCode
optional

string

reservationCategoryId
optional

integer (int64)

categoryCode
optional

string

reservationDate
optional

string (date-time)

parentId
optional

integer (int64)

arrivalDate
optional

string (date)

reservationId
optional

integer (int64)

reservationNumber
optional

string

tncSignedDate
optional

string (date)

tncSigned
optional

boolean

tncSigneeCustomerName
optional

string

cancelDate
optional

string (date)

customerId
optional

Write only (field is only accessible in the request body)

integer (int64)

payingCustomerId
optional

Write only (field is only accessible in the request body)

integer (int64)

customer
optional

ReservationCustomerResponse

payingCustomer
optional

ReservationCustomerResponse

modifiedDate
optional

string (date-time)

supplierBookingReference
optional

string

departureDate
optional

string (date)

status
optional

integer (int32)

reservedResources
optional

< ReservedResourceResponse
> array

infotexts
optional

< ReservationInfotext
> array

customerBill
optional

< ReservationBillResponse
> array

agentBill
optional

< ReservationBillResponse
> array

instalments
optional

< Instalment
> array

emergencyContacts
optional

< EmergencyContact
> array

expectedArrivalDateTime
optional

string (date-time)

expectedDepartureDateTime
optional

string (date-time)

validationStatusId
optional

integer (int64)

statusValue
optional

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

sendMethodId
optional

integer (int64)

employeeId
optional

integer (int64)

currencyId
optional

integer (int64)

currencyCode
optional

string

previousPmsId
optional

integer (int64)

paymentTermSetId
optional

integer (int64)

voucher
optional

string

vouchers
optional

List of Special Vouchers redeemed for reservation.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

< VoucherRedemption
> array

reservationKind
optional

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

enum (ACCOMMODATION_RESERVATION,ADDON_RESERVATION,GROUP_RESERVATION)

expectedArrivalTime
optional

Write only (field is only accessible in the request body)

string (date-time)

expectedDepartureTime
optional

Write only (field is only accessible in the request body)

string (date-time)

reservationInfoTexts
optional

Write only (field is only accessible in the request body)

< InfoText
> array

customerStatus
optional

ReservationCustomerStatus

6.452. ReservationDoorlock

Properties
Name Description Schema

arrivalDate
optional

string (date)

departureDate
optional

string (date)

reservationId
optional

integer (int64)

doorLockCodes
optional

< DoorlockCode
> array

6.453. ReservationEquipment

Properties
Name Description Schema

value
optional

string

remark
optional

string

reservationSubjectId
optional

integer (int64)

reservedResourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.454. ReservationInfotext

Represent any information that is related to resources for example extra, product, special and accommodationtype etc.

Properties
Name Description Schema

description
optional

description associated with the infotext.

string

6.455. ReservationInstalmentResponse

Properties
Name Description Schema

reservationId
optional

integer (int64)

instalments
optional

< Instalment
> array

6.456. ReservationLink

Properties
Name Description Schema

infoTextReservationId
optional

integer (int64)

reservedResourceId
optional

integer (int64)

infoTextId
optional

integer (int64)

display
optional

boolean

6.457. ReservationPayment

Properties
Name Description Schema

paymentId
optional

unique id associated with the payments.

integer (int64)

reservationId
optional

unique id associated with the reservation.

integer (int64)

currencyId
optional

the currency of the bank account.

integer (int64)

currencyCode
optional

the currency code of the bank account.

string

amount
optional

the amount of the payment in the currency of the bank account.

number

paymentDate
optional

the date when the payemnt has been done.

string (date-time)

statementDate
optional

the date when the statement is created.

string (date)

paymentAccount
optional

the name of the bank with which payment has been done.

string

payerType
optional

the type of the payer.

string

paymentType
optional

type of payment.

string

refunded
optional

indicates that this payment is a refund of another payment.

boolean

remark
optional

remark for the payments.

string

ledgerId
optional

ledgers in which payments are added.

integer (int64)

paymentNumber
optional

the payment number associated with the payments.

string

paymentMethod
optional

PaymentMethodDefinition

6.458. ReservationPaymentContainer

Properties
Name Description Schema

reservationId
optional

integer (int64)

payments
optional

< ReservationPayment
> array

6.459. ReservationPaymentRequest

Payment to be added for reservation.

Properties
Name Description Schema

paymentMethodCode
required

string

amount
required

number (double)

currencyCode
optional

string

remark
optional

string

6.460. ReservationPersonSubject

Properties
Name Description Schema

reservationSubjectId
optional

integer (int64)

firstName
optional

string

middleName
optional

string

lastName
optional

string

birthDate
optional

string (date)

sex
optional

string

email
optional

string

street
optional

string

houseNumber
optional

string

houseNumberSuffix
optional

string

zipCode
optional

string

city
optional

string

countryId
optional

integer (int64)

guest
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

boolean

companion
optional

boolean

personAlreadyLeft
optional

boolean

arrivalDate
optional

string (date)

departureDate
optional

string (date)

identityCardNumber
optional

Identity card number of travel party member

Maximum Length: 50
Minimum Length: 0

string

identityType
optional

enum (PASSPORT,IDENTITY_CARD,DRIVERS_LICENCE)

identityNumber
optional

string

identityCountryId
optional

integer (int64)

identityDateIssued
optional

string (date)

gender
optional

Write only (field is only accessible in the request body)

string

6.461. ReservationPreference

Properties
Name Description Schema

id
optional

integer (int64)

type
optional

string

6.462. ReservationProposal

Properties
Name Description Schema

currencyCode
optional

unique code represent the currency in which the reservation payment is done.

string

arrivalDate
optional

the date on which customer/guest will arrive.

string (date)

departureDate
optional

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

string (date)

customerBill
optional

the bill of the customer for which the reservation is created.

< ReservationProposalCustomerBill
> array

agentBill
optional

the bill of agent or tour opertor or any third party who made the reservation on behalf of customer.

< ReservationProposalCustomerBill
> array

instalments
optional

as per the payment terms configuration , installments are generated for the entire bill.

< Instalment
> array

reservedResources
optional

the list of resources, which are booked as part of the reservation.

< ReservedResourceItem
> array

additions
optional

addition contains all the possible product and extra that can be booked for that accommodationtype in a reservation.

< ResourceAdditionItem
> array

infotexts
optional

represent the any information that is related to the accommodationtype.

< InfoTextItem
> array

preBooking
optional

this field shows whether if it’s a pre-booking or not

boolean

unitIds
optional

the list of available units for the selected accommodationtype.

< integer > array

paymentOptions
optional

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 instalments. In case no payment option is set, it will take the one with the highest priority for the instalments.

< PaymentOption
> array

6.463. ReservationProposalAccommodationType

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

Properties
Name Description Schema

resourceId
required

Unique id associated with each accommodationtype.

integer (int64)

unitId
optional

Unique id associated with each unit.

integer (int64)

arrivalDate
required

The date on which the customer/guest will arrive. The date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

duration
required

The Duration for which a user wants to make a reservation and the duration should be passed in days ex: 7.

integer (int32)

offerCode
optional

Discount code which can be applied to a reservation. This code is case sensitive.

string

additions
optional

The product and extras which a user wants to book in a reservation.

< ReservationProposalAddition
> array

preferences
optional

A preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit.

< ReservationProposalPreference
> array

subjects
required

ReservationProposalSubjectCriteria

rateTypeId
optional

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

integer (int64)

removeImplies
optional

List of impliesId which want to be removed.

< integer > array

voucherCode
optional

Voucher code which can be applied to a reservation. This code is case sensitive. Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.

string

useLoyaltyPoints
optional

Loyalty points to be used for the reservation

integer (int32)

useLoyaltyFreeNights
optional

Nights to redeem on saved loyalty points

integer (int32)

6.464. ReservationProposalAddition

The product and extras which a user wants to book in a reservation.

Properties
Name Description Schema

additionResourceId
required

unique id associated with addition linked to resource.

integer (int64)

startDate
required

the date from which the addition is accessed in the accommodation. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string

endDate
required

the date till which the addition can be accessed in the accommodationtype. Date should be added using ISO 8601 standard(yyyy-MM-dd).

string

quantity
required

this field specify the no. of additions which are applied in accommodationtype.

Minimum: 1

integer (int32)

6.465. ReservationProposalCustomerBill

the bill of agent or tour opertor or any third party who made the reservation on behalf of customer.

Properties
Name Description Schema

resourceId
optional

the unique id of resource for which the bill is generated.

integer (int64)

name
optional

the name of resource for which the bill is generated.

string

vatRate
optional

value of the applied configured vat-rate for the resource.

number (double)

billLineType
optional

possible bill-line type can be encountered :
RESERVED_RESOURCE(10): resources that are reserved in a reservation.
RESORT_ARTICLE(20): the article which belongs to the resort and the customer can purchase it during the stay.
SUBTOTAL(40): total of all reserved resources included in reservation.
WARRANT(50): It is an extra which is taken from the customer as a deposit.
VAT(60): It is a type of tax which is applied on a reservation.
TOTAL(70): total amount of all reserved resources in reservation.
PAID_AMOUNT(80): amount which is already paid in reservation.
DUE_AMOUNT(90): amount which is left to be paid in reservation by the customer.
STAY_ARTICLE(130): article which is booked in a reservation applicable throughout the stay of the customer.
WITHHOLDINGARTICLE(140): this is used for deposit purpose ex: the customer paid a deposit of 200 euros, they did not removed the trash bag thus they have to pay 10 euros. So the extra with the withholding article setting will be added in the reservation by the user. The customer will get back an amount of 190 euros via the repayment module.
TAX(250): tax which is to be paid by the customer applied on a reservation.
TOTAL_EXCL_TAX(260): total amount excluding the tax which is to be paid by the customer for a reservation.

integer (int32)

value
optional

price of the resource for which the bill is generated

number (double)

quantity
optional

integer (int32)

multiplier
optional

integer (int32)

total
optional

total amount of the bill

number (double)

redeemedLoyaltyPoints
optional

Number of points needed to get this discount

integer (int32)

redeemedLoyaltyNights
optional

Number of nights given free by the resource

integer (int32)

6.466. ReservationProposalPreference

A preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit.

Properties
Name Description Schema

id
optional

Specifies the id of the amenity or unit based on the type field value is amenity or unit respectively.

integer (int64)

type
required

Specifies the type of preference : AMENITY, UNIT or ADJACENT.

string

remark
optional

Remark to be added with the ADJACENT type preferences.

string

6.467. ReservationProposalRequest

A reservation proposal object to be added

Properties
Name Description Schema

distributionChannelCode
required

unique code of distribution-channel.

string

categoryCode
required

unique code of reservation-category.

string

customerId
optional

integer (int64)

accommodationTypes
required

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

< ReservationProposalAccommodationType
> array

paymentTermSetId
optional

integer (int64)

6.468. ReservationProposalSubjectCriteria

Specifies the quantity per subject ex: quantity of Adult, children identified based on the age.

Properties
Name Description Schema

persons
required

Details related to the persons for whom the accommodationtype is booked in reservation proposal.

< Persons
> array

petsQuantity
optional

Shows the pet’s quantity for which the accommodationtype is booked in reservation proposal.

integer (int32)

6.469. ReservationReminder

Properties
Name Description Schema

dueAmount
optional

number (double)

status
optional

enum (OPEN,CLOSED,DORMENT)

sendDate
optional

string (date-time)

paymentDate
optional

string (date-time)

printDate
optional

string (date-time)

reservationId
optional

integer (int64)

paymentTermSetId
optional

integer (int64)

6.470. ReservationReservedResource

The list of resources which are booked as part of the reservation.

Properties
Name Description Schema

type
optional

The type of the resource, which is reserved as part of the reservation.

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

resourceId
optional

Unique id of the resource, which is reserved as part of the reservation.

integer (int64)

reservedResourceId
optional

Unique id represent the reserved resource in the reservation.

integer (int64)

parentId
optional

If the reserved resource is child of any other reserved resource then, the id of the parent reserved resource will be displayed.

integer (int64)

name
optional

Tame of the resource booked in the reservation.

string

startDate
optional

The date from which the resource is booked as part of the reservation.

string (date)

endDate
optional

The date till which the resource is booked as part of the reservation.

string (date)

price
optional

The cost of the resource in reservation.

number (double)

quantity
optional

Represent quantity of resources booked in the reservation.

integer (int32)

shortDescription
optional

Short description associated with reserved resource.

string

description
optional

Description associated with the reserved resource.

string

unitId
optional

The unique id, represent the unit booked in the reservation.

integer (int64)

hasPriceOverride
optional

This field shows whether the resource price can be overridden or not.

boolean

removable
optional

This field shows whether the resource can be removed or not.

boolean

infotexts
optional

Represent any information that is related to resources for example extra, product, special and accommodationtype etc.

< ReservationInfotext
> array

impliesId
optional

Write only (field is only accessible in the request body)

integer (int64)

offerType
optional

It is the type of offer which is applicable in the reservation for e.g It can be a GENERAL_SPECIAL, STRUCTURAL_SPECIAL, FOLLOWUP_SPECIAL, CASHIN_SPECIAL, VOUCHER_SPECIAL

enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE)

code
optional

The code represents the resource which is booked as part of the reservation.

string

imply
optional

If any product or extra is a mandatory addition on a accommodationtype then the imply field will be true for that reserved resource or else it will be false.

boolean

6.471. ReservationReservedResourceSubject

Properties
Name Description Schema

reservationId
optional

integer (int64)

reservedResourceSubjectQuantity
optional

< ReservedResourceSubjectQuantity
> array

6.472. ReservationResponse

Properties
Name Description Schema

reservationId
optional

Unique id of newly created reservation.

integer (int64)

reservationNumber
optional

Represent the unique number of newly created reservation.

string

arrivalDate
optional

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

currencyCode
optional

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

string

departureDate
optional

The date on which customer/guest will leave the accommodation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

reservationDate
optional

Date on which the reservation is created.

string (date-time)

statusValue
optional

This field holds the status, in which reservation is created. Possible status can be: OPTIONAL, QUOTATION, PROVISIONAL, REQUEST

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

resortId
optional

The unique id represents the resort in which the accommodationtype is located.

integer (int64)

externalBookingReference
optional

It represents the tour operator’s reservation reference number.

string

customerId
optional

The unique id represents the the customer/guest who requested for the reservation.

integer (int64)

customerBill
optional

The bill of the customer for which the reservation is created.

< CustomerBill
> array

agentBill
optional

The bill of agent or tour operator or any third party who made the reservation on behalf of the customer.

< CustomerBill
> array

reservedResources
optional

The list of resources which are booked as part of the reservation.

< ReservationReservedResource
> array

infotexts
optional

Represent the any information that is related to the accommodationtype.

< InfoText
> array

instalments
optional

As per the payment terms configuration , installments are generated for the entire bill.

< Instalment
> array

status
optional

Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41)

integer (int32)

paymentTermSetId
optional

integer (int64)

reservationInfoTexts
optional

Write only (field is only accessible in the request body)

< InfoText
> array

6.473. ReservationSnapshot

Properties
Name Description Schema

businessSnapshotId
optional

integer (int64)

businessSnapshotNumber
optional

string

creationDate
optional

string (date)

value
optional

number

paid
optional

number

open
optional

number

validationStatus
optional

enum (NEVER_TO_BE_SENT,UNVALIDATED,VALID,SENT)

payerType
optional

enum (CUSTOMER,PAYING_CUSTOMER,AGENT)

startDate
optional

string (date)

endDate
optional

string (date)

issueDate
optional

string (date)

dueDate
optional

string (date)

6.474. ReservationSubjectCriteria

it specifies the quantity per subject ex: quantity of Adult, children identified based on the age.

Properties
Name Description Schema

persons
required

details related to the persons for whom the accommodationtype is booked in reservation.

< Persons
> array

petsQuantity
optional

it shows the pet’s quantity for which the accommodationtype is booked in reservation.

integer (int32)

6.475. ReservationSubjectRequest

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

subjectId
optional

integer (int64)

travelParties
optional

< CreateReservationPersonSubject
> array

vehicles
optional

< CreateReservationVehicleSubject
> array

equipments
optional

< CreateReservationEquipment
> array

6.476. ReservationTermAndCondition

Properties
Name Description Schema

termAndConditionId
optional

unique id associated with each termAndCondition

integer (int64)

validFrom
optional

date from which that termAndCondition will be applicable

string (date)

validTo
optional

date to which that termAndCondition will be applicable

string (date)

contents
optional

actual term and conditions will be displayed in contents

string

type
optional

type of the termAndCondition

string

isDefault
optional

if the termAndCondition is default one then true will be displayed else false will be displayed in isDefault

boolean

templateId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.477. ReservationTravelPartyCriteria

The list of travel parties staying

Properties
Name Description Schema

firstName
optional

First name if the travel party.

string

middleName
optional

Middle name of the travel party.

string

lastName
optional

Last name of the travel party.

string

birthDate
optional

BirthDate of the travel party. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

sex
optional

Gender of the travel party.

enum (f,m,u,F,M,U)

identityCardNumber
optional

Identity card number of travel party member

Maximum Length: 50
Minimum Length: 0

string

identityType
optional

enum (PASSPORT,IDENTITY_CARD,DRIVERS_LICENCE)

identityNumber
optional

string

6.478. ReservationUpdateRequest

Request body to specify the modifications needed for a reservation.

Properties
Name Description Schema

statusValue
optional

reservation status can be change from existing status to the provided status. Possible reservation status that can be provided, are : CANCEL(-12), DECLINE(-10), CHECKED_IN(31), CONFIRM(33), CHECKED_OUT(41).

enum (CANCEL,DECLINE,QUOTATION,INITIAL,PRE_BOOKING,REQUEST,OPTIONAL,PROVISIONAL,DEFINITIVE,CHECKED_IN,CONFIRM,CHECKED_OUT)

expectedArrivalDateTime
optional

the date and time on which the customer is expected to arrive.

string (date-time)

expectedDepartureDateTime
optional

the date and time on which the customer departure is expected.

string (date-time)

cancellationReason
optional

The reason why the reservation is being cancelled or declined. This field is only used when the status is set and updated to CANCEL or DECLINE.

Maximum Length: 4000
Minimum Length: 0

string

paymentTermSetId
optional

integer (int64)

6.479. ReservationUpdateResponse

Properties
Name Description Schema

reservationId
optional

unique id associated with reservation.

integer (int64)

statusValue
optional

the reservation status after update process. Possible status values can be: DELETED, CANCELLED, DECLINED, PROVISIONAL, DEFINITIVE

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

expectedArrivalDateTime
optional

the date and time on which the customer is expected to arrive.

string (date-time)

expectedDepartureDateTime
optional

the date and time on which the customer departure is expected.

string (date-time)

paymentTermSetId
optional

id of the payment term set selected for the reservation.

integer (int64)

infotexts
optional

< InfoText
> array

status
optional

Write only (field is only accessible in the request body)

enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT)

6.480. ReservationVehicleCriteria

The list of vehicles with the booking

Properties
Name Description Schema

subjectId
optional

Subject id applicable to the vehicle.

integer (int64)

vehicleRegistrationMark
optional

Registration mark of the vehicle.

Maximum Length: 15
Minimum Length: 0

string

remark
optional

Remark relating to the vehicle.

string

6.481. ReservationVehicleSubject

Properties
Name Description Schema

remark
optional

string

registrationMark
optional

Maximum Length: 15
Minimum Length: 0

string

subjectId
optional

Write only (field is only accessible in the request body)

integer (int64)

reservationSubjectId
optional

integer (int64)

reservedResourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.482. ReservedAmenityDetail

Properties
Name Description Schema

amenityId
optional

integer (int64)

endDate
optional

string (date)

type
optional

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

metricDetail
optional

Metric

parentAmenityId
optional

integer (int64)

translations
optional

< I18nAmenity
> array

categories
optional

< AmenityCategory
> array

6.483. ReservedI18nUnit

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

string

name
optional

string

description
optional

string

shortDescription
optional

string

6.484. ReservedRateType

Properties
Name Description Schema

translations
optional

< I18nRateType
> array

6.485. ReservedResource

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

reservationId
optional

integer (int64)

resourceId
optional

integer (int64)

unitId
optional

integer (int64)

rateTypeId
optional

integer (int64)

overrideEmployeeId
optional

integer (int64)

overrideValue
optional

number (double)

quantity
optional

integer (int64)

type
optional

string

offerType
optional

enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE)

vatRate
optional

number (double)

statusName
optional

string

name
optional

string

code
optional

string

resourceCode
optional

string

shortDescription
optional

string

description
optional

string

startDate
optional

string (date)

endDate
optional

string (date)

cancellationPremium
optional

boolean

reservationDate
optional

string (date-time)

onBill
optional

boolean

price
optional

number (double)

hasPriceOverride
optional

boolean

totalInternalPrice
optional

number (double)

employeeId
optional

integer (int64)

removable
optional

boolean

modifiedDate
optional

string (date-time)

implyOnce
optional

boolean

included
optional

boolean

turnOverValue
optional

number (double)

representationId
optional

integer (int64)

parentId
optional

integer (int64)

impliesId
optional

integer (int64)

resellerAddonCode
optional

string

actualStartDate
optional

string (date)

actualEndDate
optional

string (date)

imply
optional

boolean

6.486. ReservedResourceAmenity

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

amenityId
optional

integer (int64)

type
optional

string

extraId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.487. ReservedResourceItem

the list of resources, which are booked as part of the reservation.

Properties
Name Description Schema

resourceId
optional

unique id of the resource, which is reserved as part of the reservation proposal.

integer (int64)

offerType
optional

it is the type of offer which is applicable in the reservation proposal for e.g It can be a GENERAL_SPECIAL, STRUCTURAL_SPECIAL, FOLLOWUP_SPECIAL, CASHIN_SPECIAL, VOUCHER_SPECIAL

enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE)

code
optional

unique code associated with reserved resource.

string

type
optional

the type of the resource, which is reserved as part of the reservation proposal.

string

infotexts
optional

represent any information that is related to resources for example extra, product, special and accommodationtype etc.

< InfoTextItem
> array

name
optional

name of the resource, booked in the reservation proposal.

string

shortDescription
optional

short description related to the reserved resource.

string

description
optional

description related to the reserved resource.

string

startDate
optional

the date from which the resource is booked as part of the reservation proposal.

string (date)

endDate
optional

the date till which the resource is booked as part of the reservation proposal.

string (date)

price
optional

the cost of the resource in reservation proposal.

number (double)

quantity
optional

represents quantity of resources, booked in the reservation proposal.

integer (int32)

unitId
optional

unique id associated with the unit booked in the reservation proposal.

integer (int64)

hasPriceOverride
optional

this field shows whether the resource price can be overridden or not.

boolean

removable
optional

this field shows whether the resource can be removed or not.

boolean

imply
optional

if any product or extra is a mandatory addition on an accommodation type then the imply field will be true for that reserved resource or else it will be false.

boolean

impliesId
optional

unique id associated with each implies.

integer (int64)

internetAdditionalCost
optional

this field is used to mark items that should be included in the total value shown to a guest or not.

boolean

addOnMetricDescription
optional

this field we use to add a textual description of the metric/unit of the addon. This means that this should contain a description that the add on price is per person, per stay or per night etc.

string

6.488. ReservedResourceOfReservation

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

reservationId
optional

integer (int64)

resourceId
optional

integer (int64)

unitId
optional

integer (int64)

rateTypeId
optional

integer (int64)

overrideEmployeeId
optional

integer (int64)

overrideValue
optional

number (double)

quantity
optional

integer (int64)

type
optional

string

offerType
optional

enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE)

vatRate
optional

number (double)

statusName
optional

string

name
optional

string

code
optional

string

resourceCode
optional

string

shortDescription
optional

string

description
optional

string

startDate
optional

string (date)

endDate
optional

string (date)

cancellationPremium
optional

boolean

reservationDate
optional

string (date-time)

onBill
optional

boolean

price
optional

number (double)

hasPriceOverride
optional

boolean

totalInternalPrice
optional

number (double)

employeeId
optional

integer (int64)

removable
optional

boolean

modifiedDate
optional

string (date-time)

implyOnce
optional

boolean

included
optional

boolean

turnOverValue
optional

number (double)

representationId
optional

integer (int64)

parentId
optional

integer (int64)

impliesId
optional

integer (int64)

resellerAddonCode
optional

string

actualStartDate
optional

string (date)

actualEndDate
optional

string (date)

pointsRedeemed
optional

integer (int32)

nightsRedeemed
optional

integer (int32)

actualCheckinTime
optional

string (date-time)

actualCheckoutTime
optional

string (date-time)

imply
optional

boolean

6.489. ReservedResourcePerReservation

Properties
Name Description Schema

reservationId
optional

integer (int64)

reservedResources
optional

< ReservedResourceOfReservation
> array

6.490. ReservedResourcePreference

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

remark
optional

string

type
optional

enum (MISCELLANEOUS,OBJECT,ADJACENT)

reservedResourcePreferenceId
optional

Write only (field is only accessible in the request body)

integer (int64)

reservationId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.491. ReservedResourcePreferencePerReservation

Properties
Name Description Schema

reservationId
optional

integer (int64)

reservedResourcePreferences
optional

< ReservedResourcePreference
> array

6.492. ReservedResourceResponse

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

parentId
optional

integer (int64)

resourceId
optional

integer (int64)

rateTypeId
optional

integer (int64)

rateType
optional

ReservedRateType

endDate
optional

string (date)

description
optional

string

type
optional

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

reservationDate
optional

string (date-time)

price
optional

number (double)

offerType
optional

enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE)

unitId
optional

Write only (field is only accessible in the request body)

integer (int64)

unit
optional

ReservedUnit

translations
optional

< ReservedResourceTranslation
> array

quantity
optional

integer (int32)

cancellationPremium
optional

boolean

shortDescription
optional

string

removable
optional

boolean

imply
optional

boolean

name
optional

string

modifiedDate
optional

string (date-time)

startDate
optional

string (date)

status
optional

integer (int32)

code
optional

string

included
optional

boolean

impliesId
optional

integer (int64)

freeFields
optional

< Fields
> array

infotexts
optional

< ReservationInfotext
> array

subjects
optional

< TemporaryReservedResourceSubject
> array

preferences
optional

< ReservationPreference
> array

amenities
optional

< ReservedAmenityDetail
> array

resortArticle
optional

boolean

pointsRedeemed
optional

integer (int32)

nightsRedeemed
optional

integer (int32)

actualCheckinTime
optional

string (date-time)

actualCheckoutTime
optional

string (date-time)

resourceCode
optional

string

turnOverValue
optional

number (double)

vatRate
optional

number (double)

actualStartDate
optional

string (date)

actualEndDate
optional

string (date)

6.493. ReservedResourceSubject

details related to the subjects(people) and the number of subjects who will come for stay to the unit in reservation period.

Properties
Name Description Schema

subjectId
optional

integer (int64)

quantity
optional

specify the no. of persons are for which the accommodation is booked.

integer (int32)

type
optional

specify the the type of subject like PET, PERSON, VEHICLE, OTHER.

enum (PET,CATEGORY,PERSON,VEHICLE,OTHER,EQUIPMENT)

maxAge
optional

specify the the max age of subject.

integer (int32)

translations
optional

information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nSubject
> array

6.494. ReservedResourceSubjectQuantity

Properties
Name Description Schema

reservedResourceId
optional

integer (int64)

subjectId
optional

integer (int64)

quantity
optional

integer (int32)

subject
optional

Subject

travelParties
optional

< ReservationPersonSubject
> array

vehicles
optional

< ReservationVehicleSubject
> array

equipments
optional

< ReservationEquipment
> array

6.495. ReservedResourceTranslation

Properties
Name Description Schema

languageId
optional

Write only (field is only accessible in the request body)

integer (int64)

resourceId
optional

Write only (field is only accessible in the request body)

integer (int64)

language
optional

code of the language in which the given information is stored

string

name
optional

name of the addon

string

shortDescription
optional

short description related to the addon

string

description
optional

description related to the addon

string

6.496. ReservedResourceUnitAllotment

Properties
Name Description Schema

startDate
optional

string (date)

endDate
optional

string (date)

modifiedDate
optional

string (date-time)

freeAllotments
optional

integer (int64)

resourceId
optional

integer (int64)

distributionChannelId
optional

integer (int64)

unitId
optional

integer (int64)

6.497. ReservedResourceUpdate

Request body to specify the modifications needed for a reservation.

Properties
Name Description Schema

startDate
optional

string (date)

endDate
optional

string (date)

actualStartDate
optional

string (date)

actualEndDate
optional

string (date)

unitId
optional

integer (int64)

quantity
optional

integer (int64)

price
optional

number (double)

6.498. ReservedUnit

Properties
Name Description Schema

unitId
optional

integer (int64)

code
optional

string

translations
optional

< ReservedI18nUnit
> array

6.499. Resort

Properties
Name Description Schema

resortPriority
optional

priority set to the resort in which it will be visible to the user

integer (int64)

resortNumber
optional

number associated with each resort

integer (int32)

resArrivalDateFrom
optional

date on which the user can arrive

string (date)

internalResortNumber
optional

automatic generated resort number from where the reservation number will start

string

code
optional

unique code associated with each resort

string

resortId
optional

unique id associated with each resort

integer (int64)

parentId
optional

if resort is a child of another resort then the id of the parent resort is displayed

integer (int64)

archivedFrom
optional

date from which the resort was archived. The resorts will not be displayed if the resort is archived. Thus for all resorts which are being displayed the value will be null

string (date)

supplierId
optional

unique id associated with the supplier

deprecated

integer (int64)

translations
optional

information of the resorts which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nResort
> array

visitAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mailAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

inheritTc
optional

Write only (field is only accessible in the request body)

boolean

dynamicManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mailAddress
optional

Address

visitAddress
optional

Address

amenityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

adminOrganisationId
optional

id of the admin organisation to which resort is linked.

integer (int64)

origin
optional

string

originId
optional

string

bookableLocation
optional

to show if location contains actual accommodation types and not just used for defining hierarchy

boolean

previousPmsId
optional

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

string

i18n
optional

Write only (field is only accessible in the request body)

< I18nResort
> array

6.500. ResortActivity

Properties
Name Description Schema

resortActivityId
optional

integer (int64)

code
optional

string

activityCategoryId
optional

integer (int64)

priceAdult
optional

string

priceChild
optional

string

priceValuePoints
optional

string

priceType
optional

enum (FREE,PAID)

ticketingType
optional

enum (TICKETS,NO_TICKETS,TICKET_PER_GROUP,TICKET_PER_SUBJECT)

translations
optional

< I18nResortActivity
> array

6.501. ResortAmenityLink

Properties
Name Description Schema

amenityLinkId
optional

unique id associated which tells the amenity is linked to a resource

integer (int64)

type
optional

type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

visible
optional

if the amenity linked should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

startDate
optional

date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

amenityId
optional

unique id associated with each amenity

integer (int64)

code
optional

unique code associated with each amenity

string

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

resortId
optional

unique id associated with each resort

integer (int64)

6.502. ResortDC

Properties
Name Description Schema

code
optional

unique code associated with each resort

string

resortId
optional

unique id associated with each resort

integer (int64)

parentId
optional

if resort is a child of another resort then the id of the parent resort is displayed

integer (int64)

archivedFrom
optional

date from which the resort was archived. The resorts will not be displayed if the resort is archived. Thus for all resorts which are being displayed the value will be null

string (date)

translations
optional

information of the resorts which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nResort
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nResort
> array

6.503. ResortDetailWithUnitMap

Properties
Name Description Schema

resortPriority
optional

priority set to the resort in which it will be visible to the user

integer (int64)

resortNumber
optional

number associated with each resort

integer (int32)

resArrivalDateFrom
optional

date on which the user can arrive

string (date)

internalResortNumber
optional

automatic generated resort number from where the reservation number will start

string

code
optional

unique code associated with each resort

string

resortId
optional

unique id associated with each resort

integer (int64)

parentId
optional

if resort is a child of another resort then the id of the parent resort is displayed

integer (int64)

archivedFrom
optional

date from which the resort was archived. The resorts will not be displayed if the resort is archived. Thus for all resorts which are being displayed the value will be null

string (date)

supplierId
optional

unique id associated with the supplier

deprecated

integer (int64)

translations
optional

information of the resorts which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nResort
> array

visitAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mailAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

inheritTc
optional

Write only (field is only accessible in the request body)

boolean

dynamicManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

mailAddress
optional

Address

visitAddress
optional

Address

amenityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

adminOrganisationId
optional

id of the admin organisation to which resort is linked.

integer (int64)

origin
optional

string

originId
optional

string

bookableLocation
optional

to show if location contains actual accommodation types and not just used for defining hierarchy

boolean

previousPmsId
optional

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

string

amenityCategorySets
optional

details related to the group of amenity categories

< AmenityCategorySetDetail
> array

subjects
optional

details related to the subject(people) coming for stay

< Subject
> array

dynamicFields
optional

user-defined and customized fields

< DynamicField
> array

images
optional

details of the images associated to the resort

< Image
> array

videos
optional

details associated with videos related to the accommodationtype

< Video
> array

regionId
optional

Region of the resort. This is the id of the lowest level region where the resort is in.

integer (int64)

breadCrumb
optional

BreadCrumb of all regions the resort lies in. This is calculated based on the long and latitude set on the resort which is within the configured geo shape of the regions. The regions can be nested and based on this the breadcrumb is created from the biggest parent and all children within.

string

resortMap
optional

ResortMap

i18n
optional

Write only (field is only accessible in the request body)

< I18nResort
> array

6.504. ResortGroup

Properties
Name Description Schema

resortgroupId
optional

integer (int64)

ledgerId
optional

integer (int64)

secondLedgerId
optional

integer (int64)

costCenterId
optional

integer (int64)

costCenterDependsResort
optional

boolean

resortgroupPriority
optional

integer (int64)

costcenterDependsonWorkorder
optional

boolean

costUnitId
optional

integer (int64)

costcenterDependsonResortRc
optional

boolean

costCenter
optional

CostCenter

6.505. ResortMap

Resort map detail of the resort

Properties
Name Description Schema

imageId
optional

Image id of the resort map

integer (int64)

filename
optional

File name of the resort map

string

imageUrl
optional

Url of the image

string

unitCoordinates
optional

Coordinates of the unit

< UnitMap
> array

6.506. ResortPriority

Properties
Name Description Schema

resortPriorityId
optional

unique id associated with each resort priority set

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

resortId
optional

Resort id associated with each resort

integer (int64)

distributionChannelId
required

Distribution channel id associated with each resort

integer (int64)

startDate
optional

Start date of the period for which the priority has been applied. The date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

End date of the period for which the priority has been applied. The date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

priority
required

Priority associated with each resort priority set

integer (int64)

segmentId
optional

Segment id associated with each resort priority set

integer (int64)

6.507. ResortSearchFilterOption

Properties
Name Description Schema

arrivals
optional

unique items

< string > array

departures
optional

unique items

< string > array

amenities
optional

If includeFilterOptionCounts is "true" in request body, then all the available amenities and their respective counts(No of accommodations in which that amenity is available) as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the amenityIds are displayed in response.

unique items

< object > array

accommodationKinds
optional

accommodationkind ids on which user can filter data

unique items

< object > array

6.508. ResortSearchList

Properties
Name Description Schema

resortId
optional

unique id associated with the resort to which the accommodationtype belong

integer (int64)

accommodationtypes
optional

< ResortSearchResult
> array

6.509. ResortSearchRequest

Properties
Name Description Schema

distributionChannelId
required

if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown.

integer (int64)

arrivalDate
optional

the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

duration
optional

the duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7.

integer (int32)

filterOptions
optional

filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'resorts', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures and arrivals available for the requested criteria are displayed in response.

< string > array

offerCode
optional

unique code associated with offer on the bases of which accommodationtype is to be filtered

string

offerId
optional

integer (int64)

subjects
optional

Person

resortIds
optional

list of resort ids passed to fetch accommodationtypes which belong to the provided resorts

unique items

< integer > array

petQuantity
optional

the number of pets accommodated in the accommodationtype

integer (int32)

amenityIds
optional

list of amenity ids which are linked to the accommodationtype

unique items

< integer > array

accommodationKindIds
optional

list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched

unique items

< integer > array

includeFilterOptionCounts
optional

an option to return the counts of the different filteroptions

boolean

regionId
optional

region id passed to fetch resorts which belong to the provided region

integer (int64)

includeAccommodationtypes
optional

an option to return the accommodationtypes in the response or not

boolean

dateMargin
optional

date margin to search other possible stays (arrival dates and durations) when the requested stay is not available.

integer (int32)

dateMarginMethod
optional

This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it will use the default value: ARRIVAL_DATE_AND_DURATION. DURATION_AND_ARRIVAL:
This parameter is opposite from the ARRIVAL_DATE_AND_DURATION option which gives preference to find alternatives closest to the chosen duration (arrival will vary first).

enum (ARRIVAL_DATE,DURATION,ARRIVAL_DATE_AND_DURATION,DURATION_AND_ARRIVAL)

minNrOfBathrooms
optional

integer (int32)

maxNrOfBathrooms
optional

integer (int32)

minNrOfBedrooms
optional

integer (int32)

maxNrOfBedrooms
optional

integer (int32)

redeemableLoyaltyPoints
optional

Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter.

integer (int32)

6.510. ResortSearchResponse

Properties
Name Description Schema

result
optional

PageResortSearchList

filterOptionsResult
optional

ResortSearchFilterOption

6.511. ResortSearchResult

Properties
Name Description Schema

resourceId
optional

The unique id of the accommodationtype

integer (int64)

accommodationKindId
optional

Accommodation Kind id associated with each accommodationtype

integer (int64)

arrivalDate
optional

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

departureDate
optional

The date on which customer/guest will leave. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

offerCode
optional

Unique searchcodes associated with the offers which are applicable to the accommodationtype

string

basePrice
optional

Basis accommodationtype rent price without any additional costs or addons included

number (double)

basePriceInclusive
optional

Basis accommodationtype rent price including mandatory additional costs configured as internet additional cost

number (double)

offerPrice
optional

The lowest offer price available for the particular stay without any additional costs or addons included

number (double)

offerPriceInclusive
optional

The lowest offer price available for the particular stay including mandatory additional costs configured as internet additional cost

number (double)

totalCapacity
optional

Total capacity accommodated in the accommodationtype

integer (int32)

referencePrice
optional

The highest accommodationtype rent price ever available for the particular stay(can be used as from price)

number (double)

referencePriceInclusive
optional

The highest accommodationtype rent price ever available for the particular stay(can be used as from price) including mandatory additional costs configured as internet additional cost

number (double)

duration
optional

The duration(number of nights) for which a user will stay at the accommodationtype

integer (int32)

rateTypeId
optional

The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type

integer (int64)

nrOfBathrooms
optional

Number of bathrooms in the accommodationtype

number (double)

nrOfBedrooms
optional

Number of bedrooms in the accommodationtype

integer (int32)

loyaltyPrice
optional

Price including offers and loyalty

number (double)

loyaltyPriceInclusive
optional

Price including offers, loyalty and additional costs

number (double)

requiredLoyaltyPoints
optional

The required number of points for this loyalty price

integer (int32)

freeLoyaltyDuration
optional

The number of free nights for this number of loyalty points

integer (int32)

6.512. ResourceAddition

Properties
Name Description Schema

additionId
optional

unique id associated with each addition

integer (int64)

additionResourceId
optional

integer (int64)

additionFast
optional

if the checkbox of additionfast is selected in the system then the value for the field is true else false

boolean

mandatoryResource
optional

if the addition is mandatory for the customer then the value for the field is true else false

boolean

maxQuantity
optional

the maximum number of additions that a guest can reserve in all the reservations he makes

integer (int64)

maxReservable
optional

the maximum number of additions that a guest can reserve in a reservation

integer (int64)

maxTotalQuantity
optional

integer (int64)

unitId
optional

unique id associated with the unit for which the additions can be reserved

integer (int64)

priceCompare
optional

if there is more than one cashflowrule is available for an addition and guest can compare the rates available then the value for the field is true else false

boolean

resourceId
required

unique id associated with the accommodationtype for which the addition is valid

integer (int64)

supplierAdditionId
optional

if a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier’s addition id will be available in this field.

integer (int64)

validFrom
optional

date from which the addition will be applicable for reservation. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

validTo
optional

date till which the addition is valid. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

resourceMoment
optional

it is the show moment of the resource

< string > array

type
optional

It is the type of the resource. The possible values can be: RESOURCEACTIVITY, ACCOMMODATIONTYPE, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

resortArticle
optional

If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

boolean

translations
optional

information of the additions which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

< I18nAddition
> array

addonType
optional

It is the type of the addon.

string

i18n
optional

Write only (field is only accessible in the request body)

< I18nAddition
> array

6.513. ResourceAdditionItem

addition contains all the possible product and extra that can be booked for that accommodationtype in a reservation.

Properties
Name Description Schema

additionResourceId
required

unique id associated with the addition linked to the resource.

integer (int64)

resourceId
required

unique id associated with the accommodationtype for which addition is applicable.

integer (int64)

name
optional

name of the addition.

string

price
optional

the cost of the addition which can be charged on reservation for corresponding addition.

number (double)

code
optional

unique code of addition linked to the resource.

string

type
optional

type of addition linked to the resource.

string

description
optional

description related to the addition linked to the resource.

string

shortDescription
optional

short description related to the addition linked to the resource.

string

currency
optional

unique code associated with each currency.

string

maxQuantity
optional

the maximum quantity which can be reserved in a single reservation.

integer (int32)

minQuantity
optional

the minimum quantity which can be reserved in a single reservation.

integer (int32)

maxReservable
optional

the Maximum number of additions that can be reserved in a reservation.

integer (int32)

startDate
optional

the date from which the addition can be booked in the reservation.

string (date)

endDate
optional

the date till which the addition can be booked in the reservation.

string (date)

resortArticle
optional

If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately.

boolean

addonType
optional

addonType of the addition linked to the resource.

string

stockType
optional

stockType of the addition linked to the resource.

string

dayAddon
optional

indicates the addonType as day

boolean

perSubject
optional

In case the field is true, the add-on price and quantity is per person. This means for each subject this add-on is added.

boolean

dayProductBookableDates
optional

dayProductBookableDates contains all the possible book dates for a DAY product. This will be returned as null in case a product is from another type than DAY .

< string > array

6.514. ResourceAdditionRequest

Properties
Name Description Schema

additionId
optional

unique id associated with each addition

integer (int64)

additionResourceId
optional

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

integer (int64)

additionFast
optional

if the checkbox of additionfast is selected in the system then the value for the field is true else false

boolean

mandatoryResource
optional

if the addition is mandatory for the customer then the value for the field is true else false

boolean

maxQuantity
optional

the maximum number of additions that a guest can reserve in all the reservations he makes

integer (int64)

maxReservable
optional

the maximum number of additions that a guest can reserve in a reservation

integer (int64)

maxTotalQuantity
optional

integer (int64)

unitId
optional

unique id associated with the unit for which the additions can be reserved

integer (int64)

priceCompare
optional

if there is more than one cashflowrule is available for an addition and guest can compare the rates available then the value for the field is true else false

boolean

resourceId
required

unique id associated with the accommodationtype for which the addition is valid

integer (int64)

supplierAdditionId
optional

if a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier’s addition id will be available in this field.

integer (int64)

validFrom
optional

date from which the addition will be applicable for reservation. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

validTo
optional

date till which the addition is valid. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

bookDateFrom
optional

string (date-time)

bookDateTo
optional

string (date-time)

resourceMoment
optional

it is the show moment of the resource

< string > array

type
optional

It is the type of the resource. The possible values can be: RESOURCEACTIVITY, ACCOMMODATIONTYPE, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

translations
optional

information of the additions which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nAddition
> array

addonType
optional

It is the type of the addon.

string

6.515. ResourceAvailability

Properties
Name Description Schema

accommodationKindId
optional

integer (int64)

arrivalDate
optional

string (date)

departureDate
optional

string (date)

duration
optional

integer (int32)

prices
optional

< ResourceAvailablePrice
> array

resortId
optional

integer (int64)

resortCode
optional

string

resourceId
optional

integer (int64)

maxCapacity
optional

integer (int32)

petCapacity
optional

The pet capacity field defines how many pets are allowed in the type. In case only a selection of the units below this type have pets allowed, it will show 0 when all these units where pets are allowed are sold out. If there are units available that allow pets it will show how many pets are allowed.

integer (int32)

units
optional

< integer > array

6.516. ResourceAvailabilityResponse

Properties
Name Description Schema

result
optional

PageAvailabilityResult

filterOptionsResult
optional

AccommodationTypeSearchFilterOption

6.517. ResourceAvailablePrice

Properties
Name Description Schema

basePrice
optional

number (double)

basePriceInclusive
optional

number (double)

referencePrice
optional

number (double)

referencePriceInclusive
optional

number (double)

rateTypeId
optional

integer (int64)

offer
optional

OfferPrice

calculationDate
optional

string (date-time)

6.518. ResourceBudget

Properties
Name Description Schema

budgetId
optional

integer (int64)

resourceId
optional

integer (int64)

originalBudget
optional

number (double)

modifiedBudget
optional

number (double)

budgetDate
optional

string (date)

6.519. ResourceBudgetRequest

Properties
Name Description Schema

turnoverBudget
optional

number (double)

budgetDate
optional

string (date)

6.520. ResourceCostPrice

Properties
Name Description Schema

quantity
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

subjectId
optional

integer (int64)

costPrice
optional

CostPrice

costPriceType
optional

string

6.521. ResourceGroup

Properties
Name Description Schema

groupId
optional

integer (int64)

code
optional

string

translations
optional

< I18nGroup
> array

6.522. ResourceLockReason

Properties
Name Description Schema

reasonId
optional

integer (int64)

translations
optional

< I18nResourceLockReason
> array

6.523. ResourceRangeAvailabilityResponse

Properties
Name Description Schema

results
optional

PageRangeAvailabilityResult

filterOptionsResult
optional

AccommodationTypeRangeSearchFilterOption

6.524. ResourceReservability

Properties
Name Description Schema

reservabilityId
optional

Unique key for reservability row

integer (int64)

resourceId
optional

Resource id for which the result is valid

integer (int64)

resourceType
optional

Resource type of the resourceid

string

startDate
optional

First date these results are valid for

string (date)

endDate
optional

Last date these results are valid for (based on departure, so new results will be valid from same date)

string (date)

allocatable
optional

Number of available units (including free allotments, free sales and excluding unit level reservations)

integer (int64)

reservable
optional

Number of available units (including free allotments, free sales and excluding accommodationtype level reservations and accommodationtype level allotment bookings)

integer (int64)

reserved
optional

Number of booked units (including booked allotment, booked free sales and locks)

integer (int64)

modifiedDate
optional

Last date the reservability has been change

string (date-time)

6.525. ResourceReservabilityAllotment

Properties
Name Description Schema

startDate
optional

string (date)

endDate
optional

string (date)

freeAllotments
optional

integer (int64)

totalAllotments
optional

integer (int64)

bookedAllotments
optional

integer (int64)

resourceId
optional

integer (int64)

distributionChannelId
optional

integer (int64)

6.526. RevenueDistribution

Properties
Name Description Schema

revenueDistributionId
optional

integer (int64)

revenueDistributionNumber
optional

integer (int64)

creationDate
optional

string (date-time)

adminOrganisationId
optional

integer (int64)

status
optional

string

bookDate
optional

string (date-time)

6.527. RevenueDistributionJournal

Properties
Name Description Schema

description
optional

string

journalType
optional

string

journalNumber
optional

string

journalPeriodNumber
optional

integer (int64)

ledgerNumber
optional

string

costCenter
optional

string

costUnit
optional

string

secondLedgerNumber
optional

string

debitVatIncludedDistributionChannelCurrency
optional

Write only (field is only accessible in the request body)

number

creditVatIncludedDistributionChannelCurrency
optional

Write only (field is only accessible in the request body)

number

debitVatExcludedDistributionChannelCurrency
optional

Write only (field is only accessible in the request body)

number

creditVatExcludedDistributionChannelCurrency
optional

Write only (field is only accessible in the request body)

number

debitVatIncluded
optional

Write only (field is only accessible in the request body)

number

creditVatIncluded
optional

Write only (field is only accessible in the request body)

number

debitVatExcluded
optional

Write only (field is only accessible in the request body)

number

creditVatExcluded
optional

Write only (field is only accessible in the request body)

number

exchangeValue
optional

Write only (field is only accessible in the request body)

integer (int64)

distributionChannelCurrencyCode
optional

Write only (field is only accessible in the request body)

string

distributionChannelCurrencyId
optional

Write only (field is only accessible in the request body)

integer (int64)

adminCurrencyCode
optional

Write only (field is only accessible in the request body)

string

adminCurrencyId
optional

Write only (field is only accessible in the request body)

integer (int64)

adminOrganistationCurrency
optional

AdminOrganisationCurrency

distributionchannelCurrency
optional

DistributionChannelCurrency

adminOrganisationId
optional

integer (int64)

revenueDistributionId
optional

integer (int64)

revenueDistributionJournalId
optional

integer (int64)

6.528. Room

Properties
Name Description Schema

roomId
optional

unique id associated with each room

integer (int64)

code
optional

unique code associated with each room

string

parentId
optional

if the room is the child of another room then the id the parent is displayed

integer (int64)

roomManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

roomTypeId
optional

Write only (field is only accessible in the request body)

integer (int64)

name
optional

Write only (field is only accessible in the request body)

string

lowestLevel
optional

if the room does not have any further child associated to it then the field is true else false

boolean

translations
optional

information of the rooms accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nRoom
> array

roomType
optional

RoomType

amenities
optional

amenities associated with the room

< RoomAmenityLinkDetail
> array

6.529. RoomAmenityLink

Properties
Name Description Schema

amenityLinkId
optional

unique id associated which tells the amenity is linked to a resource

integer (int64)

type
optional

type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

visible
optional

if the amenity linked should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

startDate
optional

date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

amenityId
optional

unique id associated with each amenity

integer (int64)

code
optional

unique code associated with each amenity

string

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

roomId
optional

unique id associated with each room

integer (int64)

6.530. RoomAmenityLinkDetail

amenities associated with the room

Properties
Name Description Schema

amenityLinkId
optional

unique link id associated with the amenity linked to the room

integer (int64)

numberValue
optional

if the type of amenity is number then the value of the amenity is displayed in this field

integer (int64)

textValue
optional

if the type of amenity is text then the value of the amenity is displayed in this field

string

6.531. RoomType

details of the roomtype

Properties
Name Description Schema

roomTypeId
optional

unique id associated with each roomtype

integer (int64)

code
optional

unique id associated with each roomtype

string

translations
optional

information of the roomtype accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nRoomType
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nRoomType
> array

6.532. Schedule

Properties
Name Description Schema

issueTaskScheduleId
optional

integer (int64)

numberOfDaysAfterLastExecDate
optional

integer (int64)

numberOfYearsAfterLastExecDate
optional

integer (int64)

startSpecificDayOfMonth
optional

integer (int32)

endSpecificDayOfMonth
optional

integer (int32)

startMonthOfYear
optional

integer (int32)

endMonthOfYear
optional

integer (int32)

startExecOnFinalDayOfMonth
optional

boolean

endExecOnFinalDayOfMonth
optional

boolean

startDayOfWeek
optional

integer (int32)

endDayOfWeek
optional

integer (int32)

6.533. SearchInfoTextRequest

Properties
Name Description Schema

distributionChannelId
required

integer (int64)

reservationCategoryId
required

integer (int64)

resourceId
required

integer (int64)

showMomentId
required

integer (int64)

resortId
required

integer (int64)

arrivalDate
required

string (date)

departureDate
required

string (date)

infotextCategoryId
optional

integer (int64)

unitIds
optional

< integer > array

offerIds
optional

< integer > array

addonIds
optional

< integer > array

amenityIds
optional

< integer > array

subjectIds
optional

< integer > array

6.534. SearchInfoTextResponse

Properties
Name Description Schema

infoTextId
optional

integer (int64)

name
optional

string

content
optional

string

6.535. SearchRequestFilter

Properties
Name Description Schema

distributionChannelId
required

if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown.

integer (int64)

arrivalDate
optional

the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

duration
optional

the duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7.

integer (int32)

filterOptions
optional

filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'resorts', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures , resorts and arrivals available for the requested criteria are displayed in response.

< string > array

includeAllPrices
optional

If includeAllPrices field is passed as true in the request, it will provide 10 records in the response this is only possible for one specific resourceId, if it is provided as false, then only the first record is displayed in the response.

boolean

offerCode
optional

unique code associated with offer on the bases of which accommodationtype is to be filtered

string

offerId
optional

integer (int64)

subjects
optional

Person

resortIds
optional

list of resort ids passed to fetch accommodationtypes which belong to the provided resorts

unique items

< integer > array

resourceIds
optional

list of accommodationtype ids which user wants to apply search on

unique items

< integer > array

petQuantity
optional

the number of pets accommodated in the accommodationtype

integer (int32)

amenityIds
optional

list of amenity ids which are linked to the accommodationtype

unique items

< integer > array

accommodationKindIds
optional

list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched

unique items

< integer > array

includeFilterOptionCounts
optional

an option to return the counts of the different filteroptions

boolean

regionId
optional

region id passed to fetch accommodation types which belong to the provided region

integer (int64)

dateMargin
optional

date margin to search other possible stays (arrival dates and durations) when the requested stay is not available.

integer (int32)

dateMarginMethod
optional

This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it will use the default value: ARRIVAL_DATE_AND_DURATION

enum (ARRIVAL_DATE,DURATION,ARRIVAL_DATE_AND_DURATION,DURATION_AND_ARRIVAL)

voucherCode
optional

string

minNrOfBathrooms
optional

integer (int32)

maxNrOfBathrooms
optional

integer (int32)

minNrOfBedrooms
optional

integer (int32)

maxNrOfBedrooms
optional

integer (int32)

redeemableLoyaltyPoints
optional

Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter.

integer (int32)

qualityLevelIds
optional

unique items

< integer > array

6.536. Sector

Properties
Name Description Schema

sectorId
optional

integer (int64)

name
optional

string

6.537. SendMethod

Properties
Name Description Schema

sendMethodId
optional

integer (int64)

code
optional

string

extraCostResourceId
optional

integer (int64)

type
optional

enum (MAIL,EMAIL,FAX)

isDefault
optional

Write only (field is only accessible in the request body)

boolean

translations
optional

< I18nSendMethod
> array

default
optional

boolean

6.538. SharedOwnerShip

Properties
Name Description Schema

realOwnerId
optional

integer (int64)

ownerId
optional

integer (int64)

6.539. ShowMoment

Properties
Name Description Schema

momentId
optional

integer (int64)

name
optional

enum (ON_CHECK_IN,ON_CHECK_OUT,ON_ASSIGNING_RESERVATION_NUMBER,ON_ASSIGNING_OTHER_STATUS,ON_STORING_SELECTED_RESOURCES_IN_RESERVATION,SHOW_BEFORE_OPENING_SCREEN,SHOW_AFTER_OPENING_SCREEN,ON_SEARCHING_RESOURCES,CHANGING_HOUSE_KEEPING_STATUS,GENERATING_BANK_FILE_FOR_RESERVATION,DEFINITIVE_CANCEL,GENERATING_REMINDER,CHANGING_REMINDER_STATUS,CHANGING_VALIDATION_STATUS,ON_STORING_SELECTED_RESOURCE_IN_BASKET,ON_RESERVATION_WITHOUT_DISPLAYING)

description
optional

string

6.540. SortObject

Properties
Name Description Schema

sorted
optional

boolean

empty
optional

boolean

unsorted
optional

boolean

6.541. SortObject_Basic

Properties
Name Description Schema

sorted
optional

boolean

empty
optional

boolean

unsorted
optional

boolean

6.542. SortObject_Detail

Properties
Name Description Schema

sorted
optional

boolean

empty
optional

boolean

unsorted
optional

boolean

6.543. SortObject_Id

Properties
Name Description Schema

sorted
optional

boolean

empty
optional

boolean

unsorted
optional

boolean

6.544. Source

Properties
Name Description Schema

sourceId
optional

integer (int64)

startDate
optional

string (date-time)

endDate
optional

string (date-time)

code
optional

string

showOnInternet
optional

boolean

sourceCategoryId
optional

integer (int64)

translations
optional

< I18nSource
> array

6.545. SourceCategory

Properties
Name Description Schema

categoryId
optional

integer (int64)

translations
optional

< I18nSource
> array

parentId
optional

integer (int64)

6.546. State

Properties
Name Description Schema

stateId
optional

integer (int64)

code
optional

string

countryId
optional

integer (int64)

name
optional

string

description
optional

string

6.547. StaySummary

Properties
Name Description Schema

arrivalDate
optional

string (date)

duration
optional

integer (int64)

validFrom
optional

string (date-time)

validTo
optional

string (date-time)

rentabilityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

6.548. Subject

details related to the subject

Properties
Name Description Schema

subjectId
optional

unique id associated with each subject

integer (int64)

type
optional

type of the subject who will come for stay. Possible values that can be encountered are: PET, CATEGORY, PERSON, VEHICLE, OTHER

enum (PET,CATEGORY,PERSON,VEHICLE,OTHER,EQUIPMENT)

maxAge
optional

maximum age of the subject who is allowed under the given type

integer (int32)

controlAccess
optional

if the checkbox is checked in the system then the value is true else false. The default value for this is true

boolean

endDate
optional

date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

includeInTotal
optional

if the cost related to the subject is already included in the bill, then this value is true else false

boolean

subjectOrder
optional

order in which the subject is configured

integer (int32)

reportGroupSubjectId
optional

Write only (field is only accessible in the request body)

integer (int32)

subjectCategoryId
optional

The subject category id is the same across all resorts and will map the subjects over the resorts even though that the max Age can be different. This can be used to add an icon or styling based on the subject or equipment without making rules based on resort-specific subject data.

integer (int64)

translations
optional

information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nSubject
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nSubject
> array

6.549. SubjectCategory

Properties
Name Description Schema

subjectId
optional

unique id associated with each subject

integer (int64)

maxAge
optional

maximum age of the subject who is allowed under the given type

integer (int32)

sort
optional

sort of the subject who is allowed under the given type

integer (int32)

endDate
optional

date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

translations
optional

information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nSubject
> array

i18n
optional

Write only (field is only accessible in the request body)

< I18nSubject
> array

6.550. SubjectPrice

subject based rates for groups of persons. If a subjectprices entry is available the regular price field will not be used and will return 0.

Properties
Name Description Schema

minQuantity
optional

Minimum number of subjects where the price does apply to

integer (int32)

price
optional

The price per person which applies to the minimum number of subject. The different prices need to be combined. For example if there is a price for minimum quantity 1 which is 20 and minimum quantity 2 which is 10. When there are 3 subjects the total price will be 20 + 10 + 10 = 40.If a subjectprices entry is available the regular price field is not used and will return 0.

number (double)

subjectIds
optional

The list of subject for which this subject price applies to.

< integer > array

6.551. Tag

Properties
Name Description Schema

tagId
optional

unique id associated with each tag

integer (int64)

name
optional

name of the tag

string

6.552. TargetAmount

Properties
Name Description Schema

resourceTargetAmountId
optional

integer (int64)

resourceId
optional

integer (int64)

fiscalYear
optional

FiscalYearResponse

fiscalyearId
optional

Write only (field is only accessible in the request body)

integer (int64)

contractTypeId
optional

integer (int64)

targetAmount
optional

integer (int64)

rentAssuranceBase
optional

integer (int64)

accommodationtypePriorityId
optional

integer (int64)

maxMaintenanceFund
optional

number (double)

maxFundPerInvReservation
optional

number (double)

ownerId
optional

integer (int64)

maxFundPerInvForMaterial
optional

number (double)

maxFundPerInvForWorktime
optional

number (double)

maxFundPerWorkorder
optional

number (double)

6.553. Task

Properties
Name Description Schema

planningId
optional

integer (int64)

assignee
optional

string

status
optional

enum (ASSIGNED,DONE,CANCELLED,RESCHEDULE,INPROGRESS,UNASSIGNED,DELETED)

duration
optional

integer (int64)

remark
optional

string

taskId
optional

integer (int64)

employeeId
optional

integer (int64)

6.554. TemporaryReservedResourceSubject

Properties
Name Description Schema

subjectId
optional

integer (int64)

quantity
optional

specify the no. of persons are for which the accommodation is booked.

integer (int32)

type
optional

specify the the type of subject like PET, PERSON, VEHICLE, OTHER.

enum (PET,CATEGORY,PERSON,VEHICLE,OTHER,EQUIPMENT)

maxAge
optional

specify the the max age of subject.

integer (int32)

translations
optional

information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nSubject
> array

includeInTotal
optional

if the cost related to the subject is already included in the bill, then this value is true else false

boolean

6.555. TemporaryResourceAddition

An addition(product/extra) that can be added on an offer.
Note: The translations are not allowed while adding an addtion on offer.

Properties
Name Description Schema

additionId
optional

unique id associated with each addition

integer (int64)

additionResourceId
optional

integer (int64)

additionFast
optional

if the checkbox of additionfast is selected in the system then the value for the field is true else false

boolean

mandatoryResource
optional

if the addition is mandatory for the customer then the value for the field is true else false

boolean

maxQuantity
optional

the maximum number of additions that a guest can reserve in all the reservations he makes

integer (int64)

maxReservable
optional

the maximum number of additions that a guest can reserve in a reservation

integer (int64)

maxTotalQuantity
optional

integer (int64)

unitId
optional

unique id associated with the unit for which the additions can be reserved

integer (int64)

priceCompare
optional

if there is more than one cashflowrule is available for an addition and guest can compare the rates available then the value for the field is true else false

boolean

resourceId
required

unique id associated with the accommodationtype for which the addition is valid

integer (int64)

supplierAdditionId
optional

if a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier’s addition id will be available in this field.

integer (int64)

validFrom
optional

date from which the addition will be applicable for reservation. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

validTo
optional

date till which the addition is valid. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

string (date)

resourceMoment
optional

it is the show moment of the resource

< string > array

type
optional

It is the type of the resource. The possible values can be: RESOURCEACTIVITY, ACCOMMODATIONTYPE, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION

enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION)

resortArticle
optional

If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

boolean

translations
optional

information of the additions which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Read only (field is only visible in the response body, the value cannot be updated or added using this field)

< I18nAddition
> array

addonType
optional

It is the type of the addon.

string

bookDateFrom
optional

date from which the addition is bookable. The format of the date will be in ISO 8601 standard(yyyy-MM-ddThh:mm:sssZ)

string (date-time)

bookDateTo
optional

date till which the addition is bookable. The format of the date will be in ISO 8601 standard(yyyy-MM-ddThh:mm:sssZ)

string (date-time)

i18n
optional

Write only (field is only accessible in the request body)

< I18nAddition
> array

6.556. Transaction

Properties
Name Description Schema

transactionId
optional

integer (int64)

transactionType
required

enum (CHECKOUT,REGISTRATION,RESERVATION,EXPIRATION,MANUAL,EXTERNAL,REGISTRATION_DUPLICATE)

transactionDate
optional

string (date-time)

activationDate
optional

string (date)

expirationDate
optional

string (date)

reservationId
optional

integer (int64)

originalPoints
optional

integer (int32)

remainingPoints
optional

integer (int32)

remark
optional

string

employeeId
optional

integer (int64)

customerId
optional

integer (int64)

reservedResourceId
optional

integer (int64)

6.557. Unit

Properties
Name Description Schema

unitId
optional

integer (int64)

accommodationAddressManagerId
optional

integer (int64)

accommodationMemoManagerId
optional

integer (int64)

archivedFrom
optional

string (date)

resourceId
optional

integer (int64)

brandId
optional

integer (int64)

capacityManagerId
optional

integer (int64)

choosableOnInternet
optional

boolean

code
optional

string

concernId
optional

integer (int64)

costCenterId
optional

integer (int64)

dynamicManagerId
optional

integer (int64)

eventManagerId
optional

integer (int64)

excludeQuestionnaireStats
optional

boolean

fileManagerId
optional

integer (int64)

genericMemoManagerId
optional

integer (int64)

groupPriority
optional

integer (int32)

imageManagerId
optional

integer (int64)

implicationManagerId
optional

integer (int64)

ledgerId
optional

integer (int64)

nrOfBathrooms
optional

number (double)

nrOfBedrooms
optional

integer (int32)

originId
optional

string

path
optional

string

amenityManagerId
optional

integer (int64)

questionnaireStatsManagerId
optional

integer (int64)

rentableUnitId
optional

integer (int64)

resourceGroupId
optional

integer (int64)

resourceManagerId
optional

integer (int64)

roomCode
optional

string

secondLedgerId
optional

integer (int64)

cleaningStatus
optional

enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP)

supervisorId
optional

integer (int64)

type
optional

string

virtual
optional

boolean

vsi
optional

integer (int64)

roomManagerId
optional

integer (int64)

contactManagerId
optional

integer (int64)

setupDate
optional

string (date)

isSeasonalRuleExcluded
optional

boolean

cadastralId
optional

string

showOnPlanningChart
optional

boolean

translations
optional

< I18nUnit
> array

origin
optional

string

address
optional

Address

impliedObject
optional

boolean

6.558. UnitAmenityLink

Properties
Name Description Schema

amenityLinkId
optional

unique id associated with each amenity link

integer (int64)

amenityId
optional

unique id associated with each amenity

integer (int64)

endDate
optional

date till which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

startDate
optional

date from which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

numberValue
optional

if the amenity is of type number then the value provided to the amenity is displayed here

number (double)

textValue
optional

if the amenity is of type text then the value provided to the amenity is displayed here

string

visible
optional

if the amenity should be visible to the user then this field is true else false

boolean

preferenceExtraId
optional

the id associated to the extra

integer (int64)

origin
optional

the field tells if the amenity is of the resource itself or is inherited from the parent resource. Possible values can be: SELF, PARENT, CHILD

enum (SELF,PARENT,CHILD)

translations
optional

information of the amenities available in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

< I18nAmenity
> array

type
optional

type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

enum (SIMPLE,NUMBER,TEXT,LIST,GROUP)

unitId
optional

unique id associated with each unit

integer (int64)

archivedFrom
optional

date from which the amenity was archived. The amenities will not be displayed if the amenity is archived. Thus for all amenities which are being displayed the value will be null.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

identifier
optional

value of the identifier associated with an amenity linked

string

metric
optional

Metric

parentAmenityId
optional

if the amenity has a parent then the id of the parent amenity is displayed in this field

integer (int64)

categories
optional

details related to group of amenities

< AmenityCategory
> array

6.559. UnitAvailabilityResponse

Properties
Name Description Schema

result
optional

PageUnitAvailabilityResult

filterOptionsResult
optional

FilterOption

6.560. UnitAvailabilityResult

Properties
Name Description Schema

resourceId
optional

The unique id of the accommodationtype

integer (int64)

resortId
optional

The unique id associated with the resort to which the accommodationtype belong

integer (int64)

accommodationKindId
optional

The accommodation Kind id associated with each accommodationtype

integer (int64)

arrivalDate
optional

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

departureDate
optional

The date on which customer/guest will leave. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

offerCode
optional

The unique code associated with the offer

string

offerName
optional

The name of the offer

string

basePrice
optional

Basic unit rent price without any additional costs or addons included

number (double)

basePriceInclusive
optional

Basis unit rent price including mandatory additional costs configured as internet additional cost

number (double)

offerPrice
optional

The lowest offer price available for the particular stay without any additional costs or addons included

number (double)

offerPriceInclusive
optional

The lowest offer price available for the particular stay including mandatory additional costs configured as internet additional cost

number (double)

unitId
optional

the unique identifier of the unit where the available stay and price applies to

integer (int64)

totalCapacity
optional

Total capacity accommodated in the unit

integer (int32)

unitRating
optional

Average rating guests have given for the unit through surveys

number (double)

duration
optional

The duration(number of nights) for which a guest will stay at the unit

integer (int32)

rateTypeId
optional

The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type

integer (int64)

priority
optional

Write only (field is only accessible in the request body)

integer (int32)

nrOfBathrooms
optional

Number of bathrooms in the unit

number (double)

nrOfBedrooms
optional

Number of bedrooms in the unit

integer (int32)

loyaltyPrice
optional

Price including offers and loyalty

number (double)

loyaltyPriceInclusive
optional

Price including offers, loyalty and additional costs

number (double)

requiredLoyaltyPoints
optional

The required number of points for this loyalty price

integer (int32)

freeLoyaltyDuration
optional

The number of free nights for this number of loyalty points

integer (int32)

6.561. UnitDetail

Properties
Name Description Schema

unitId
optional

unique id associated with each unit

integer (int64)

type
optional

Write only (field is only accessible in the request body)

string

resourceId
optional

unique id associated with the accommodationtype to which the unit belong

integer (int64)

code
optional

unique code associated with each unit

string

nrOfBathrooms
optional

total number of bathrooms that a unit possess

number (double)

path
optional

the field denotes where the unit is located

string

excludeQuestionnaireStats
optional

if the questionnaire is to be excluded then the checkbox is selected in the system and the value is true else false

boolean

choosableOnInternet
optional

if this is selected then the unit will be available in the dropdownbox on internet, then the value is true else

boolean

resourceGroupId
optional

unique id associated with the group of accommodationtype to which the unit belongs

integer (int64)

cleaningStatus
optional

status of clean is defined i.e

enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP)

roomCode
optional

unique code associated with each room which lies in the unit

string

nrOfBedrooms
optional

total number of bedrooms in the unit

integer (int64)

archivedFrom
optional

date from which the unit was archived. The unit will not be displayed if the unit is archived. Thus for all units which are being displayed the value will be null

string (date)

vsi
optional

vsi value of unit

integer (int64)

implicationManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

roomManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

capacityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

dynamicManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

brandId
optional

Write only (field is only accessible in the request body)

integer (int64)

resourceManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

accommodationAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

address
optional

Address

translations
optional

information of the unit which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nUnit
> array

capacities
optional

The maximum number of subjects for which the unit can be booked including all the younger subjects than adult for e.g Child and Infant

< CapacityDetail
> array

capacityRequirements
optional

The minimum number of subjects which are mandatory for making a reservation. If requirement of 4 adults is configured then 4 adults are mandatory for making a reservation

< Requirement
> array

rooms
optional

different part of units are considered as rooms ex: bedrooms, living rooms etc

< Room
> array

images
optional

details of the images associated to the accommodationtype

< Image
> array

videos
optional

details associated with videos related to the accommodationtype

< Video
> array

dynamicFields
optional

user-defined and customized fields

< DynamicField
> array

amenityCategorySets
optional

details related to group of amenity categories

< AmenityCategorySetDetail
> array

origin
optional

string

originId
optional

string

doorLockTypes
optional

SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty.

< DoorLockType
> array

energyLabelRegistrationNumber
optional

Energy Label RegistrationNumber associated with each unit

string

previousPmsId
optional

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

string

rentableUnitId
optional

integer (int64)

6.562. UnitDetail_Id

Properties
Name Description Schema

unitId
optional

unique id associated with each unit

integer (int64)

type
optional

Write only (field is only accessible in the request body)

string

resourceId
optional

unique id associated with the accommodationtype to which the unit belong

integer (int64)

code
optional

unique code associated with each unit

string

nrOfBathrooms
optional

total number of bathrooms that a unit possess

number (double)

path
optional

the field denotes where the unit is located

string

excludeQuestionnaireStats
optional

if the questionnaire is to be excluded then the checkbox is selected in the system and the value is true else false

boolean

choosableOnInternet
optional

if this is selected then the unit will be available in the dropdownbox on internet, then the value is true else

boolean

resourceGroupId
optional

unique id associated with the group of accommodationtype to which the unit belongs

integer (int64)

cleaningStatus
optional

status of clean is defined i.e

enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP)

roomCode
optional

unique code associated with each room which lies in the unit

string

nrOfBedrooms
optional

total number of bedrooms in the unit

integer (int64)

archivedFrom
optional

date from which the unit was archived. The unit will not be displayed if the unit is archived. Thus for all units which are being displayed the value will be null

string (date)

vsi
optional

vsi value of unit

integer (int64)

implicationManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

roomManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

imageManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

capacityManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

dynamicManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

brandId
optional

Write only (field is only accessible in the request body)

integer (int64)

resourceManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

accommodationAddressManagerId
optional

Write only (field is only accessible in the request body)

integer (int64)

address
optional

Address_Id

translations
optional

information of the unit which depends on a language and is translatable by the user. Multiple entries for different language can exist.

< I18nUnit_Id
> array

origin
optional

string

originId
optional

string

energyLabelRegistrationNumber
optional

Energy Label RegistrationNumber associated with each unit

string

previousPmsId
optional

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

string

rentableUnitId
optional

integer (int64)

6.563. UnitDoorlock

Properties
Name Description Schema

unitId
optional

integer (int64)

doorLockTypes
optional

< DoorLockType
> array

6.564. UnitMap

Coordinates of the unit

Properties
Name Description Schema

unitId
optional

integer (int64)

getxValue
optional

integer (int32)

getyValue
optional

integer (int32)

6.565. UnitReservability

Properties
Name Description Schema

reservabilityId
optional

Unique key for reservability row

integer (int64)

resourceId
optional

Resource id for which the result is valid

integer (int64)

unitId
optional

Unit id for which the result is valid

integer (int64)

arrivalDateFrom
optional

First date these results are valid for

string (date)

arrivalDateTo
optional

Last date these results are valid for (based on departure, so new results will be valid from same date)

string (date)

allocatable
optional

Number of available units (including free allotments, free sales and excluding unit level reservations)

integer (int64)

reservable
optional

Number of available units (including free allotments, free sales and excluding accommodationtype level reservations and accommodationtype level allotment bookings)

integer (int64)

reserved
optional

Number of booked units ( including booked allotment, booked free sales and locks)

integer (int64)

modifiedDate
optional

Last date the reservability has been change

string (date-time)

6.566. UnitReservabilityPeriod

Properties
Name Description Schema

unitId
optional

integer (int64)

startDate
optional

string (date)

endDate
optional

string (date)

reservability
optional

string

6.567. UnitSearchRequestFilter

Properties
Name Description Schema

distributionChannelId
required

if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown.

integer (int64)

arrivalDate
optional

the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

duration
optional

the duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7.

integer (int32)

filterOptions
optional

filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'resorts', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures , resorts and arrivals available for the requested criteria are displayed in response.

< string > array

includeAllPrices
optional

if the user passed this field as true then 10 records will be shown in response else only one element is shown in response

boolean

offerCode
optional

unique code associated with offer on the bases of which accommodationtype is to be filtered

string

offerId
optional

integer (int64)

subjects
optional

Person

resortId
optional

resort id passed to fetch units which belong to the provided resorts

integer (int64)

resourceIds
optional

list of accommodationtype ids which user wants to apply search on

unique items

< integer > array

petQuantity
optional

the number of pets accommodated in the accommodationtype

integer (int32)

amenityIds
optional

list of amenity ids which are linked to the accommodationtype

unique items

< integer > array

accommodationKindIds
optional

list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched

unique items

< integer > array

includeFilterOptionCounts
optional

an option to return the counts of the different filteroptions

boolean

regionId
optional

region id passed to fetch accommodation types which belong to the provided region

integer (int64)

dateMargin
optional

date margin to search other possible stays (arrival dates and durations) when the requested stay is not available.

integer (int32)

dateMarginMethod
optional

This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it will use the default value: ARRIVAL_DATE_AND_DURATION

enum (ARRIVAL_DATE,DURATION,ARRIVAL_DATE_AND_DURATION,DURATION_AND_ARRIVAL)

voucherCode
optional

string

minNrOfBathrooms
optional

integer (int32)

maxNrOfBathrooms
optional

integer (int32)

minNrOfBedrooms
optional

integer (int32)

maxNrOfBedrooms
optional

integer (int32)

redeemableLoyaltyPoints
optional

Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter.

integer (int32)

6.568. UpdateAccommodationTypeRequest

Properties
Name Description Schema

checkinTime
optional

LocalTime

checkoutTime
optional

LocalTime

earlyCheckinTime
optional

LocalTime

lateCheckoutTime
optional

LocalTime

nrOfBedrooms
optional

number (double)

nrOfBathrooms
optional

number (double)

translations
optional

< I18nAddition
> array

accotypeKindId
optional

integer (int64)

address
optional

CreateAddressRequest

brandId
optional

integer (int64)

code
optional

string

parentId
optional

integer (int64)

priority
optional

integer (int64)

resortId
optional

integer (int64)

origin
optional

string

originId
optional

string

6.569. UpdateAddressRequest

Properties
Name Description Schema

addressId
required

integer (int64)

accuracy
optional

Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE

enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE)

address1
optional

the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address2
optional

the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

address3
optional

the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

alternateContactPerson
optional

name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

boxNumber
optional

number used as an address

string

city
optional

city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

dateEnd
optional

date when the accommodationtype/resort/unit is archived

string (date)

dateBegin
optional

date on which the accommodationtype/resort/unit was created

string (date)

district
optional

district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

email
optional

email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

exposeLocation
optional

if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false

boolean

fax
optional

fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

houseNumber
optional

house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

houseNumberSuffix
optional

a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

latitude
optional

latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

longitude
optional

longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value.

number (double)

mobilePhone
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

mobilePhone2
optional

mobilephone number through which the person in the accommodationtype/resort/unit can be contacted

string

municipality
optional

name of the general-purpose administrative subdivision

string

poBox
optional

numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxZipcode
optional

zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

poBoxCity
optional

city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

privatePhone
optional

the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

stateId
optional

unique id associated with each state

integer (int64)

workPhone
optional

the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

zipCode
optional

zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value.

string

6.570. UpdateAdminOrganisationRequest

Properties
Name Description Schema

code
required

unique code of the admin organisation

Maximum Length: 50
Minimum Length: 0

string

currencyId
required

currencyId of the admin organisation

integer (int64)

description
required

Maximum Length: 4000
Minimum Length: 0

string

name
required

Maximum Length: 50
Minimum Length: 0

string

origin
required

Origin name of the Admin Organisation

string

originId
required

Origin Id of the Admin Organisation

string

6.571. UpdateAmenityLinkRequest

Request body to update or create a amenity link

Properties
Name Description Schema

amenityId
optional

unique id associated with each amenity

integer (int64)

endDate
optional

date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

startDate
optional

date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

textValue
optional

if the amenity is of type text then the value provided to the amenity should be passed here

string

numberValue
optional

if the amenity is of type number then the value provided to the amenity should be passed here

number (double)

6.572. UpdateContractRequest

Properties
Name Description Schema

contractId
optional

integer (int64)

code
required

string

name
required

string

ownerId
required

integer (int64)

unitId
optional

integer (int64)

startDate
required

string (date)

endDate
optional

string (date)

targetAmount
optional

number (double)

contractTypeId
required

integer (int64)

resourceId
optional

integer (int64)

poolOwnerId
optional

integer (int64)

origin
optional

string

originId
optional

string

rentAssurance
optional

number (double)

6.573. UpdateFinancialReportRequest

Properties
Name Description Schema

status
optional

string

6.574. UpdateImageRequest

Properties
Name Description Schema

startDate
optional

string (date)

endDate
optional

string (date)

imageOrientation
optional

string

imageType
optional

enum (LOGO,FLOORPLAN,ROADMAP,INTERIOR,EXTERIOR,MUGSHOT,PICTURE,MAP,IMPRESSION,UNKNOWN,LOCATION_MAP,HEADER,VIDEO360,ICON,OPERATIONS,STATUSICON)

sequenceNumber
optional

integer (int64)

tags
optional

< Tag
> array

translations
optional

< I18nImage
> array

version
optional

integer (int64)

6.575. UpdateOwnerFinancialTransactionRequest

Properties
Name Description Schema

status
optional

string

6.576. UpdateOwnerRequest

Properties
Name Description Schema

accountNr
optional

string

alternateName
optional

string

attentionOf
optional

string

bicSwift
optional

string

birthDate
optional

string (date)

company
optional

boolean

companyName
optional

string

emailAllowed
optional

boolean

firstName
optional

string

fiscalTypes
optional

< OwnerFiscalType
> array

ibanNumber
optional

string

lastName
optional

string

mailAddress
optional

UpdateAddressRequest

mailAllowed
optional

boolean

middle
optional

string

sendMethodId
optional

integer (int64)

sex
optional

string

titleId
optional

integer (int64)

origin
optional

string

originId
optional

string

ownerGroupId
optional

integer (int64)

ownerPool
optional

enum (OWNER,POOL,RENT_ASSURANCE_POOL,YEAR_ROUND_GUEST,BUSINESS,LOCATION,MAINTAINANCE_FUND,VENDOR,POOL_CONSUMPTION,POOL_SHARE)

questionnaireUnsubscribed
optional

boolean

6.577. UpdateReservationSubjectRequest

A subject object to be added on reserved resource of a reservation

Properties
Name Description Schema

travelParties
optional

< ReservationPersonSubject
> array

vehicles
optional

< ReservationVehicleSubject
> array

equipments
optional

< ReservationEquipment
> array

6.578. UpdateResortRequest

Request body to update the resort.

Properties
Name Description Schema

adminOrganisationId
optional

integer (int64)

code
optional

string

internalResortNumber
optional

string

origin
optional

string

originId
optional

string

parentId
optional

integer (int64)

resortNumber
optional

integer (int64)

resortPriority
optional

integer (int64)

visitAddress
optional

CreateAddressRequest

mailAddress
optional

CreateAddressRequest

translations
optional

< CreateResortTranslation
> array

6.579. UpdateRevenueDistributionRequest

Properties
Name Description Schema

status
optional

string

6.580. UpdateUnitAmenitylinkRequest

Properties
Name Description Schema

startDate
optional

Date from which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

Date till which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

string (date)

6.581. UpdateUnitRequest

Properties
Name Description Schema

cleaningStatus
optional

string

translations
optional

< I18nUnit
> array

address
optional

UpdateAddressRequest

code
optional

unique code of the unit

string

nrOfBathrooms
optional

number (double)

nrOfBedrooms
optional

integer (int32)

resourceId
optional

accommodationtype the unit applies to

integer (int64)

originId
optional

identifier from the origin system

string

origin
optional

system the unit is created in

string

rentableUnitId
optional

integer (int64)

6.582. Validity

Properties
Name Description Schema

reservationCategoryIds
optional

< integer > array

distributionChannelIds
optional

< integer > array

ownerIds
optional

< integer > array

resortIds
optional

< integer > array

reservationDateFrom
optional

string (date)

reservationDateTo
optional

string (date)

arrivalDateFrom
optional

string (date)

arrivalDateTo
optional

string (date)

departureDateFrom
optional

string (date)

departureDateTo
optional

string (date)

stayDateFrom
optional

string (date)

stayDateTo
optional

string (date)

6.583. Video

details associated with videos related to the accommodationtype

Properties
Name Description Schema

videoId
optional

unique id associated with each video

integer (int64)

startDate
optional

date from which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

endDate
optional

date till which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd)

string (date)

url
optional

url of the video

string

isUploaded
optional

if the isActive field is enabled in the system then the value of this field is true else false

boolean

mediaType
optional

the type of the media will be displayed i.e VIDEO

enum (IMAGE,VIDEO,VIDEO360)

hostType
optional

host type of the video

enum (YOUTUBE,VIDEO23,CLOUDINARY,EXTERNAL,MATTERPORT)

isActive
optional

if the field is enabled in the system then it depicts true else false

boolean

isWebPresentation
optional

the field is true if the video uploaded is a web presentation else false

boolean

mediaLanguageId
optional

Write only (field is only accessible in the request body)

integer (int64)

mediaLanguageCode
optional

code of language in which the video is uploaded

string

thumbnailUrl
optional

url of the video thumbnail

string

sequenceNumber
optional

the sequence in which the video will be visible to the user

integer (int32)

6.584. Voucher

Properties
Name Description Schema

voucherId
optional

integer (int64)

type
optional

enum (DISCOUNT,CASH,COMPENSATION)

code
optional

string

status
optional

enum (NOT_USED,USED,BLOCKED,PARTIALLY_USED)

originalReservationId
optional

integer (int64)

voucherOriginalValue
optional

number

voucherValue
optional

number

voucherSetId
optional

integer (int64)

validFrom
optional

string (date)

validTo
optional

string (date)

employeeId
optional

integer (int64)

employeeName
optional

string

generationDate
optional

string (date)

voucherCriteriaId
optional

integer (int64)

voucherTypeName
optional

string

voucherSetName
optional

string

voucherSetResourceCode
optional

string

voucherSetCashResourceId
optional

integer (int64)

resourceCode
optional

string

printCount
optional

integer (int32)

numberOfVouchers
optional

integer (int32)

blockReason
optional

string

6.585. VoucherRedemption

List of Special Vouchers redeemed for reservation.

Properties
Name Description Schema

voucherRedemptionId
optional

integer (int64)

voucherId
optional

integer (int64)

reservationId
optional

integer (int64)

status
optional

enum (NOT_USED,USED,BLOCKED,PARTIALLY_USED)

amount
optional

number

blockReason
optional

string

voucher
optional

Voucher

6.586. WorkOrderTaskConfigurationResort

Properties
Name Description Schema

resortId
optional

integer (int64)

6.587. Workorder

Properties
Name Description Schema

unitId
optional

integer (int64)

workOrderId
optional

integer (int64)

status
optional

enum (DECLINED,ERROR_IN_INVOICE,MAY_BE_DECLINED,BLANK,NEW,ASSIGNED,ON_HOLD,CLOSED,READY_FOR_INVOICE,BILLED,NOT_TO_BE_BILLED,ADMIN_ON_HOLD,ON_HOLD_QUOTE,INTERNAL,IN_PROGRESS,UNDEFINED)

item
optional

string

description
optional

string

assigneeEmployeeId
optional

integer (int64)

reporterEmployeeId
optional

integer (int64)

expectedStartDate
optional

string (date)

reservationId
optional

integer (int64)

areaName
optional

string

totalWorkTime
optional

integer (int32)

totalLabourPrice
optional

number (double)

totalMaterialPrice
optional

number (double)

materialSupplier
optional

string

issueCategoryName
optional

string

reportedOn
optional

string (date-time)

priority
optional

enum (URGENT,TODAY,TOMORROW,SPECIFIC_DATE,NOT_IMPORTANT,NEXT_DEPARTURE_DATE)

reportedWorkOrder
optional

string

resortId
optional

integer (int64)

resourceId
optional

integer (int64)

solvedDate
optional

string (date-time)

referenceNumber
optional

integer (int64)