Maxxton External API
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.
Base URL
Production:
https://api.maxxton.net
Accommodation Types
A collection of similar units grouped together.
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
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
GET
GET
GET
GET
PUT
GET
GET
GET
Admin Organisation
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
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
PUT
Allotment
The allocation of a certain number of accommodation types or units for a specific period or purpose per distribution channel.
Endpoints
GET
GET
Amenity
A feature or service provided to enhance the guest experience, such as a pool, gym, or Wi-Fi.
Endpoints
POST
GET
GET
GET
Authentication
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
Brands
A distinctive name associated with a specific product or service.
Endpoints
GET
GET
Cash Clearance
The process of reconciling and recording cash transactions to ensure accurate financial records.
Endpoints
GET
GET
GET
GET
GET
GET
Contracts
A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.
Endpoints
POST
DELETE
GET
GET
PUT
GET
GET
Countries
All available countries, the countries are configured in Maxxton.
Endpoints
GET
GET
Currency
The type of money used in financial transactions, such as USD or EUR.
Endpoints
GET
GET
Customer Status
A certain label that is given to a customer. This can be assigned automatically or manually.
Endpoints
GET
GET
Customers
An individual or entity that purchases or uses accommodations or services.
Endpoints
POST
GET
GET
GET
PUT
GET
PUT
GET
PUT
GET
GET
POST
GET
GET
POST
GET
GET
Create a customer
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
Body Parameters
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.
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.
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.
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.
Show child attributes
This field indicates if the customer has given us permission to contact them via phone call.
This field indicates if we can send text messages to the customer.
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.
Gender of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
MALEFEMALEUNSPECIFIEDIbanNumber of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
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.
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.
Login id for the customer. Login field should be same as the email field in the customer address entity.
Type of identity document provided by the customer.
PASSPORTIDENTITY_CARDDRIVERS_LICENCEUnique identification number as printed on the customer's identity document.
Id of the country that issued the identity document..
Date the identity document was issued.
Response
Response Attributes
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.
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.
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.
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.
Show child attributes
This field indicates if the customer has given us permission to contact them via phone call.
This field indicates if we can send text messages to the customer.
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.
Gender of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
MALEFEMALEUNSPECIFIEDIbanNumber of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
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.
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.
Login id for the customer. Login field should be same as the email field in the customer address entity.
Type of identity document provided by the customer.
PASSPORTIDENTITY_CARDDRIVERS_LICENCEUnique identification number as printed on the customer's identity document.
Id of the country that issued the identity document..
Date the identity document was issued.
Response
{
"customerId": 0,
"customerGroupId": 0,
"titleId": 0,
"firstName": "string",
"middle": "string",
"lastName": "string",
"alternateName": "string",
"mailAddress": {
"addressId": 0,
"address1": "string",
"address2": "string",
"address3": "string",
"boxNumber": "string",
"houseNumberSuffix": "string",
"zipCode": "string",
"poBox": "string",
"poBoxZipcode": "string",
"poBoxCity": "string",
"city": "string",
"countryId": 0,
"municipality": "string",
"mobilePhone2": "string",
"latitude": 0,
"longitude": 0,
"email": "string",
"stateId": 0,
"mobilePhone": "string",
"houseNumber": "string",
"district": "string",
"privatePhone": "string",
"workPhone": "string",
"exposeLocation": true,
"dateEnd": "2025-06-19",
"dateBegin": "2025-06-19",
"fax": "string",
"alternateContactPerson": "string",
"accuracy": "ROOFTOP",
"country": {
"countryId": 0,
"priority": 0,
"translations": [
{
"name": "string",
"language": "string"
}
],
"default": true,
"code": "string"
}
},
"emailAllowed": true,
"mailAllowed": true,
"phoneCallAllowed": true,
"textMsgAllowed": true,
"signatureDate": "2025-06-19",
"socialSecurityNumber": "string",
"gender": "MALE",
"languageId": 0,
"language": "string",
"ibanNumber": "string",
"bicSwift": "string",
"birthDate": "2025-06-19",
"companyName": "string",
"login": "string",
"previousPmsId": 0,
"creationDate": "2025-06-19T16:20:29.471Z",
"identityType": "PASSPORT",
"identityNumber": "string",
"identityCountryId": 0,
"identityDateIssued": "2025-06-19",
"questionnaireUnsubscribed": true
}Get all customers
Get a page with customers. The records can be filtered based on customer object.It also supports pageable.
Query Parameters
Filter customer's on email id
Page number
Size of the current page
Sort parameter
Following fields can be used for filtering response.
customerGroupId:0,
titleId:0,
firstName:String,
middle:String,
lastName:String,
alternateName:String,
emailAllowed:true,
mailAllowed:true,
phoneCallAllowed:true,
textMsgAllowed:true,
signatureDate:2025-06-19,
socialSecurityNumber:String,
gender:String,
languageId:0,
ibanNumber:String,
bicSwift:String,
birthDate:2025-06-19,
companyName:String,
login:String,...
Response
Response Attributes
Total number of elements available in the whole response.
Total number of pages the response has.
Boolean field to specify if its the first page or not.
Boolean field to specify if its the last page or not.
Size of the current page.
Show child attributes
Page number currently accessed.
Show child attributes
Total number of elements in the current page.
Response
{
"totalElements": 0,
"totalPages": 0,
"first": true,
"last": true,
"size": 0,
"content": [
{
"customerId": 0,
"customerGroupId": 0,
"titleId": 0,
"firstName": "string",
"middle": "string",
"lastName": "string",
"alternateName": "string",
"mailAddress": {
"addressId": 0,
"address1": "string",
"address2": "string",
"address3": "string",
"boxNumber": "string",
"houseNumberSuffix": "string",
"zipCode": "string",
"poBox": "string",
"poBoxZipcode": "string",
"poBoxCity": "string",
"city": "string",
"countryId": 0,
"municipality": "string",
"mobilePhone2": "string",
"latitude": 0,
"longitude": 0,
"email": "string",
"stateId": 0,
"mobilePhone": "string",
"houseNumber": "string",
"district": "string",
"privatePhone": "string",
"workPhone": "string",
"exposeLocation": true,
"dateEnd": "2025-06-19",
"dateBegin": "2025-06-19",
"fax": "string",
"alternateContactPerson": "string",
"accuracy": "ROOFTOP",
"country": {
"countryId": 0,
"priority": 0,
"translations": [
{
"name": "string",
"language": "string"
}
],
"default": true,
"code": "string"
}
},
"emailAllowed": true,
"mailAllowed": true,
"phoneCallAllowed": true,
"textMsgAllowed": true,
"signatureDate": "2025-06-19",
"socialSecurityNumber": "string",
"gender": "MALE",
"languageId": 0,
"language": "string",
"ibanNumber": "string",
"bicSwift": "string",
"birthDate": "2025-06-19",
"companyName": "string",
"login": "string",
"previousPmsId": 0,
"creationDate": "2025-06-19T16:20:29.470Z",
"identityType": "PASSPORT",
"identityNumber": "string",
"identityCountryId": 0,
"identityDateIssued": "2025-06-19",
"questionnaireUnsubscribed": true
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"numberOfElements": 0,
"empty": true
}Get all titles
Get list of all customer titles, records can be filtered based on fields of customer title object.
Query Parameters
Following fields can be used for filtering response.
titleId:0,
code:String,
priority:0For more information, check: Filtering
Response
Response Attributes
Unique id associated with each title linked to the customer
Unique code associated with each customer title
Sequence in which the title will be displayed to the user.
Information of the customer title which depends on a language and is translatable by the user. Multiple entries for different languages can exist.
Show child attributes
Response
{
"titleId": 0,
"code": "string",
"priority": 0,
"translations": [
{
"title": "string",
"language": "string"
}
]
}Get customer
Get the details of the customer specified to a particular id passed in the endpoint.
Path Parameters
An Id of customer to be fetched
Response
Response Attributes
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.
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.
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.
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.
details of the visit address of the user
Show child attributes
This field indicates if the customer has given us permission to contact them via phone call.
This field indicates if we can send text messages to the customer.
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.
Gender of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
MALEFEMALEUNSPECIFIEDIbanNumber of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
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.
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.
Login id for the customer. Login field should be same as the email field in the customer address entity.
Type of identity document provided by the customer.
PASSPORTIDENTITY_CARDDRIVERS_LICENCEUnique identification number as printed on the customer's identity document.
Id of the country that issued the identity document..
Date the identity document was issued.
Response
{
"customerId": 0,
"customerGroupId": 0,
"titleId": 0,
"firstName": "string",
"middle": "string",
"lastName": "string",
"alternateName": "string",
"mailAddress": {
"addressId": 0,
"address1": "string",
"address2": "string",
"address3": "string",
"boxNumber": "string",
"houseNumberSuffix": "string",
"zipCode": "string",
"poBox": "string",
"poBoxZipcode": "string",
"poBoxCity": "string",
"city": "string",
"countryId": 0,
"municipality": "string",
"mobilePhone2": "string",
"latitude": 0,
"longitude": 0,
"email": "string",
"stateId": 0,
"mobilePhone": "string",
"houseNumber": "string",
"district": "string",
"privatePhone": "string",
"workPhone": "string",
"exposeLocation": true,
"dateEnd": "2025-06-19",
"dateBegin": "2025-06-19",
"fax": "string",
"alternateContactPerson": "string",
"accuracy": "ROOFTOP",
"country": {
"countryId": 0,
"priority": 0,
"translations": [
{
"name": "string",
"language": "string"
}
],
"default": true,
"code": "string"
}
},
"emailAllowed": true,
"mailAllowed": true,
"phoneCallAllowed": true,
"textMsgAllowed": true,
"signatureDate": "2025-06-19",
"socialSecurityNumber": "string",
"gender": "MALE",
"languageId": 0,
"language": "string",
"ibanNumber": "string",
"bicSwift": "string",
"birthDate": "2025-06-19",
"companyName": "string",
"login": "string",
"previousPmsId": 0,
"creationDate": "2025-06-19T16:20:29.470Z",
"identityType": "PASSPORT",
"identityNumber": "string",
"identityCountryId": 0,
"identityDateIssued": "2025-06-19",
"questionnaireUnsubscribed": true
}Update a customer
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.
Path Parameters
Customer id to fetch files associated with the customer
Body Parameters
Show child attributes
PASSPORTIDENTITY_CARDDRIVERS_LICENCEResponse
Response Attributes
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.
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.
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.
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.
details of the visit address of the user
Show child attributes
This field indicates if the customer has given us permission to contact them via phone call.
This field indicates if we can send text messages to the customer.
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.
Gender of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
MALEFEMALEUNSPECIFIEDIbanNumber of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.
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.
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.
Login id for the customer. Login field should be same as the email field in the customer address entity.
Type of identity document provided by the customer.
PASSPORTIDENTITY_CARDDRIVERS_LICENCEUnique identification number as printed on the customer's identity document.
Id of the country that issued the identity document..
Date the identity document was issued.
Response
{
"customerId": 0,
"customerGroupId": 0,
"titleId": 0,
"firstName": "string",
"middle": "string",
"lastName": "string",
"alternateName": "string",
"mailAddress": {
"addressId": 0,
"address1": "string",
"address2": "string",
"address3": "string",
"boxNumber": "string",
"houseNumberSuffix": "string",
"zipCode": "string",
"poBox": "string",
"poBoxZipcode": "string",
"poBoxCity": "string",
"city": "string",
"countryId": 0,
"municipality": "string",
"mobilePhone2": "string",
"latitude": 0,
"longitude": 0,
"email": "string",
"stateId": 0,
"mobilePhone": "string",
"houseNumber": "string",
"district": "string",
"privatePhone": "string",
"workPhone": "string",
"exposeLocation": true,
"dateEnd": "2025-06-19",
"dateBegin": "2025-06-19",
"fax": "string",
"alternateContactPerson": "string",
"accuracy": "ROOFTOP",
"country": {
"countryId": 0,
"priority": 0,
"translations": [
{
"name": "string",
"language": "string"
}
],
"default": true,
"code": "string"
}
},
"emailAllowed": true,
"mailAllowed": true,
"phoneCallAllowed": true,
"textMsgAllowed": true,
"signatureDate": "2025-06-19",
"socialSecurityNumber": "string",
"gender": "MALE",
"languageId": 0,
"language": "string",
"ibanNumber": "string",
"bicSwift": "string",
"birthDate": "2025-06-19",
"companyName": "string",
"login": "string",
"previousPmsId": 0,
"creationDate": "2025-06-19T16:20:29.470Z",
"identityType": "PASSPORT",
"identityNumber": "string",
"identityCountryId": 0,
"identityDateIssued": "2025-06-19",
"questionnaireUnsubscribed": true
}Communications
Endpoints
GET
Credentials
Endpoints
PUT
Customerstatus
A certain label that is given to a customer. This can be assigned automatically or manually.
Endpoints
GET
PUT
Files
Endpoints
GET
GET
Login
Endpoints
POST
Loyalty
Endpoints
GET
GET
Memos
A remark or informative text added to an entity.
Endpoints
POST
GET
Phonecalls
Endpoints
GET
Get all phonecalls for a customer
Get a page with customerPhonecalls. The records can be filtered based on customerPhoneCall object.It also supports pageable.
Query Parameters
Customer phone calls will be returned based on the employeeGroupId
Page number
Size of the current page
Sort parameter
Following fields can be used for filtering response.
customerPhoneCallId:0,
type:String,
customerId:0,
employeeId:0,
startTime:2025-06-19T16:20:29.483Z,
endTime:2025-06-19T16:20:29.483Z,
phoneNumber:String,
memoCategoryId:0,
note:String,
locationId:0For more information, check: Filtering
Response
Response Attributes
Total number of elements available in the whole response.
Total number of pages the response has.
Boolean field to specify if its the first page or not.
Boolean field to specify if its the last page or not.
Size of the current page.
Show child attributes
Page number currently accessed.
Show child attributes
Total number of elements in the current page.
Response
{
"totalElements": 0,
"totalPages": 0,
"first": true,
"last": true,
"size": 0,
"content": [
{
"customerPhoneCallId": 0,
"type": "INCOMING",
"customerId": 0,
"employeeId": 0,
"startTime": "2025-06-19T16:20:29.471Z",
"endTime": "2025-06-19T16:20:29.471Z",
"phoneNumber": "string",
"memoCategoryId": 0,
"note": "string",
"locationId": 0
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"numberOfElements": 0,
"empty": true
}DistributionChannels
The sales channel through which products or services are delivered to customers.
Endpoints
GET
GET
GET
GET
GET
GET
GET
Employee
An individual working for an organization, responsible for various tasks or roles.
Endpoints
POST
GET
PUT
Events
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
Facilities
A physical location or infrastructure used to support operations or services.
Endpoints
GET
GET
Groups
Grouping of certain entities such as marketing groups, location groups in Maxxton.
Endpoints
GET
GET
Housekeeping
A specific job or duty that needs to be done on an accommodation on a specified date and time.
Endpoints
GET
GET
Icals
Ical calendar file to show reservations made for a certain unit. Mostly used for owners to show the usage of their unit.
Endpoints
GET
Infotexts
A piece of informative text visible to the customer.
Endpoints
POST
GET
Languages
The choice of language for user interfaces, or communication within the system.
Endpoints
GET
Ledgers
A comprehensive record of all financial transactions, including accounts and balances.
Endpoints
GET
GET
GET
GET
Locations
A physical place or address where accommodations or services are provided like a location.
Endpoints
POST
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
POST
POST
GET
Locks
A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.
Endpoints
GET
Memos
A remark or informative text added to an entity.
Endpoints
GET
Offer
A discount or additional product/service that can be added to a reservation.
Endpoints
POST
GET
GET
PUT
POST
GET
GET
PUT
POST
DELETE
GET
GET
GET
POST
GET
POST
POST
GET
Operations
Technical services which handles tasks to fix issues or maintenance in units.
Endpoints
GET
GET
GET
Owners
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
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
POST
GET
GET
GET
POST
GET
GET
GET
GET
GET
PUT
Packages
Multiple add-ons which can be booked together.
Endpoints
GET
GET
Payment Term Set
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
Points Of Interests
Certain interesting features around the location such as cities, airports, theme parks.
Endpoints
GET
GET
Predefined Memo
A brief written message or note used for communication or record-keeping within the software.
Endpoints
GET
Rate Types
The category or classification of rates based on their application and currency such as BAR rate or tour operator rate.
Endpoints
GET
GET
GET
Region
A geographical area or division used for organizing and managing locations or data.
Endpoints
GET
GET
Rentability
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
GET
GET
Representation
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
GET
PUT
POST
DELETE
GET
Resellers
An individual or entity that sells products or services on behalf of another company.
Endpoints
GET
GET
GET
Reservability
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
GET
GET
GET
GET
Reservations
An arrangement to secure an accommodation or service for a specific time and date.
Endpoints
POST
POST
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
GET
GET
POST
GET
GET
GET
GET
POST
GET
GET
GET
GET
GET
POST
POST
POST
GET
POST
GET
POST
GET
DELETE
PUT
GET
GET
DELETE
GET
GET
PUT
POST
GET
Room Types
The classification of rooms based on their characteristics, such as bedroom, bathroom, or living area.
Endpoints
GET
Rooms
A distinct space within a unit provided for guests to stay.
Endpoints
GET
GET
Send Methods
Defines how to communicate with the customer.
Endpoints
GET
Subjects
A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.
Endpoints
GET
Suppliers
An integration with Maxxton to make it possible to to book external inventory from the Maxxton system
Endpoints
GET
Units
A place where guests stay, such as a hotel room, apartment, or vacation rental.