Get all additions for a add on

Sections

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

Language Box

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

Get add-on

Get add-ons by resource id.

Path Parameters

resourceIdinteger (int64)Required

Response

200
Object
The request is completed successfully without any errors

Response Attributes

resourceIdinteger (int64)
codestring
locationIdinteger (int64)
parentIdinteger (int64)
pathstring
cashflowManagerIdinteger (int64)
allowPriceOverrideboolean
addonTypestring
translationsarray

Show child attributes

sourcestring
showNilPriceOnBillboolean
powerplaygroupIdinteger (int64)
allowMovingToMainBillboolean
archivedFromstring (date)
searchCodestring
excludePriceCacheboolean
specialPriorityinteger (int32)
typestring
Enum values:
ACCOMMODATIONTYPERESOURCEACTIVITYACTIVITYPRODUCTTYPEEXTRASPECIALCOMPOSITION
locationArticleboolean

If true, the add-on should be paid upon arrival at the location. The price is not included in the total price of the bill but listed separately.

stayArticleboolean
reservationArticleboolean
cashArticleboolean
ownerArticleboolean
invoiceArticleboolean
perDayboolean
customizableboolean
stockTypestring
dayAddonboolean
withholdingArticleboolean
warrantboolean
correctionboolean
commissionboolean
vatCommissionboolean
cancelPremiumboolean
cancelCompensationboolean
adjustmentboolean
repaymentVoucherboolean
earlyCheckinboolean
showDatesOnInternetboolean
allowToAddInCiCoboolean
taxboolean
maxQuantityinteger (int64)
commissionVatIncludedboolean
implicationManagerIdinteger (int64)
ledgerIdinteger (int64)
ledgerGroupIdinteger (int64)
dependsOnLedgerGroupboolean
dependencyMaskstring

Defines the day(s) on which the add-on will be applicable or not, based on the value of the applyDependencyMask field.

Possible values:

  • NONE: No specific day is selected.
  • ARRIVAL: Refers to the arrival day of the reservation.
  • DEPARTURE: Refers to the departure day of the reservation.
  • ARRIVAL_DEPARTURE: Refers to both arrival and departure days.
Enum values:
NONEARRIVALDEPARTUREARRIVAL_DEPARTURE
applyDependencyMaskboolean

Determines whether the add-on should be included or excluded on the day(s) specified in dependencyMask.

  • true: Apply the add-on on the specified dependency day(s).
  • false: Do not apply the add-on on the specified dependency day(s). This acts as a toggle between 'Apply' and 'Don't Apply' behavior.

Example:

Reservation dates: Arrival = 07/09, Departure = 10/09

Add-on: X

Case 1:

depende...

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

GET

/maxxton/v2/add-ons/{resourceId}

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/add-ons/{resourceId}'

Response

{
  "resourceId": 0,
  "code": "string",
  "locationId": 0,
  "parentId": 0,
  "path": "string",
  "cashflowManagerId": 0,
  "allowPriceOverride": true,
  "addonType": "string",
  "translations": [
    {
      "language": "string",
      "name": "string",
      "shortDescription": "string",
      "description": "string",
      "description2": "string",
      "namePath": "string"
    }
  ],
  "source": "string",
  "showNilPriceOnBill": true,
  "powerplaygroupId": 0,
  "allowMovingToMainBill": true,
  "archivedFrom": "2025-06-04",
  "searchCode": "string",
  "excludePriceCache": true,
  "specialPriority": 0,
  "type": "ACCOMMODATIONTYPE",
  "locationArticle": true,
  "stayArticle": true,
  "reservationArticle": true,
  "cashArticle": true,
  "ownerArticle": true,
  "invoiceArticle": true,
  "perDay": true,
  "customizable": true,
  "stockType": "string",
  "dayAddon": true,
  "withholdingArticle": true,
  "warrant": true,
  "correction": true,
  "commission": true,
  "vatCommission": true,
  "cancelPremium": true,
  "cancelCompensation": true,
  "adjustment": true,
  "repaymentVoucher": true,
  "earlyCheckin": true,
  "showDatesOnInternet": true,
  "allowToAddInCiCo": true,
  "tax": true,
  "maxQuantity": 0,
  "commissionVatIncluded": true,
  "implicationManagerId": 0,
  "ledgerId": 0,
  "ledgerGroupId": 0,
  "dependsOnLedgerGroup": true,
  "dependencyMask": "NONE",
  "applyDependencyMask": true,
  "autoValidate": true
}

Get all add-ons

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

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.
resourceId:0,
code:String,
locationId:0,
parentId:0,
path:String,
cashflowManagerId:0,
allowPriceOverride:true,
source:String,
showNilPriceOnBill:true,
powerplaygroupId:0,
allowMovingToMainBill:true,
archivedFrom:2025-06-04,
specialPriority:0,
type:String,
locationArticle:true,
customizable:true,
showDatesOnInternet:true,
allowToAddInCiCo:true,
implication...

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 add-ons.

