Get all units for owners

Sections

V1 docs (deprecated)API explorerGuidesChangelog
V1 docs (deprecated)
API explorer
Guides
Changelog

Theme switcher

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

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

Create owner

Adds a new Owner. The details are to be added in request body. Note: The country field in mailAddress is not allowed while adding a owner.

Body Parameters

accountNrstring
alternateNamestring
attentionOfstring
bicSwiftstring
birthDatestring (date)
companyNamestring
emailAllowedboolean
firstNamestring
fiscalTypesarray

Show child attributes

ibanNumberstring
lastNamestring
mailAddressobject

Show child attributes

mailAllowedboolean
middlestring
sendMethodIdinteger (int64)
genderstring
Enum values:
MALEFEMALEUNSPECIFIED
titleIdinteger (int64)
originstring
originIdstring
ownerPoolstring
Enum values:
OWNERPOOLRENT_ASSURANCE_POOLYEAR_ROUND_GUESTBUSINESSLOCATIONMAINTAINANCE_FUNDVENDORPOOL_CONSUMPTIONPOOL_SHARE
... 2 other enums
ownerGroupIdinteger (int64)
ownerTypestring
Enum values:
PRIVATE_OWNERCOMPANYUNKNOWN
questionnaireUnsubscribedboolean

Response

200
Object
The request is completed successfully without any errors

Response Attributes

ownerIdinteger (int64)
accountNrstring
firstNamestring
lastNamestring
middlestring
alternateNamestring
attentionOfstring
birthDatestring (date)
languageIdinteger (int64)
mailAllowedboolean
sendMethodIdinteger (int64)
genderstring

Gender of owner and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

Enum values:
MALEFEMALEUNSPECIFIED
originstring
originIdstring
socialSecurityNumberstring
emailAllowedboolean
titleIdinteger (int64)
ibanNumberstring
bicSwiftstring
companyNamestring
ownerGroupIdinteger (int64)
mailAddressobject

Show child attributes

previousPmsIdstring
fiscalTypesarray

Show child attributes

sharedOwnerShipsarray

Show child attributes

ownerPoolstring
Enum values:
OWNERPOOLRENT_ASSURANCE_POOLYEAR_ROUND_GUESTBUSINESSLOCATIONMAINTAINANCE_FUNDVENDORPOOL_CONSUMPTIONPOOL_SHARE
... 2 other enums
birthPlacestring
companyIdentificationNumberstring
socialSecurityNumberIssuingCountryIdinteger (int64)
taxNumberIssuingCountryIdinteger (int64)
taxNumberstring
ownerTypestring
dac7OwnerVerifiedboolean
birthCountryIdinteger (int64)
directDebitEnabledboolean
mandateIdentificiationstring
mandateTypestring
Enum values:
COREB2B
mandateSignedInstring (date)
languagestring
readOnly
questionnaireUnsubscribedboolean
500
Object
Error occurred while creating the owner

POST

/maxxton/v2/owners

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 curl --location 'https://api.maxxton.net/maxxton/v2/owners' \ --data '{ "accountNr": "string", "alternateName": "string", "attentionOf": "string", "bicSwift": "string", "birthDate": "2025-06-04", "companyName": "string", "emailAllowed": true, "firstName": "string", "fiscalTypes": [ { "ownerFiscalTypeId": 0, "fiscalType": "PRIVATE_OWNER", "startDate": "2025-06-04", "endDate": "2025-06-04", "fiscalVat": "string" } ], "ibanNumber": "string", "lastName": "string", "mailAddress": { "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "countryId": 0, "dateEnd": "2025-06-04", "dateBegin": "2025-06-04", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "mailAllowed": true, "middle": "string", "sendMethodId": 0, "gender": "MALE", "titleId": 0, "origin": "string", "originId": "string", "ownerPool": "OWNER", "ownerGroupId": 0, "ownerType": "PRIVATE_OWNER", "questionnaireUnsubscribed": true }'

Response

