Phonecalls

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

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

customerGroupIdinteger (int64)
titleIdinteger (int64)
firstNamestring

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.

middlestring

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.

lastNamestring

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.

alternateNamestring

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.

mailAddressobject

Show child attributes

emailAllowedboolean
mailAllowedboolean
phoneCallAllowedboolean

This field indicates if the customer has given us permission to contact them via phone call.

textMsgAllowedboolean

This field indicates if we can send text messages to the customer.

signatureDatestring (date)
socialSecurityNumberstring

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.

genderstring

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

Enum values:
MALEFEMALEUNSPECIFIED
languageIdinteger (int64)
ibanNumberstring

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

bicSwiftstring
birthDatestring (date)

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.

companyNamestring

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.

loginstring

Login id for the customer. Login field should be same as the email field in the customer address entity.

previousPmsIdinteger (int64)
creationDatestring (date-time)
identityTypestring

Type of identity document provided by the customer.

Enum values:
PASSPORTIDENTITY_CARDDRIVERS_LICENCE
identityNumberstring

Unique identification number as printed on the customer's identity document.

Max length
50
identityCountryIdinteger (int64)

Id of the country that issued the identity document..

identityDateIssuedstring (date)

Date the identity document was issued.

questionnaireUnsubscribedboolean

Response

200
Object
The request is completed successfully without any errors

Response Attributes

customerIdinteger (int64)
readOnly
customerGroupIdinteger (int64)
titleIdinteger (int64)
firstNamestring

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.

middlestring

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.

lastNamestring

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.

alternateNamestring

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.

mailAddressobject

Show child attributes

emailAllowedboolean
mailAllowedboolean
phoneCallAllowedboolean

This field indicates if the customer has given us permission to contact them via phone call.

textMsgAllowedboolean

This field indicates if we can send text messages to the customer.

signatureDatestring (date)
socialSecurityNumberstring

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.

genderstring

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

Enum values:
MALEFEMALEUNSPECIFIED
languageIdinteger (int64)
languagestring
readOnly
ibanNumberstring

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

bicSwiftstring
birthDatestring (date)

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.

companyNamestring

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.

loginstring

Login id for the customer. Login field should be same as the email field in the customer address entity.

previousPmsIdinteger (int64)
creationDatestring (date-time)
identityTypestring

Type of identity document provided by the customer.

Enum values:
PASSPORTIDENTITY_CARDDRIVERS_LICENCE
identityNumberstring

Unique identification number as printed on the customer's identity document.

Max length
50
identityCountryIdinteger (int64)

Id of the country that issued the identity document..

identityDateIssuedstring (date)

Date the identity document was issued.

questionnaireUnsubscribedboolean
500
Object
Error occurred while creating customers

POST

/maxxton/v2/customers

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 curl --location 'https://api.maxxton.net/maxxton/v2/customers' \ --data '{ "customerGroupId": 0, "titleId": 0, "firstName": "string", "middle": "string", "lastName": "string", "alternateName": "string", "mailAddress": { "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", "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", "altContactPerson": "string" }, "emailAllowed": true, "mailAllowed": true, "phoneCallAllowed": true, "textMsgAllowed": true, "signatureDate": "2025-06-04", "socialSecurityNumber": "string", "gender": "MALE", "languageId": 0, "ibanNumber": "string", "bicSwift": "string", "birthDate": "2025-06-04", "companyName": "string", "login": "string", "previousPmsId": 0, "creationDate": "2025-06-04T05:08:24.655Z", "identityType": "PASSPORT", "identityNumber": "string", "identityCountryId": 0, "identityDateIssued": "2025-06-04", "questionnaireUnsubscribed": true }'

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-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"
    }
  },
  "emailAllowed": true,
  "mailAllowed": true,
  "phoneCallAllowed": true,
  "textMsgAllowed": true,
  "signatureDate": "2025-06-04",
  "socialSecurityNumber": "string",
  "gender": "MALE",
  "languageId": 0,
  "language": "string",
  "ibanNumber": "string",
  "bicSwift": "string",
  "birthDate": "2025-06-04",
  "companyName": "string",
  "login": "string",
  "previousPmsId": 0,
  "creationDate": "2025-06-04T05:08:24.655Z",
  "identityType": "PASSPORT",
  "identityNumber": "string",
  "identityCountryId": 0,
  "identityDateIssued": "2025-06-04",
  "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

emailstring

Filter customer's on email id

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

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-04,
socialSecurityNumber:String,
gender:String,
languageId:0,
ibanNumber:String,
bicSwift:String,
birthDate:2025-06-04,
companyName:String,
login: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 customers

