Maxxton Documentation

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.

Production:

https://api.maxxton.net

A collection of similar units grouped together.

Endpoints

POST

GET

PUT

GET

POST

GET

POST

GET

PUT

GET

POST

GET

POST

GET

POST

GET

A product or extra that can be booked optionally in a reservation or will be added mandatory to the reservation. Examples of optional addons are: bedlinnen, breakfast, baby cot. Example of mandatory addons are: cleaning, tourist tax

Endpoints

GET

PUT

GET

A main level to funnel the companies, locations, employees, accounts and other properties that exclusively belongs to that Admin organisation.

Endpoints

POST

GET

PUT

GET

PUT

GET

PUT

GET

PUT

The allocation of a certain number of accommodation types or units for a specific period or purpose per distribution channel.

Endpoints

GET

A feature or service provided to enhance the guest experience, such as a pool, gym, or Wi-Fi.

Endpoints

POST

GET

Authenticate to get access to the API. Authentication details can be provided by the Maxxton client who would like to give access to their environment using the API.

Endpoints

POST

A distinctive name associated with a specific product or service.

Endpoints

GET

The process of reconciling and recording cash transactions to ensure accurate financial records.

Endpoints

GET

A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.

Endpoints

POST

DELETE

GET

PUT

GET

All available countries, the countries are configured in Maxxton.

Endpoints

GET

The type of money used in financial transactions, such as USD or EUR.

Endpoints

GET

A certain label that is given to a customer. This can be assigned automatically or manually.

Endpoints

GET

An individual or entity that purchases or uses accommodations or services.

Endpoints

POST

GET

PUT

GET

PUT

GET

PUT

GET

POST

GET

POST

GET

The sales channel through which products or services are delivered to customers.

Endpoints

GET

An individual working for an organization, responsible for various tasks or roles.

Endpoints

POST

GET

PUT

When certain entities are changed this will result in an event. This event can be used to update/refresh the data in the external system.

Endpoints

GET

A physical location or infrastructure used to support operations or services.

Endpoints

GET

Grouping of certain entities such as marketing groups, location groups in Maxxton.

Endpoints

GET

A specific job or duty that needs to be done on an accommodation on a specified date and time.

Endpoints

GET

Ical calendar file to show reservations made for a certain unit. Mostly used for owners to show the usage of their unit.

Endpoints

GET

A piece of informative text visible to the customer.

Endpoints

POST

GET

The choice of language for user interfaces, or communication within the system.

Endpoints

GET

A comprehensive record of all financial transactions, including accounts and balances.

Endpoints

GET

A physical place or address where accommodations or services are provided like a location.

Endpoints

POST

GET

PUT

GET

PUT

GET

PUT

GET

POST

GET

A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.

Endpoints

GET

A remark or informative text added to an entity.

Endpoints

GET

A discount or additional product/service that can be added to a reservation.

Endpoints

POST

GET

PUT

POST

GET

PUT

POST

DELETE

GET

POST

GET

POST

GET

Technical services which handles tasks to fix issues or maintenance in units.

Endpoints

GET

An individual or entity that holds a contractual agreement with the admin organization. Based on this agreement, the owner earns income when specific accommodations they control are utilized in reservations.

Endpoints

POST

GET

PUT

GET

PUT

GET

POST

GET

POST

GET

PUT

Multiple add-ons which can be booked together.

Endpoints

GET

Conditions like when and in how many times to pay the full reservation. The payment term sets will result in the instalments, with the actual amount to pay, when chosen in the reservation.

Endpoints

GET

Certain interesting features around the location such as cities, airports, theme parks.

Endpoints

GET

A brief written message or note used for communication or record-keeping within the software.

Endpoints

GET

The category or classification of rates based on their application and currency such as BAR rate or tour operator rate.

Endpoints

GET

A geographical area or division used for organizing and managing locations or data.

Endpoints

GET

The rules and conditions that define how an accommodation, product or services property can be booked or used. For example, the allowed arrival and departure date for an accommodation type.

Endpoints

GET

Triangle view of rentability, accommodation type, and distribution channel. Representations exist to connect a (set) of rentability rules to a (group) of distribution channels.

Endpoints

DELETE

GET

PUT

POST

DELETE

GET

An individual or entity that sells products or services on behalf of another company.