{
  "ownerId": 0,
  "accountNr": "string",
  "firstName": "string",
  "lastName": "string",
  "middle": "string",
  "alternateName": "string",
  "attentionOf": "string",
  "birthDate": "2025-06-04",
  "languageId": 0,
  "mailAllowed": true,
  "sendMethodId": 0,
  "gender": "MALE",
  "origin": "string",
  "originId": "string",
  "socialSecurityNumber": "string",
  "emailAllowed": true,
  "titleId": 0,
  "ibanNumber": "string",
  "bicSwift": "string",
  "companyName": "string",
  "ownerGroupId": 0,
  "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-04",
    "dateBegin": "2025-06-04",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "previousPmsId": "string",
  "fiscalTypes": [
    {
      "ownerFiscalTypeId": 0,
      "fiscalType": "PRIVATE_OWNER",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "fiscalVat": "string"
    }
  ],
  "sharedOwnerShips": [
    {
      "ownerId": 0,
      "role": "PRIMARY_OWNER"
    }
  ],
  "ownerPool": "OWNER",
  "birthPlace": "string",
  "companyIdentificationNumber": "string",
  "socialSecurityNumberIssuingCountryId": 0,
  "taxNumberIssuingCountryId": 0,
  "taxNumber": "string",
  "ownerType": "string",
  "dac7OwnerVerified": true,
  "birthCountryId": 0,
  "directDebitEnabled": true,
  "mandateIdentificiation": "string",
  "mandateType": "CORE",
  "mandateSignedIn": "2025-06-04",
  "language": "string",
  "questionnaireUnsubscribed": true
}

Get all owners

Get a page with owners. The records can be filtered based on owner object.It also supports pageable.

Query Parameters

returnFiscalTypeboolean

The fiscal types will be returned when the value is set to true

returnSharedOwnerShipsboolean

The List of shared ownerIds will be returned when the value is set to true

Default value
false
pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
ownerId:0,
accountNr:String,
firstName:String,
lastName:String,
middle:String,
alternateName:String,
attentionOf:String,
birthDate:2025-06-04,
languageId:0,
mailAllowed:true,
sendMethodId:0,
gender:String,
origin:String,
originId:String,
socialSecurityNumber:String,
emailAllowed:true,
titleId:0,
ibanNumber:String,
bicSwift:String,
companyName: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
500
Object
Error occurred while fetching owners

GET

/maxxton/v2/owners?returnFiscalType=&returnSharedOwnerShips=false&page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/owners?returnSharedOwnerShips=false'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "ownerId": 0,
      "accountNr": "string",
      "firstName": "string",
      "lastName": "string",
      "middle": "string",
      "alternateName": "string",
      "attentionOf": "string",
      "birthDate": "2025-06-04",
      "languageId": 0,
      "mailAllowed": true,
      "sendMethodId": 0,
      "gender": "MALE",
      "origin": "string",
      "originId": "string",
      "socialSecurityNumber": "string",
      "emailAllowed": true,
      "titleId": 0,
      "ibanNumber": "string",
      "bicSwift": "string",
      "companyName": "string",
      "ownerGroupId": 0,
      "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-04",
        "dateBegin": "2025-06-04",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "previousPmsId": "string",
      "fiscalTypes": [
        {
          "ownerFiscalTypeId": 0,
          "fiscalType": "PRIVATE_OWNER",
          "startDate": "2025-06-04",
          "endDate": "2025-06-04",
          "fiscalVat": "string"
        }
      ],
      "sharedOwnerShips": [
        {
          "ownerId": 0,
          "role": "PRIMARY_OWNER"
        }
      ],
      "ownerPool": "OWNER",
      "birthPlace": "string",
      "companyIdentificationNumber": "string",
      "socialSecurityNumberIssuingCountryId": 0,
      "taxNumberIssuingCountryId": 0,
      "taxNumber": "string",
      "ownerType": "string",
      "dac7OwnerVerified": true,
      "birthCountryId": 0,
      "directDebitEnabled": true,
      "mandateIdentificiation": "string",
      "mandateType": "CORE",
      "mandateSignedIn": "2025-06-04",
      "language": "string",
      "questionnaireUnsubscribed": true
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Get owner