GET

/maxxton/v2/customers?email=&page=&size=&sort=&filter=

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

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-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"
        }
      },
      "emailAllowed": true,
      "mailAllowed": true,
      "phoneCallAllowed": true,
      "textMsgAllowed": true,
      "signatureDate": "2025-06-04",
      "socialSecurityNumber": "string",
      "gender": "MALE",
      "languageId": 0,
      "language": "string",
      "ibanNumber": "string",
      "bicSwift": "string",
      "birthDate": "2025-06-04",
      "companyName": "string",
      "login": "string",
      "previousPmsId": 0,
      "creationDate": "2025-06-04T05:08:24.655Z",
      "identityType": "PASSPORT",
      "identityNumber": "string",
      "identityCountryId": 0,
      "identityDateIssued": "2025-06-04",
      "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

filterarray

Following fields can be used for filtering response.
titleId:0,
code:String,
priority:0For more information, check: Filtering

Response

200
Object
The request is completed successfully without any errors

Response Attributes

titleIdinteger (int64)

Unique id associated with each title linked to the customer

codestring

Unique code associated with each customer title

priorityinteger (int32)

Sequence in which the title will be displayed to the user.

translationsarray

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

500
Object
Error occurred while fetching customer titles

GET

/maxxton/v2/titles?filter=

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

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

customerIdinteger (int64)Required

An Id of customer to be fetched

Response

200
Object
The request is completed successfully without any errors

Response Attributes

customerIdinteger (int64)
readOnly
customerGroupIdinteger (int64)
titleIdinteger (int64)
firstNamestring

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.

middlestring

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.

lastNamestring

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.

alternateNamestring

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.

mailAddressobject

details of the visit address of the user

Show child attributes

emailAllowedboolean
mailAllowedboolean
phoneCallAllowedboolean

This field indicates if the customer has given us permission to contact them via phone call.

textMsgAllowedboolean

This field indicates if we can send text messages to the customer.

signatureDatestring (date)
socialSecurityNumberstring

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.

genderstring

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

Enum values:
MALEFEMALEUNSPECIFIED
languageIdinteger (int64)
languagestring
readOnly
ibanNumberstring

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

bicSwiftstring
birthDatestring (date)

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.

companyNamestring

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.

loginstring

Login id for the customer. Login field should be same as the email field in the customer address entity.

previousPmsIdinteger (int64)
creationDatestring (date-time)
identityTypestring

Type of identity document provided by the customer.

Enum values:
PASSPORTIDENTITY_CARDDRIVERS_LICENCE
identityNumberstring

Unique identification number as printed on the customer's identity document.

Max length
50
identityCountryIdinteger (int64)

Id of the country that issued the identity document..

identityDateIssuedstring (date)

Date the identity document was issued.

questionnaireUnsubscribedboolean
404
Object
No customer found for given customer id.
500
Object
Error occurred while fetching this customer

GET

/maxxton/v2/customers/{customerId}

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/customers/{customerId}'

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-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"
    }
  },
  "emailAllowed": true,
  "mailAllowed": true,
  "phoneCallAllowed": true,
  "textMsgAllowed": true,
  "signatureDate": "2025-06-04",
  "socialSecurityNumber": "string",
  "gender": "MALE",
  "languageId": 0,
  "language": "string",
  "ibanNumber": "string",
  "bicSwift": "string",
  "birthDate": "2025-06-04",
  "companyName": "string",
  "login": "string",
  "previousPmsId": 0,
  "creationDate": "2025-06-04T05:08:24.655Z",
  "identityType": "PASSPORT",
  "identityNumber": "string",
  "identityCountryId": 0,
  "identityDateIssued": "2025-06-04",
  "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

customerIdinteger (int64)Required

Customer id to fetch files associated with the customer

Body Parameters

firstNamestring
middlestring
lastNamestring
alternateNamestring
birthDatestring (date)
emailAllowedboolean
mailAllowedboolean
textMsgAllowedboolean
phoneCallAllowedboolean
ibanNumberstring
bicSwiftstring
languagestring
genderstring
titleIdinteger (int64)
mailAddressobject

Show child attributes

identityTypestring
Enum values:
PASSPORTIDENTITY_CARDDRIVERS_LICENCE
identityNumberstring
Max length
50
identityCountryIdinteger (int64)
identityDateIssuedstring (date)

Response

200
Object
The request is completed successfully without any errors

Response Attributes

