Financialtransactions

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

Create an admin organisation

Body Parameters

namestring Required
Max length
50
descriptionstring Required
Max length
4000
codestring Required

Unique code of the admin organisation

Max length
50
currencyIdinteger (int64)Required

CurrencyId of the admin organisation

originstring Required
originIdstring Required

Response

200
Object
The request is completed successfully without any errors

Response Attributes

adminOrganisationIdinteger (int64)
namestring
descriptionstring
codestring
currencyIdinteger (int64)
currencyCodestring
originstring
originIdstring
journalIdinteger (int64)
500
Object
Error occurred while creating admin organisation.

POST

/maxxton/v2/adminorganisations

Select
1 2 3 4 5 6 7 8 9 curl --location 'https://api.maxxton.net/maxxton/v2/adminorganisations' \ --data '{ "name": "string", "description": "string", "code": "string", "currencyId": 0, "origin": "string", "originId": "string" }'

Response

{
  "adminOrganisationId": 0,
  "name": "string",
  "description": "string",
  "code": "string",
  "currencyId": 0,
  "currencyCode": "string",
  "origin": "string",
  "originId": "string",
  "journalId": 0
}

Get all admin organisations

Get a page with admin organisations. The records can be filtered based on the adminorganisation object.

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.
adminOrganisationId:0,
name:String,
description:String,
code:String,
currencyId:0,
currencyCode:String,
origin:String,
originId:String,
journalId: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 admin organisations.

GET

/maxxton/v2/adminorganisations?page=&size=&sort=&filter=

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

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "adminOrganisationId": 0,
      "name": "string",
      "description": "string",
      "code": "string",
      "currencyId": 0,
      "currencyCode": "string",
      "origin": "string",
      "originId": "string",
      "journalId": 0
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Update a admin organisation

Path Parameters

adminOrganisationIdinteger (int64)Required

Body Parameters

codestring Required

Unique code of the admin organisation

Max length
50
currencyIdinteger (int64)Required

CurrencyId of the admin organisation

descriptionstring Required
Max length
4000
namestring Required
Max length
50
originstring Required

Origin name of the Admin Organisation

originIdstring Required

Origin Id of the Admin Organisation

Response

200
Object
The request is completed successfully without any errors

Response Attributes

codestring Required

Unique code of the admin organisation

Max length
50
currencyIdinteger (int64)Required

CurrencyId of the admin organisation

descriptionstring Required
Max length
4000
namestring Required
Max length
50
originstring Required

Origin name of the Admin Organisation

originIdstring Required

Origin Id of the Admin Organisation

500
Object
Error occurred while updating admin organisation.

PUT

/maxxton/v2/adminorganisations/{adminOrganisationId}

Select
1 2 3 4 5 6 7 8 9 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/adminorganisations/{adminOrganisationId}' \ --data '{ "code": "string", "currencyId": 0, "description": "string", "name": "string", "origin": "string", "originId": "string" }'

Response

{
  "code": "string",
  "currencyId": 0,
  "description": "string",
  "name": "string",
  "origin": "string",
  "originId": "string"
}

Accounts

Endpoints

GET

Financialtransactions

Endpoints

GET
GET
PUT

Get all financial transactions for a AO

Get a page with financial transactions.The records can be filtered based on the FinancialTransactionReport object.

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.
financialTransactionReportId:0,
reportNumber:0,
creationDate:2025-06-04T05:08:24.664Z,
status:String,
companyId:0For more information, check: Filtering

Path Parameters

adminOrganisationIdinteger (int64)Required

Id of the admin organisation for which financial transactions has 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 financial transactions.

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions?page=&size=&sort=&filter=

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "financialTransactionReportId": 0,
      "reportNumber": 0,
      "creationDate": "2025-06-04T05:08:24.656Z",
      "status": "string",
      "adminOrganisationId": 0,
      "companyId": 0
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Journals

Endpoints

GET

Update financial transactions report for a AO

updates financial transactions report of specific admin organisation id and financial transaction report id

Path Parameters

adminOrganisationIdinteger (int64)Required

Id of the admin organisation for which financial transactions has to be fetched

financialTransactionReportIdinteger (int64)Required

Financial transaction report id for which financial transactions has to be fetched

Body Parameters

statusstring

Response

200
Object
The request is completed successfully without any errors

Response Attributes

financialTransactionReportIdinteger (int64)
reportNumberinteger (int64)
creationDatestring (date-time)
statusstring
adminOrganisationIdinteger (int64)
companyIdinteger (int64)
500
Object
Error occurred while updating financial transactions.

PUT

/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}

Select
1 2 3 4 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}' \ --data '{ "status": "string" }'

Response

{
  "financialTransactionReportId": 0,
  "reportNumber": 0,
  "creationDate": "2025-06-04T05:08:24.656Z",
  "status": "string",
  "adminOrganisationId": 0,
  "companyId": 0
}

Ownerfinancialtransactions

Endpoints

GET
GET
GET
PUT

Revenuedistributions

Endpoints

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