Get information associated with specific owner. The records can be filtered based on owner object.

Query Parameters

returnSharedOwnerShipsboolean

The List of shared ownerIds will be returned when the value is set to true

Default value
false

Path Parameters

ownerIdinteger (int64)Required

An Id of owner to be fetched

Response

200
Object
The request is completed successfully without any errors

Response Attributes

ownerIdinteger (int64)
accountNrstring
firstNamestring
lastNamestring
middlestring
alternateNamestring
attentionOfstring
birthDatestring (date)
languageIdinteger (int64)
mailAllowedboolean
sendMethodIdinteger (int64)
genderstring

Gender of owner and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

Enum values:
MALEFEMALEUNSPECIFIED
originstring
originIdstring
socialSecurityNumberstring
emailAllowedboolean
titleIdinteger (int64)
ibanNumberstring
bicSwiftstring
companyNamestring
ownerGroupIdinteger (int64)
mailAddressobject

Show child attributes

previousPmsIdstring
fiscalTypesarray

Show child attributes

sharedOwnerShipsarray

Show child attributes

ownerPoolstring
Enum values:
OWNERPOOLRENT_ASSURANCE_POOLYEAR_ROUND_GUESTBUSINESSLOCATIONMAINTAINANCE_FUNDVENDORPOOL_CONSUMPTIONPOOL_SHARE
... 2 other enums
birthPlacestring
companyIdentificationNumberstring
socialSecurityNumberIssuingCountryIdinteger (int64)
taxNumberIssuingCountryIdinteger (int64)
taxNumberstring
ownerTypestring
dac7OwnerVerifiedboolean
birthCountryIdinteger (int64)
directDebitEnabledboolean
mandateIdentificiationstring
mandateTypestring
Enum values:
COREB2B
mandateSignedInstring (date)
languagestring
readOnly
questionnaireUnsubscribedboolean
500
Object
Error occurred while fetching owner

GET

/maxxton/v2/owners/{ownerId}?returnSharedOwnerShips=false

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/owners/{ownerId}?returnSharedOwnerShips=false'

Response

{
  "ownerId": 0,
  "accountNr": "string",
  "firstName": "string",
  "lastName": "string",
  "middle": "string",
  "alternateName": "string",
  "attentionOf": "string",
  "birthDate": "2025-06-04",
  "languageId": 0,
  "mailAllowed": true,
  "sendMethodId": 0,
  "gender": "MALE",
  "origin": "string",
  "originId": "string",
  "socialSecurityNumber": "string",
  "emailAllowed": true,
  "titleId": 0,
  "ibanNumber": "string",
  "bicSwift": "string",
  "companyName": "string",
  "ownerGroupId": 0,
  "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-04",
    "dateBegin": "2025-06-04",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "previousPmsId": "string",
  "fiscalTypes": [
    {
      "ownerFiscalTypeId": 0,
      "fiscalType": "PRIVATE_OWNER",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "fiscalVat": "string"
    }
  ],
  "sharedOwnerShips": [
    {
      "ownerId": 0,
      "role": "PRIMARY_OWNER"
    }
  ],
  "ownerPool": "OWNER",
  "birthPlace": "string",
  "companyIdentificationNumber": "string",
  "socialSecurityNumberIssuingCountryId": 0,
  "taxNumberIssuingCountryId": 0,
  "taxNumber": "string",
  "ownerType": "string",
  "dac7OwnerVerified": true,
  "birthCountryId": 0,
  "directDebitEnabled": true,
  "mandateIdentificiation": "string",
  "mandateType": "CORE",
  "mandateSignedIn": "2025-06-04",
  "language": "string",
  "questionnaireUnsubscribed": true
}

Update owner

Update owner of provided ownerId.

Path Parameters

ownerIdinteger (int64)Required

ownerId of owner which needs to be update

Body Parameters

accountNrstring
alternateNamestring
attentionOfstring
bicSwiftstring
birthDatestring (date)
companyNamestring
emailAllowedboolean
firstNamestring
fiscalTypesarray