Endpoints

GET

Actual count of available units per period or date without considering if it's allowed to arrive or depart on the certain date.

Endpoints

GET

An arrangement to secure an accommodation or service for a specific time and date.

Endpoints

POST

GET

PUT

GET

POST

GET

POST

GET

POST

GET

POST

GET

POST

GET

POST

GET

DELETE

PUT

GET

DELETE

GET

PUT

POST

GET

Creates a new reservation based on given criteria. Reservation with multiple AccommodationType does not support VoucherCode, and in case codes are provided then an error is thrown.

Header Parameters

localestring

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

Query Parameters

returnBillboolean

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

returnInstalmentsboolean

The instalments will be returned when the value is set to true

skipAvailabilityIndexCheckboolean

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.

Default value

false

Body Parameters

distributionChannelCodestring Required

Unique code associated with distribution channel.

categoryCodestring Required

Unique code associated with reservation category.

accommodationTypesarray Required

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

Show child attributes

remarkstring

If guest wants to specify some feedback to the location, then the feedback given by the customer is displayed.

externalBookingReferencestring

If the tour operator wants to store their reservation reference number, then it is displayed under this field.

employeestring

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.

sendMethodCodestring

This field specifies how the guest can be communicated to i.e via email or post

statusValuestring

This field hold the status, in which reservation will create. We create reservation with OPTIONAL or QUOTATION or PROVISIONAL or PRE_BOOKING or REQUEST 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 values:

PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL

... 7 other enums

customerIdinteger (int64)

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/v2/customers/login.

customerobject

details related to the customer. This entity will create a new customer, in case the customer needs to login use customerId field instead.

Show child attributes

rateTypeIdinteger (int64)

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

paymentTermSetIdinteger (int64)

Response

200

Object

The request is completed successfully without any errors

Response Attributes

reservationIdinteger (int64)

Unique id of newly created reservation.

reservationNumberstring

Represent the unique number of newly created reservation.

arrivalDatestring (date)

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

currencyCodestring

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

departureDatestring (date)

The date on which customer/guest will leave the accommodation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

reservationDatestring (date-time)

Date on which the reservation is created.

statusValuestring

This field holds the status, in which reservation is created. Possible status can be: OPTIONAL, QUOTATION, PROVISIONAL, REQUEST

Enum values:

PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL

... 7 other enums

locationIdinteger (int64)

The unique id represents the location in which the accommodationtype is located.

externalBookingReferencestring

It represents the tour operator's reservation reference number.

customerIdinteger (int64)

The unique id represents the the customer/guest who requested for the reservation.

customerBillarray

The bill of the customer for which the reservation is created.

Show child attributes

agentBillarray

The bill of agent or tour operator or any third party who made the reservation on behalf of the customer.

Show child attributes

reservedResourcesarray

The list of resources which are booked as part of the reservation.

Show child attributes

locationInfotextsarray

Represent any information that is related to the location.

Show child attributes

instalmentsarray

As per the payment terms configuration , installments are generated for the entire bill.

Show child attributes

statusinteger (int32)

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)

paymentTermSetIdinteger (int64)

408

Object

Reservation creation timed out

500

Object

Error occurred while creating reservation