customerIdinteger (int64)
readOnly
customerGroupIdinteger (int64)
titleIdinteger (int64)
firstNamestring

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.

middlestring

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.

lastNamestring

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.

alternateNamestring

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.

mailAddressobject

details of the visit address of the user

Show child attributes

emailAllowedboolean
mailAllowedboolean
phoneCallAllowedboolean

This field indicates if the customer has given us permission to contact them via phone call.

textMsgAllowedboolean

This field indicates if we can send text messages to the customer.

signatureDatestring (date)
socialSecurityNumberstring

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.

genderstring

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

Enum values:
MALEFEMALEUNSPECIFIED
languageIdinteger (int64)
languagestring
readOnly
ibanNumberstring

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

bicSwiftstring
birthDatestring (date)

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.

companyNamestring

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.

loginstring

Login id for the customer. Login field should be same as the email field in the customer address entity.

previousPmsIdinteger (int64)
creationDatestring (date-time)
identityTypestring

Type of identity document provided by the customer.

Enum values:
PASSPORTIDENTITY_CARDDRIVERS_LICENCE
identityNumberstring

Unique identification number as printed on the customer's identity document.

Max length
50
identityCountryIdinteger (int64)

Id of the country that issued the identity document..

identityDateIssuedstring (date)

Date the identity document was issued.

questionnaireUnsubscribedboolean
404
Object
No customer found for given customer id.
500
Object
Error occurred while updating details for this customer

PUT

/maxxton/v2/customers/{customerId}

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 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/customers/{customerId}' \ --data '{ "firstName": "string", "middle": "string", "lastName": "string", "alternateName": "string", "birthDate": "2025-06-04", "emailAllowed": true, "mailAllowed": true, "textMsgAllowed": true, "phoneCallAllowed": true, "ibanNumber": "string", "bicSwift": "string", "language": "string", "gender": "string", "titleId": 0, "mailAddress": { "email": "string", "address1": "string", "address2": "string", "address3": "string", "city": "string", "countryCode": "string", "district": "string", "houseNumber": "string", "houseNumberSuffix": "string", "mobilePhone": "string", "mobilePhone2": "string", "poBox": "string", "poBoxCity": "string", "poBoxZipcode": "string", "privatePhone": "string", "workPhone": "string", "zipCode": "string", "stateId": 0, "boxNumber": "string", "municipality": "string", "latitude": 0, "longitude": 0 }, "identityType": "PASSPORT", "identityNumber": "string", "identityCountryId": 0, "identityDateIssued": "2025-06-04" }'

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-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"
    }
  },
  "emailAllowed": true,
  "mailAllowed": true,
  "phoneCallAllowed": true,
  "textMsgAllowed": true,
  "signatureDate": "2025-06-04",
  "socialSecurityNumber": "string",
  "gender": "MALE",
  "languageId": 0,
  "language": "string",
  "ibanNumber": "string",
  "bicSwift": "string",
  "birthDate": "2025-06-04",
  "companyName": "string",
  "login": "string",
  "previousPmsId": 0,
  "creationDate": "2025-06-04T05:08:24.655Z",
  "identityType": "PASSPORT",
  "identityNumber": "string",
  "identityCountryId": 0,
  "identityDateIssued": "2025-06-04",
  "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

employeeGroupIdinteger (int64)

Customer phone calls will be returned based on the employeeGroupId

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
customerPhoneCallId:0,
type:String,
customerId:0,
employeeId:0,
startTime:2025-06-04T05:08:24.666Z,
endTime:2025-06-04T05:08:24.666Z,
phoneNumber:String,
memoCategoryId:0,
note:String,
locationId:0For more information, check: Filtering

Response

200
Object
The request is completed successfully without any errors

Response Attributes

totalElementsinteger (int64)

Total number of elements available in the whole response.

totalPagesinteger (int32)

Total number of pages the response has.

firstboolean

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

lastboolean

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

sizeinteger (int32)

Size of the current page.

contentarray

Show child attributes

numberinteger (int32)

Page number currently accessed.

sortarray

Show child attributes

numberOfElementsinteger (int32)

Total number of elements in the current page.

emptyboolean
500
Object
Error occurred while fetching customer phone calls

GET

/maxxton/v2/customers/phonecalls?employeeGroupId=&page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/customers/phonecalls'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "customerPhoneCallId": 0,
      "type": "INCOMING",
      "customerId": 0,
      "employeeId": 0,
      "startTime": "2025-06-04T05:08:24.655Z",
      "endTime": "2025-06-04T05:08:24.655Z",
      "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.

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