GET

/maxxton/v2/add-ons?page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/add-ons'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "resourceId": 0,
      "code": "string",
      "locationId": 0,
      "parentId": 0,
      "path": "string",
      "cashflowManagerId": 0,
      "allowPriceOverride": true,
      "addonType": "string",
      "translations": [
        {
          "language": "string",
          "name": "string",
          "shortDescription": "string",
          "description": "string",
          "description2": "string",
          "namePath": "string"
        }
      ],
      "source": "string",
      "showNilPriceOnBill": true,
      "powerplaygroupId": 0,
      "allowMovingToMainBill": true,
      "archivedFrom": "2025-06-04",
      "searchCode": "string",
      "excludePriceCache": true,
      "specialPriority": 0,
      "type": "ACCOMMODATIONTYPE",
      "locationArticle": true,
      "stayArticle": true,
      "reservationArticle": true,
      "cashArticle": true,
      "ownerArticle": true,
      "invoiceArticle": true,
      "perDay": true,
      "customizable": true,
      "stockType": "string",
      "dayAddon": true,
      "withholdingArticle": true,
      "warrant": true,
      "correction": true,
      "commission": true,
      "vatCommission": true,
      "cancelPremium": true,
      "cancelCompensation": true,
      "adjustment": true,
      "repaymentVoucher": true,
      "earlyCheckin": true,
      "showDatesOnInternet": true,
      "allowToAddInCiCo": true,
      "tax": true,
      "maxQuantity": 0,
      "commissionVatIncluded": true,
      "implicationManagerId": 0,
      "ledgerId": 0,
      "ledgerGroupId": 0,
      "dependsOnLedgerGroup": true,
      "dependencyMask": "NONE",
      "applyDependencyMask": true,
      "autoValidate": true
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Additions

Endpoints

GET
GET

Get all additions

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

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.
bookDateFrom:2025-06-04T05:08:24.664Z,
bookDateTo:2025-06-04T05:08:24.664Z,
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:2025-06-04,
validTo:2025-06-04For 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 add-ons additions.

GET

/maxxton/v2/add-ons/additions?page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/add-ons/additions'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "additionId": 0,
      "additionResourceId": 0,
      "additionFast": true,
      "mandatoryResource": true,
      "maxQuantity": 0,
      "maxReservable": 0,
      "maxTotalQuantity": 0,
      "unitId": 0,
      "priceCompare": true,
      "resourceId": 0,
      "supplierAdditionId": 0,
      "validFrom": "2025-06-04",
      "validTo": "2025-06-04",
      "resourceMoment": [
        ""
      ],
      "type": "ACCOMMODATIONTYPE",
      "locationArticle": true,
      "translations": [
        {
          "language": "string",
          "name": "string",
          "shortDescription": "string",
          "description": "string",
          "description2": "string"
        }
      ],
      "addonType": "string",
      "bookDateFrom": "2025-06-04T05:08:24.660Z",
      "bookDateTo": "2025-06-04T05:08:24.660Z"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Get all additions for a add-on

Get 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.

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.
bookDateFrom:2025-06-04T05:08:24.664Z,
bookDateTo:2025-06-04T05:08:24.664Z,
additionId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:2025-06-04,
validTo:2025-06-04For more information, check: Filtering

Path Parameters

additionResourceIdinteger (int64)Required

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

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 add-ons additions.

GET

/maxxton/v2/add-ons/{additionResourceId}/additions?page=&size=&sort=&filter=

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/add-ons/{additionResourceId}/additions'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "additionId": 0,
      "additionResourceId": 0,
      "additionFast": true,
      "mandatoryResource": true,
      "maxQuantity": 0,
      "maxReservable": 0,
      "maxTotalQuantity": 0,
      "unitId": 0,
      "priceCompare": true,
      "resourceId": 0,
      "supplierAdditionId": 0,
      "validFrom": "2025-06-04",
      "validTo": "2025-06-04",
      "resourceMoment": [
        ""
      ],
      "type": "ACCOMMODATIONTYPE",
      "locationArticle": true,
      "translations": [
        {
          "language": "string",
          "name": "string",
          "shortDescription": "string",
          "description": "string",
          "description2": "string"
        }
      ],
      "addonType": "string",
      "bookDateFrom": "2025-06-04T05:08:24.660Z",
      "bookDateTo": "2025-06-04T05:08:24.660Z"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Dynamicfields

Endpoints

GET
PUT

Images

Endpoints

GET

Implies

Endpoints

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

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.

Endpoints

POST
GET
GET
PUT
GET
POST
DELETE
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
PUT
GET
PUT
POST
GET
POST
DELETE
GET
GET
GET
POST
GET