curl --location 'https://api.maxxton.net/maxxton/v2/reservations?skipAvailabilityIndexCheck=false' \
--data '{
  "distributionChannelCode": "string",
  "categoryCode": "string",
  "accommodationTypes": [
    {
      "resourceId": 0,
      "unitId": 0,
      "arrivalDate": "2025-06-04",
      "duration": 0,
      "offerCode": "string",
      "useLoyaltyPoints": 0,
      "useLoyaltyFreeNights": 0,
      "additions": [
        {
          "additionResourceId": 0,
          "startDate": "2025-06-04",
          "endDate": "2025-06-04",
          "quantity": 0,
          "memo": "string"
        }
      ],
      "preferences": [
        {
          "id": 0,
          "type": "UNIT",
          "remark": "string"
        }
      ],
      "subjects": {
        "persons": [
          {
            "age": 0,
            "quantity": 0
          }
        ],
        "petsQuantity": 0
      },
      "travelParties": [
        {
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "birthDate": "2025-06-04",
          "gender": "MALE",
          "identityCardNumber": "string",
          "identityType": "PASSPORT",
          "identityNumber": "string"
        }
      ],
      "vehicles": [
        {
          "subjectId": 0,
          "vehicleRegistrationMark": "string",
          "remark": "string"
        }
      ],
      "removeImplies": [
        ""
      ],
      "voucherCode": "string"
    }
  ],
  "remark": "string",
  "externalBookingReference": "string",
  "employee": "string",
  "sendMethodCode": "string",
  "statusValue": "PROVISIONAL",
  "customerId": 0,
  "customer": {
    "firstName": "string",
    "lastName": "string",
    "middle": "string",
    "socialSecurityNumber": "string",
    "titleId": 0,
    "gender": "MALE",
    "language": "string",
    "mailAddress": {
      "zipCode": "string",
      "poBoxZipcode": "string",
      "houseNumberSuffix": "string",
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "poBoxCity": "string",
      "city": "string",
      "mobilePhone2": "string",
      "latitude": 0,
      "longitude": 0,
      "stateId": 0,
      "houseNumber": "string",
      "countryCode": "string",
      "poBox": "string",
      "mobilePhone": "string",
      "district": "string",
      "privatePhone": "string",
      "workPhone": "string",
      "email": "string"
    },
    "alternateName": "string",
    "emailAllowed": true,
    "birthDate": "2025-06-04",
    "mailAllowed": true,
    "companyName": "string",
    "identityType": "PASSPORT",
    "identityNumber": "string",
    "identityCountryId": 0,
    "identityDateIssued": "2025-06-04",
    "questionnaireUnsubscribed": true
  },
  "rateTypeId": 0,
  "paymentTermSetId": 0
}'

{
  "reservationId": 0,
  "reservationNumber": "string",
  "arrivalDate": "2025-06-04",
  "currencyCode": "string",
  "departureDate": "2025-06-04",
  "reservationDate": "2025-06-04T05:08:24.659Z",
  "statusValue": "PROVISIONAL",
  "locationId": 0,
  "externalBookingReference": "string",
  "customerId": 0,
  "customerBill": [
    {
      "resourceId": 0,
      "name": "string",
      "endDate": "2025-06-04",
      "startDate": "2025-06-04",
      "billLineType": 10,
      "total": 0,
      "vatRate": 0,
      "redeemedLoyaltyPoints": 0,
      "redeemedLoyaltyNights": 0,
      "reservedResourceId": 0
    }
  ],
  "agentBill": [
    {
      "resourceId": 0,
      "name": "string",
      "endDate": "2025-06-04",
      "startDate": "2025-06-04",
      "billLineType": 10,
      "total": 0,
      "vatRate": 0,
      "redeemedLoyaltyPoints": 0,
      "redeemedLoyaltyNights": 0,
      "reservedResourceId": 0
    }
  ],
  "reservedResources": [
    {
      "type": "ACCOMMODATIONTYPE",
      "resourceId": 0,
      "reservedResourceId": 0,
      "parentId": 0,
      "name": "string",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "price": 0,
      "quantity": 0,
      "shortDescription": "string",
      "description": "string",
      "unitId": 0,
      "hasPriceOverride": true,
      "removable": true,
      "infotexts": [
        {
          "description": "string",
          "code": "string",
          "categoryCode": "string"
        }
      ],
      "offerType": "GENERAL_SPECIAL",
      "code": "string",
      "addonType": "string",
      "imply": true
    }
  ],
  "locationInfotexts": [
    {
      "description": "string",
      "code": "string",
      "categoryCode": "string"
    }
  ],
  "instalments": [
    {
      "term": "string",
      "value": 0,
      "payerType": "string",
      "dueDate": "2025-06-04",
      "status": "string",
      "issueDate": "2025-06-04",
      "taxValue": 0,
      "due": 0,
      "autopay": true
    }
  ],
  "status": 0,
  "paymentTermSetId": 0
}

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. Reservation with multiple AccommodationType does not support VoucherCode, and in case codes are provided then an error is thrown.

Header Parameters

localestring

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

Query Parameters

returnAdditionsboolean

The applicable additions will be returned when the value is set to true

returnBillboolean

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

returnInstalmentsboolean

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

Default value

false

returnPaymentOptionsboolean

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