Show child attributes

ibanNumberstring
lastNamestring
mailAddressobject

Show child attributes

mailAllowedboolean
middlestring
sendMethodIdinteger (int64)
genderstring
Enum values:
MALEFEMALEUNSPECIFIED
titleIdinteger (int64)
originstring
originIdstring
ownerGroupIdinteger (int64)
ownerPoolstring
Enum values:
OWNERPOOLRENT_ASSURANCE_POOLYEAR_ROUND_GUESTBUSINESSLOCATIONMAINTAINANCE_FUNDVENDORPOOL_CONSUMPTIONPOOL_SHARE
... 2 other enums
ownerTypestring
Enum values:
PRIVATE_OWNERCOMPANYUNKNOWN
questionnaireUnsubscribedboolean

Response

200
Object
The request is completed successfully without any errors

Response Attributes

ownerIdinteger (int64)
accountNrstring
firstNamestring
lastNamestring
middlestring
alternateNamestring
attentionOfstring
birthDatestring (date)
languageIdinteger (int64)
mailAllowedboolean
sendMethodIdinteger (int64)
genderstring

Gender of owner and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

Enum values:
MALEFEMALEUNSPECIFIED
originstring
originIdstring
socialSecurityNumberstring
emailAllowedboolean
titleIdinteger (int64)
ibanNumberstring
bicSwiftstring
companyNamestring
ownerGroupIdinteger (int64)
mailAddressobject

Show child attributes

previousPmsIdstring
fiscalTypesarray

Show child attributes

sharedOwnerShipsarray

Show child attributes

ownerPoolstring
Enum values:
OWNERPOOLRENT_ASSURANCE_POOLYEAR_ROUND_GUESTBUSINESSLOCATIONMAINTAINANCE_FUNDVENDORPOOL_CONSUMPTIONPOOL_SHARE
... 2 other enums
birthPlacestring
companyIdentificationNumberstring
socialSecurityNumberIssuingCountryIdinteger (int64)
taxNumberIssuingCountryIdinteger (int64)
taxNumberstring
ownerTypestring
dac7OwnerVerifiedboolean
birthCountryIdinteger (int64)
directDebitEnabledboolean
mandateIdentificiationstring
mandateTypestring
Enum values:
COREB2B
mandateSignedInstring (date)
languagestring
readOnly
questionnaireUnsubscribedboolean
500
Object
Error occurred while updating owner.

PUT

