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.
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
Admin Organisation
A main level to funnel the companies, locations, employees, accounts and other properties that exclusively belongs to that Admin organisation.
Allotment
The allocation of a certain number of accommodation types or units for a specific period or purpose per distribution channel.
Amenity
A feature or service provided to enhance the guest experience, such as a pool, gym, or Wi-Fi.
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.
Brands
A distinctive name associated with a specific product or service.
Cash Clearance
The process of reconciling and recording cash transactions to ensure accurate financial records.
Contracts
A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.
Countries
All available countries, the countries are configured in Maxxton.
Currency
The type of money used in financial transactions, such as USD or EUR.
Customer Status
A certain label that is given to a customer. This can be assigned automatically or manually.
Customers
An individual or entity that purchases or uses accommodations or services.
DistributionChannels
The sales channel through which products or services are delivered to customers.
Employee
An individual working for an organization, responsible for various tasks or roles.
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.
Facilities
A physical location or infrastructure used to support operations or services.
Groups
Grouping of certain entities such as marketing groups, location groups in Maxxton.
Housekeeping
A specific job or duty that needs to be done on an accommodation on a specified date and time.
Icals
Ical calendar file to show reservations made for a certain unit. Mostly used for owners to show the usage of their unit.
Infotexts
A piece of informative text visible to the customer.
Languages
The choice of language for user interfaces, or communication within the system.
Ledgers
A comprehensive record of all financial transactions, including accounts and balances.
Locations
A physical place or address where accommodations or services are provided like a location.
Locks
A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.
Memos
A remark or informative text added to an entity.
Offer
A discount or additional product/service that can be added to a reservation.
Operations
Technical services which handles tasks to fix issues or maintenance in units.
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.
Packages
Multiple add-ons which can be booked together.
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.
Points Of Interests
Certain interesting features around the location such as cities, airports, theme parks.
Get all point of interests
All configured PointsOfInterest. The records can be filtered based on PointsOfInterest object.It also supports pageable.
Query Parameters
Page number
Size of the current page
Sort parameter
Following fields can be used for filtering response.
pointsOfInterestId:0,
code:String,
startDate:2025-05-21,
endDate:2025-05-21,
visibleFrom:2025-05-21,
visibleTo:2025-05-21,
pointsOfInterestCategoryId:0,
url:String,
priority:0,
price:String,
priceChildren:String,
priceAdult:String,
priceValuePoint:StringFor 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": [
{
"pointsOfInterestId": 0,
"code": "string",
"startDate": "2025-05-21",
"endDate": "2025-05-21",
"visibleFrom": "2025-05-21",
"visibleTo": "2025-05-21",
"pointsOfInterestCategoryId": 0,
"url": "string",
"locationIds": [
""
],
"priority": 0,
"price": "string",
"startTime": {
"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"endTime": {
"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"priceChildren": "string",
"priceAdult": "string",
"priceValuePoint": "string",
"translations": [
{
"language": "string",
"name": "string",
"headText": "string",
"text": "string",
"description": "string",
"description2": "string"
}
]
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"numberOfElements": 0,
"empty": true
}Categories
Get all categories for points of interests
All configured PointOfInterestsCategories. The records can be filtered based on PointsOfInterestCategory object.It also supports pageable.
Query Parameters
Page number
Size of the current page
Sort parameter
Following fields can be used for filtering response.
pointsOfInterestCategoryId:0,
code:StringFor 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": [
{
"pointsOfInterestCategoryId": 0,
"code": "string",
"translations": [
{
"language": "string",
"name": "string",
"description": "string",
"shortDescription": "string"
}
]
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"numberOfElements": 0,
"empty": true
}Predefined Memo
A brief written message or note used for communication or record-keeping within the software.
Rate Types
The category or classification of rates based on their application and currency such as BAR rate or tour operator rate.
Region
A geographical area or division used for organizing and managing locations or data.
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.
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.
Resellers
An individual or entity that sells products or services on behalf of another company.
Reservability
Actual count of available units per period or date without considering if it's allowed to arrive or depart on the certain date.
Reservations
An arrangement to secure an accommodation or service for a specific time and date.
Room Types
The classification of rooms based on their characteristics, such as bedroom, bathroom, or living area.
Rooms
A distinct space within a unit provided for guests to stay.
Send Methods
Defines how to communicate with the customer.
Subjects
A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.
Suppliers
An integration with Maxxton to make it possible to to book external inventory from the Maxxton system
Units
A place where guests stay, such as a hotel room, apartment, or vacation rental.