Default value

false

returnUnitsboolean

The list of available unit will be returned when the value is set to true.

skipAvailabilityIndexCheckboolean

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.

Default value

false

Body Parameters

distributionChannelCodestring Required

Unique code of distribution-channel.

categoryCodestring Required

Unique code of reservation-category.

customerIdinteger (int64)

accommodationTypesarray Required

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

Show child attributes

paymentTermSetIdinteger (int64)

rateTypeIdinteger (int64)

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

Response

200

Object

The request is completed successfully without any errors

Response Attributes

currencyCodestring

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

arrivalDatestring (date)

The date on which customer/guest will arrive.

departureDatestring (date)

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

customerBillarray

The bill of the customer for which the reservation is created.

Show child attributes

agentBillarray

The bill of agent or tour opertor or any third party who made the reservation on behalf of customer.

Show child attributes

instalmentsarray

As per the payment terms configuration , installments are generated for the entire bill.

Show child attributes

reservedResourcesarray

The list of resources, which are booked as part of the reservation.

Show child attributes

locationInfotextsarray

Represent the any information that is related to the accommodationtype.

Show child attributes

preBookingboolean

This field shows whether if it's a pre-booking or not

paymentOptionsarray

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.

Show child attributes

accommodationTypesarray

List of addition and unitIds per accommodation types

Show child attributes

500

Object

Error occurred while fetching reservation proposal

curl --location 'https://api.maxxton.net/maxxton/v2/reservations/proposals?returnInstalments=false&returnPaymentOptions=false&skipAvailabilityIndexCheck=false' \
--data '{
  "distributionChannelCode": "string",
  "categoryCode": "string",
  "customerId": 0,
  "accommodationTypes": [
    {
      "resourceId": 0,
      "unitId": 0,
      "arrivalDate": "2025-06-04",
      "duration": 0,
      "offerCode": "string",
      "additions": [
        {
          "additionResourceId": 0,
          "startDate": "string",
          "endDate": "string",
          "quantity": 0
        }
      ],
      "preferences": [
        {
          "id": 0,
          "type": "string",
          "remark": "string"
        }
      ],
      "subjects": {
        "persons": [
          {
            "age": 0,
            "quantity": 0
          }
        ],
        "petsQuantity": 0
      },
      "removeImplies": [
        ""
      ],
      "voucherCode": "string",
      "useLoyaltyPoints": 0,
      "useLoyaltyFreeNights": 0
    }
  ],
  "paymentTermSetId": 0,
  "rateTypeId": 0
}'