/maxxton/v2/owners/{ownerId}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/owners/{ownerId}' \ --data '{ "accountNr": "string", "alternateName": "string", "attentionOf": "string", "bicSwift": "string", "birthDate": "2025-06-04", "companyName": "string", "emailAllowed": true, "firstName": "string", "fiscalTypes": [ { "ownerFiscalTypeId": 0, "fiscalType": "PRIVATE_OWNER", "startDate": "2025-06-04", "endDate": "2025-06-04", "fiscalVat": "string" } ], "ibanNumber": "string", "lastName": "string", "mailAddress": { "addressId": 0, "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "dateEnd": "2025-06-04", "dateBegin": "2025-06-04", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "mailAllowed": true, "middle": "string", "sendMethodId": 0, "gender": "MALE", "titleId": 0, "origin": "string", "originId": "string", "ownerGroupId": 0, "ownerPool": "OWNER", "ownerType": "PRIVATE_OWNER", "questionnaireUnsubscribed": true }'

Response

{
  "ownerId": 0,
  "accountNr": "string",
  "firstName": "string",
  "lastName": "string",
  "middle": "string",
  "alternateName": "string",
  "attentionOf": "string",
  "birthDate": "2025-06-04",
  "languageId": 0,
  "mailAllowed": true,
  "sendMethodId": 0,
  "gender": "MALE",
  "origin": "string",
  "originId": "string",
  "socialSecurityNumber": "string",
  "emailAllowed": true,
  "titleId": 0,
  "ibanNumber": "string",
  "bicSwift": "string",
  "companyName": "string",
  "ownerGroupId": 0,
  "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-04",
    "dateBegin": "2025-06-04",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "previousPmsId": "string",
  "fiscalTypes": [
    {
      "ownerFiscalTypeId": 0,
      "fiscalType": "PRIVATE_OWNER",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "fiscalVat": "string"
    }
  ],
  "sharedOwnerShips": [
    {
      "ownerId": 0,
      "role": "PRIMARY_OWNER"
    }
  ],
  "ownerPool": "OWNER",
  "birthPlace": "string",
  "companyIdentificationNumber": "string",
  "socialSecurityNumberIssuingCountryId": 0,
  "taxNumberIssuingCountryId": 0,
  "taxNumber": "string",
  "ownerType": "string",
  "dac7OwnerVerified": true,
  "birthCountryId": 0,
  "directDebitEnabled": true,
  "mandateIdentificiation": "string",
  "mandateType": "CORE",
  "mandateSignedIn": "2025-06-04",
  "language": "string",
  "questionnaireUnsubscribed": true
}

Accommodationtypes

A collection of similar units grouped together.

Endpoints

GET
GET

Communications

Endpoints

GET

Credentials

Endpoints

PUT

Files

Endpoints

GET
GET

Groups

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

Endpoints

GET

Login

Endpoints

POST

Reservations

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

Endpoints

GET

Settlements

Endpoints

GET
GET

Units

A place where guests stay, such as a hotel room, apartment, or vacation rental.

Endpoints

POST
GET
GET
GET
GET
GET
PUT

Create unit for a owner

Create a link between an existing unit and an existing owner using ownership.

Path Parameters

ownerIdinteger (int64)Required

ownerId of owner

Body Parameters

ownershipIdinteger (int64)
startDatestring (date)
endDatestring (date)
originstring
originIdstring
isReportToAuthboolean

Response

200
Object
The request is completed successfully without any errors

Response Attributes

ownershipIdinteger (int64)
unitIdinteger (int64)Required
readOnly
startDatestring (date)
endDatestring (date)
originstring
originIdstring
isReportToAuthboolean
500
Object
Error occurred while creating ownership

POST

/maxxton/v2/owners/{ownerId}/units

Select
1 2 3 4 5 6 7 8 9 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/owners/{ownerId}/units' \ --data '{ "ownershipId": 0, "startDate": "2025-06-04", "endDate": "2025-06-04", "origin": "string", "originId": "string", "isReportToAuth": true }'

Response

{
  "ownershipId": 0,
  "unitId": 0,
  "startDate": "2025-06-04",
  "endDate": "2025-06-04",
  "origin": "string",
  "originId": "string",
  "isReportToAuth": true
}

Get all units for a owner

Get a page of units associated to the owner. The records can be filtered based on owner unit object.It also supports pageable.

Query Parameters

codestring

Code of the unit

resourceIdinteger (int64)

ResourceId of the accommodationType to which the unit is linked

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
unitId:0,
startDate:2025-06-04,
endDate:2025-06-04For more information, check: Filtering

Path Parameters

ownerIdinteger (int64)Required

Owner id to fetch units of the owner

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 owners with units

GET

/maxxton/v2/owners/{ownerId}/units?code=&resourceId=&page=&size=&sort=&filter=

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/owners/{ownerId}/units'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "ownerId": 0,
      "unitId": 0,
      "brand": "string",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "locationId": 0,
      "path": "string",
      "origin": "string",
      "code": "string",
      "translations": [
        {
          "language": "string",
          "name": "string",
          "description": "string",
          "description2": "string",
          "shortDescription": "string"
        }
      ],
      "accommodationAddress": {
        "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-04",
        "dateBegin": "2025-06-04",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "resourceId": 0,
      "nrOfBathrooms": 0,
      "nrOfBedrooms": 0,
      "originId": "string",
      "resourceGroupId": 0,
      "archivedFrom": "2025-06-04",
      "vsi": 0,
      "choosableOnInternet": true,
      "excludeQuestionnaireStats": true,
      "roomCode": "string",
      "cleaningStatus": "CLEAN"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Get all units for a owner group

Get a page of units associated to the owner. The records can be filtered based on owner unit object.It also supports pageable.

Query Parameters

codestring

Code of the unit

resourceIdinteger (int64)

ResourceId of the accommodationType to which the unit is linked

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
unitId:0,
startDate:2025-06-04,
endDate:2025-06-04For more information, check: Filtering

Path Parameters

ownerGroupIdinteger (int64)Required

OwnerGroup Id to fetch units of the owners

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 owners with units

GET

/maxxton/v2/ownergroups/{ownerGroupId}/units?code=&resourceId=&page=&size=&sort=&filter=

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/ownergroups/{ownerGroupId}/units'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "ownerId": 0,
      "unitId": 0,
      "brand": "string",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "locationId": 0,
      "path": "string",
      "origin": "string",
      "code": "string",
      "translations": [
        {
          "language": "string",
          "name": "string",
          "description": "string",
          "description2": "string",
          "shortDescription": "string"
        }
      ],
      "accommodationAddress": {
        "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-04",
        "dateBegin": "2025-06-04",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "resourceId": 0,
      "nrOfBathrooms": 0,
      "nrOfBedrooms": 0,
      "originId": "string",
      "resourceGroupId": 0,
      "archivedFrom": "2025-06-04",
      "vsi": 0,
      "choosableOnInternet": true,
      "excludeQuestionnaireStats": true,
      "roomCode": "string",
      "cleaningStatus": "CLEAN"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Get all units for owners

Get a page with owners with their units. The records can be filtered based on owner unit object.It also supports pageable.

Query Parameters

codestring

Code of the unit

resourceIdinteger (int64)

ResourceId of the accommodationType to which the unit is linked

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
unitId:0,
startDate:2025-06-04,
endDate: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 owners with units

GET

/maxxton/v2/owners/units?code=&resourceId=&page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/owners/units'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "ownerId": 0,
      "unitId": 0,
      "brand": "string",
      "startDate": "2025-06-04",
      "endDate": "2025-06-04",
      "locationId": 0,
      "path": "string",
      "origin": "string",
      "code": "string",
      "translations": [
        {
          "language": "string",
          "name": "string",
          "description": "string",
          "description2": "string",
          "shortDescription": "string"
        }
      ],
      "accommodationAddress": {
        "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-04",
        "dateBegin": "2025-06-04",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "resourceId": 0,
      "nrOfBathrooms": 0,
      "nrOfBedrooms": 0,
      "originId": "string",
      "resourceGroupId": 0,
      "archivedFrom": "2025-06-04",
      "vsi": 0,
      "choosableOnInternet": true,
      "excludeQuestionnaireStats": true,
      "roomCode": "string",
      "cleaningStatus": "CLEAN"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Ownerships

Endpoints

GET

Reservations

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

Endpoints

GET

Update unit for a owner

Update ownership of provided ownershipId.

Path Parameters

ownerIdinteger (int64)Required

ownerId of ownership

unitIdinteger (int64)Required

unitId of ownership

Body Parameters

ownershipIdinteger (int64)
startDatestring (date)
endDatestring (date)
originstring
originIdstring
isReportToAuthboolean

Response

200
Object
The request is completed successfully without any errors

Response Attributes

ownershipIdinteger (int64)
unitIdinteger (int64)Required
readOnly
startDatestring (date)
endDatestring (date)
originstring
originIdstring
isReportToAuthboolean
500
Object
Error occurred while updating ownership.

PUT

/maxxton/v2/owners/{ownerId}/units/{unitId}

Select
1 2 3 4 5 6 7 8 9 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/owners/{ownerId}/units/{unitId}' \ --data '{ "ownershipId": 0, "startDate": "2025-06-04", "endDate": "2025-06-04", "origin": "string", "originId": "string", "isReportToAuth": true }'

Response

{
  "ownershipId": 0,
  "unitId": 0,
  "startDate": "2025-06-04",
  "endDate": "2025-06-04",
  "origin": "string",
  "originId": "string",
  "isReportToAuth": true
}

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