{
  "currencyCode": "string",
  "arrivalDate": "2025-06-04",
  "departureDate": "2025-06-04",
  "customerBill": [
    {
      "resourceId": 0,
      "reservedResourceProposalId": 0,
      "name": "string",
      "vatRate": 0,
      "billLineType": 10,
      "value": 0,
      "quantity": 0,
      "multiplier": 0,
      "total": 0,
      "redeemedLoyaltyPoints": 0,
      "redeemedLoyaltyNights": 0,
      "startDate": "2025-06-04",
      "endDate": "2025-06-04"
    }
  ],
  "agentBill": [
    {
      "resourceId": 0,
      "reservedResourceProposalId": 0,
      "name": "string",
      "vatRate": 0,
      "billLineType": 10,
      "value": 0,
      "quantity": 0,
      "multiplier": 0,
      "total": 0,
      "redeemedLoyaltyPoints": 0,
      "redeemedLoyaltyNights": 0,
      "startDate": "2025-06-04",
      "endDate": "2025-06-04"
    }
  ],
  "instalments": [
    {
      "term": "string",
      "value": 0,
      "payerType": "string",
      "dueDate": "2025-06-04",
      "status": "string",
      "issueDate": "2025-06-04",
      "taxValue": 0,
      "due": 0,
      "autopay": true
    }
  ],
  "reservedResources": [
    {
      "resourceId": 0,
      "reservedResourceProposalId": 0,
      "offerType": "GENERAL_SPECIAL",
      "code": "string",
      "type": "string",
      "infotexts": [
        {
          "name": "string",
          "display": "string",
          "description": "string",
          "code": "string",
          "categoryCode": "string"
        }
      ],
      "name": "string",
      "shortDescription": "string",
      "description": "string",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "price": 0,
      "quantity": 0,
      "unitId": 0,
      "hasPriceOverride": true,
      "removable": true,
      "imply": true,
      "impliesId": 0,
      "internetAdditionalCost": true,
      "addOnMetricDescription": "string",
      "addonType": "string"
    }
  ],
  "locationInfotexts": [
    {
      "name": "string",
      "display": "string",
      "description": "string",
      "code": "string",
      "categoryCode": "string"
    }
  ],
  "preBooking": true,
  "paymentOptions": [
    {
      "paymentTermSetId": 0,
      "name": "string",
      "description": "string",
      "priority": 0,
      "autoPay": true,
      "nonRefundable": true,
      "customerInstalments": [
        {
          "name": "string",
          "priority": 0,
          "dueDate": "2025-06-04",
          "dueAmount": 0
        }
      ],
      "agentInstalments": [
        {
          "name": "string",
          "priority": 0,
          "dueDate": "2025-06-04",
          "dueAmount": 0
        }
      ]
    }
  ],
  "accommodationTypes": [
    {
      "resourceId": 0,
      "additions": [
        {
          "additionResourceId": 0,
          "name": "string",
          "code": "string",
          "price": 0,
          "type": "string",
          "description": "string",
          "shortDescription": "string",
          "currency": "string",
          "maxQuantity": 0,
          "minQuantity": 0,
          "maxReservable": 0,
          "startDate": "2025-06-04",
          "endDate": "2025-06-04",
          "locationArticle": true,
          "addonType": "string",
          "stockType": "string",
          "dayAddon": true,
          "perSubject": true,
          "dayProductBookableDates": [
            ""
          ],
          "linkedWithSupplier": true
        }
      ],
      "unitIds": [
        ""
      ]
    }
  ]
}

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.

Query Parameters

accommodationtypecodestring

customerNamestring

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.

customeremailstring

distributionChannelCodestring

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.

reservationIdsarray

resourceIdinteger (int64)

unitIdinteger (int64)

The unitId for filtering the reservations

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
reservationId:0,
arrivalDate:2025-06-04,
customerId:0,
departureDate:2025-06-04,
distributionChannelId:0,
modifiedDate:2025-06-04T05:08:24.670Z,
reservationCategoryId:0,
reservationDate:2025-06-04T05:08:24.670Z,
reservationNumber:String,
locationId:0,
status:0,
supplierVoucher:String,
tncSigned:true,
tncSignedDate:2025-06-04,
tncSigneeCustomerName:String,
type:String,...

Response

200

Object

The request is completed successfully without any errors

Response Attributes

totalElementsinteger (int64)

Total number of elements available in the whole response.

totalPagesinteger (int32)

Total number of pages the response has.

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

sizeinteger (int32)

Size of the current page.

contentarray

Show child attributes

numberinteger (int32)

Page number currently accessed.

sortarray

Show child attributes

numberOfElementsinteger (int32)

Total number of elements in the current page.

emptyboolean

204

Object

No reservations found for given criteria.

500

Object

Error occurred while fetching these reservations

curl --location 'https://api.maxxton.net/maxxton/v2/reservations'

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "reservationId": 0,
      "categoryName": "string",
      "categoryCode": "string",
      "arrivalDate": "2025-06-04",
      "customerId": 0,
      "departureDate": "2025-06-04",
      "distributionChannelId": 0,
      "modifiedDate": "2025-06-04T05:08:24.658Z",
      "reservationCategoryId": 0,
      "reservationDate": "2025-06-04T05:08:24.658Z",
      "reservationNumber": "string",
      "locationId": 0,
      "status": 0,
      "supplierVoucher": "string",
      "tncSigned": true,
      "tncSignedDate": "2025-06-04",
      "tncSigneeCustomerName": "string",
      "type": "string",
      "expectedArrivalDateTime": "2025-06-04T05:08:24.658Z",
      "expectedDepartureDateTime": "2025-06-04T05:08:24.658Z",
      "validationStatus": -101,
      "voucher": "string",
      "parentId": 0,
      "cancelDate": "2025-06-04",
      "originId": "string",
      "origin": "string",
      "expireDate": "2025-06-04T05:08:24.658Z",
      "printedDate": "2025-06-04",
      "resellerId": 0,
      "statusValue": "PROVISIONAL",
      "sendMethodId": 0,
      "paymentTermSetId": 0,
      "reservationKind": "ACCOMMODATION_RESERVATION",
      "payingCustomerId": 0,
      "externalBookingReference": "string"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Get a single Reservation by reservation id. You can use other calls, like /content or /customers to gather more detailed information.

Path Parameters

reservationIdinteger (int64)Required

The identifier of the reservation.

Response

200

Object

The request is completed successfully without any errors

Response Attributes

reservationIdinteger (int64)

categoryNamestring

categoryCodestring

arrivalDatestring (date)

customerIdinteger (int64)

departureDatestring (date)

distributionChannelIdinteger (int64)

modifiedDatestring (date-time)

reservationCategoryIdinteger (int64)

reservationDatestring (date-time)

reservationNumberstring

locationIdinteger (int64)

statusinteger (int32)

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)

supplierVoucherstring

If a location is linked to a supplier system, then creating a booking on this location will also create a reservation in supplier system and the supplier booking reference number will be available in this field.

tncSignedboolean

tncSignedDatestring (date)

tncSigneeCustomerNamestring

typestring

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.

expectedArrivalDateTimestring (date-time)

expectedDepartureDateTimestring (date-time)

validationStatusinteger (int64)

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)

voucherstring

It's an external booking reference number of the system, from where the reservation was made.

parentIdinteger (int64)

cancelDatestring (date)

originIdstring

originstring

expireDatestring (date-time)

printedDatestring (date)

resellerIdinteger (int64)

statusValuestring

Enum values:

PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL

... 7 other enums

sendMethodIdinteger (int64)

paymentTermSetIdinteger (int64)

reservationKindstring

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

Enum values:

ACCOMMODATION_RESERVATIONADDON_RESERVATIONGROUP_RESERVATION

payingCustomerIdinteger (int64)

externalBookingReferencestring

404

Object

No reservation found for given reservation id.

500

Object

Error occurred while fetching this reservation

curl --location --globoff 'https://api.maxxton.net/maxxton/v2/reservations/{reservationId}'

{
  "reservationId": 0,
  "categoryName": "string",
  "categoryCode": "string",
  "arrivalDate": "2025-06-04",
  "customerId": 0,
  "departureDate": "2025-06-04",
  "distributionChannelId": 0,
  "modifiedDate": "2025-06-04T05:08:24.658Z",
  "reservationCategoryId": 0,
  "reservationDate": "2025-06-04T05:08:24.658Z",
  "reservationNumber": "string",
  "locationId": 0,
  "status": 0,
  "supplierVoucher": "string",
  "tncSigned": true,
  "tncSignedDate": "2025-06-04",
  "tncSigneeCustomerName": "string",
  "type": "string",
  "expectedArrivalDateTime": "2025-06-04T05:08:24.658Z",
  "expectedDepartureDateTime": "2025-06-04T05:08:24.658Z",
  "validationStatus": -101,
  "voucher": "string",
  "parentId": 0,
  "cancelDate": "2025-06-04",
  "originId": "string",
  "origin": "string",
  "expireDate": "2025-06-04T05:08:24.658Z",
  "printedDate": "2025-06-04",
  "resellerId": 0,
  "statusValue": "PROVISIONAL",
  "sendMethodId": 0,
  "paymentTermSetId": 0,
  "reservationKind": "ACCOMMODATION_RESERVATION",
  "payingCustomerId": 0,
  "externalBookingReference": "string"
}

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 location, by maintenance department and housekeeping.

Path Parameters

reservationIdinteger (int64)Required

Id of the reservation which needs to be updated.

Body Parameters

statusValuestring

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 values:

CANCELDECLINEQUOTATIONINITIALPRE_BOOKINGREQUESTOPTIONALPROVISIONALDEFINITIVECHECKED_IN

... 2 other enums

reservedResourcesarray

The list of reserved resources customer expects to change

Show child attributes

cancellationReasonstring

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.

Max length

4000

paymentTermSetIdinteger (int64)

Response

200

Object

The request is completed successfully without any errors

Response Attributes

reservationIdinteger (int64)

Unique id associated with reservation.

statusValuestring

The reservation status after update process. Possible status values can be: DELETED, CANCELLED, DECLINED, PROVISIONAL, DEFINITIVE

Enum values:

PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL

... 7 other enums

reservedResourcesarray

The list of reserved resources customer expects to change

Show child attributes

paymentTermSetIdinteger (int64)

Id of the payment term set selected for the reservation.

infotextsarray

Show child attributes

500

Object

Error occurred while updating reservation

curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/reservations/{reservationId}' \
--data '{
  "statusValue": "CANCEL",
  "reservedResources": [
    {
      "reservedResourceId": 0,
      "expectedArrivalDateTime": "2025-06-04T05:08:24.661Z",
      "expectedDepartureDateTime": "2025-06-04T05:08:24.661Z"
    }
  ],
  "cancellationReason": "string",
  "paymentTermSetId": 0
}'

{
  "reservationId": 0,
  "statusValue": "PROVISIONAL",
  "reservedResources": [
    {
      "reservedResourceId": 0,
      "expectedArrivalDateTime": "2025-06-04T05:08:24.661Z",
      "expectedDepartureDateTime": "2025-06-04T05:08:24.661Z"
    }
  ],
  "paymentTermSetId": 0,
  "infotexts": [
    {
      "description": "string",
      "code": "string",
      "categoryCode": "string"
    }
  ]
}

Endpoints

GET

Endpoints

GET

Endpoints

GET

Endpoints

GET

Endpoints

GET

Endpoints

GET

Endpoints

GET

Endpoints

POST

A piece of informative text visible to the customer.

Endpoints

GET

Endpoints

GET

Endpoints

GET

A remark or informative text added to an entity.

Endpoints

POST

GET

Endpoints

GET

Endpoints

GET

Endpoints

POST

GET

Endpoints

GET

Endpoints

GET

Endpoints

POST

Endpoints

GET

Get the page of reservation reminders.

Query Parameters

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
dueAmount:0.0,
status:String,
sendDate:2025-06-04T05:08:24.671Z,
paymentDate:2025-06-04T05:08:24.671Z,
printDate:2025-06-04T05:08:24.671Z,
reservationId:0For more information, check: Filtering

Response

200

Object

The request is completed successfully without any errors

Response Attributes

totalElementsinteger (int64)

Total number of elements available in the whole response.

totalPagesinteger (int32)

Total number of pages the response has.

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

sizeinteger (int32)

Size of the current page.

contentarray

Show child attributes

numberinteger (int32)

Page number currently accessed.

sortarray

Show child attributes

numberOfElementsinteger (int32)

Total number of elements in the current page.

emptyboolean

500

Object

Error occurred while fetching reservation reminders

curl --location 'https://api.maxxton.net/maxxton/v2/reservations/reminders'

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "dueAmount": 0,
      "status": "OPEN",
      "sendDate": "2025-06-04T05:08:24.659Z",
      "paymentDate": "2025-06-04T05:08:24.659Z",
      "printDate": "2025-06-04T05:08:24.659Z",
      "reservationId": 0,
      "paymentTermSetId": 0
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Endpoints

POST

GET

POST

GET

DELETE

PUT

Endpoints

GET

A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.

Endpoints

DELETE

GET

PUT

POST

Endpoints

GET

The classification of rooms based on their characteristics, such as bedroom, bathroom, or living area.

Endpoints

GET

A distinct space within a unit provided for guests to stay.

Endpoints

GET

Defines how to communicate with the customer.

Endpoints

GET

A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.

Endpoints

GET

An integration with Maxxton to make it possible to to book external inventory from the Maxxton system

Sections

Maxxton External API

Language Box

cURL

Ruby

Python

PHP

Java

Node.js

Go

.NET

Accommodation Types

Endpoints

POST

GET

GET

PUT

GET

GET

GET

GET

GET

GET

GET

GET

GET

GET

POST

GET

POST

GET

GET

GET

GET

PUT

GET

GET

GET

GET

GET

GET

GET

GET

GET

POST

GET

GET

POST

POST

GET

GET

POST

POST

GET

AddOn

Endpoints

GET

GET

GET

GET

GET

PUT

GET

GET

GET

Admin Organisation

Endpoints

POST

GET

PUT

GET

GET

GET

PUT

GET

GET

GET

PUT

GET

GET