Sections

Maxxton External API
Accommodation Types
- POST
  Create accommodationtype
- GET
  Get accommodationtype
- GET
  Get all accommodationtypes
- PUT
  Update accommodationtype
- Additions
  - GET
    Get all additions
  - GET
    Get all additions for a resource
- Allotments
  - GET
    Get all allotments for a resource
  - Releases
    - GET
      Get all allotment releases for a resource
- Amenitylinks
  - GET
    Get all amenitylinks
  - GET
    Get all amenitylinks for a resource
- Availability
  - Additions
    - GET
      Get available additions for a specific accommodationtype
  - GET
    Get accommodationtype availability
  - Implies
    - GET
      Get all available implies for a specific accommodationtype
  - Preferences
    - GET
      Get available preferences for a specific accommodationtype
- Budgets
  - POST
    Create budgets for a resource
  - GET
    Get all budgets of a resource
- Calculateprices
  - POST
    Calculate prices for a resource
- Capacities
  - GET
    Get capacities for a resource
- Details
  - GET
    Get accommodationtype detail for a specific resource
  - GET
    Get accommodationtypes detail
- Dynamicfields
  - GET
    Get all dynamicfields for a resource
  - PUT
    Update dynamicfields for a resource
- Images
  - GET
    Get all images for a resource
- Implies
  - GET
    Get all implies
  - GET
    Get all implies for a resource
- Kinds
  - GET
    Get all accommodation kinds
- Locks
  - GET
    Get all locks for a resource
- Occupancy
  - GET
    Get all occupancy for a resource
- Priorities
  - GET
    Get all priorities for a resource
  - TargetAmounts
    - GET
      Get all target amounts for a resource priority
- Qualitylevels
  - GET
    Get all quality levels
- Rates
  - Batch
    - POST
      Create multiple rates for a resource
  - POST
    Create rates for a resource
  - GET
    Get all rates for a resource
- Releases
  - GET
    Get all releases for a resource
- Rentability
  - POST
    Create rentability for a resource
- Representations
  - POST
    Create representations for a resource
  - GET
    Get all representations for a resource
- Rooms
  - GET
    Get all rooms for a resource
- Search
  - POST
    Accommodationtype search
  - POST
    Arrival range search
- Videos
  - GET
    Get all videos for a resource
AddOn
- GET
  Get add-on
- GET
  Get all add-ons
- Additions
  - GET
    Get all additions
  - GET
    Get all additions for a add-on
- Dynamicfields
  - GET
    Get all dynamic fields for a add-on
  - PUT
    Update dynamic field for a add-on
- Images
  - GET
    Get all images for a add-on
- Implies
  - GET
    Get all implies for a add-on
  - GET
    Get all implies for add-ons
Admin Organisation
- POST
  Create an admin organisation
- GET
  Get all admin organisations
- PUT
  Update a admin organisation
- Accounts
  - GET
    Get all accounts for a AO
- Exchangerates
  - POST
    Add an exchange rate for an AO.
  - GET
    Get all exchange rates for a AO
- Financialtransactions
- Ownerfinancialtransactions
- Revenuedistributions
Allotment
- GET
  Get all allotments
- Releases
  - GET
    Get all allotment releases
Amenity
- POST
  Create amenity
- GET
  Get all amenities
- Categories
  - GET
    Get all amenity categories
- Details
  - GET
    Get all amenity details
Authentication
- POST
  Authenticate
Brands
- GET
  Get all brands
- GET
  Get brand
Cash Clearance
- GET
  Get all companies
- GET
  Get company
- Accounts
  - GET
    Get all cash accounts
- Clearance
  - GET
    Get all cash clearances
- Journalreports
  - Entries
    - GET
      Get Journal Report Entries
  - GET
    Get Journal Report of companies
Contracts
- POST
  Create a contract
- DELETE
  Delete a contract
- GET
  Get all contracts
- GET
  Get contract
- PUT
  Update a contract
- Types
  - GET
    Get all contract types
  - Rules
    - GET
      Get all rules
Countries
- GET
  Get all countries
- States
  - GET
    Get all states
Currency
- GET
  Get all currencies
- GET
  Get currency
Customer Care Report
- Customercare
  - GET
    Get all customer care reports
Customer Status
- GET
  Get all customer status
- Categories
  - GET
    Get all customerstatus categories
Customers
- POST
  Create a customer
- GET
  Get all customers
- GET
  Get all titles
- GET
  Get customer
- PUT
  Update a customer
- Communications
  - GET
    Get all communications for a customer
- Credentials
  - PUT
    Update credentials for a customer
- Customerstatus
  - GET
    Get all customerstatus for a customer
  - PUT
    Update customer status
- Files
  - GET
    Get all files for a customer
  - GET
    Get file for a customer
- Login
  - POST
    Authenticate a customer
- Loyalty
  - GET
    Get all loyality points details for a customer
  - Transactions
    - GET
      Get all transactions of loyality points
- Memos
  - POST
    Create memos for a customer
  - GET
    Get all memos for a customer
- Phonecalls
  - GET
    Get all phonecalls for a customer
DistributionChannels
- GET
  Get all distribution channels
- GET
  Get distribution channel
- Details
  - GET
    Get a page with distributionChannel details
  - GET
    Gets a single distributionChannel details
- Locations
  - GET
    Get all locations for a distribution channel
- Paymentmethods
  - GET
    Get all payment methods
  - GET
    Get all payment methods for a distribution channel
Employee
- POST
  Create employee
- GET
  Get all employees
- PUT
  Update employee
Events
- GET
  Get all events
Facilities
- GET
  Get all facilities
- GET
  Get facility
Groups
- GET
  Get all groups
- GET
  Get group
Housekeeping
- GET
  Get all housekeeping details
- History
  - GET
    Get housekeeping history
- Tasks
  - GET
    Get all housekeeping tasks
Icals
- GET
  Get ical link for a unit
Infotexts
- Search
  - POST
    Search infotexts
- Showmoments
  - GET
    Get all show moments
Invoice
- GET
  Get invoices
Languages
- GET
  Get all languages
Ledgers
- GET
  Get Ledger for specific ledger id
- GET
  Get a page with ledgers
- Groups
  - GET
    Get ledger group
  - GET
    Get all ledger groups
Locations
- POST
  Create a location
- GET
  Get a location
- GET
  Get all locations
- PUT
  Update a location
- Activities
  - GET
    Get all activities for multiple locations
- Amenitylinks
- Details
  - GET
    Get location details
  - GET
    Get specific location details
- Dynamicfields
  - GET
    Get all dynamic fields for a location
  - PUT
    Update dynamic field for a location
- Images
  - GET
    Get all images for a location
- Priorities
- Search
  - POST
    Search for locations
- Subjects
  - GET
    Get all subjects for a location
Locks
- Reasons
  - GET
    Get all lock reasons
Memos
- Categories
  - GET
    Get all memo categories
Nationalities
- GET
  Get all nationalities
Offer
- POST
  Create offer
- GET
  Get all offers
- GET
  Get offer
- PUT
  Update offer
- Additions
- Contracttypes
- Implies
  - GET
    Get all implies for a offer
  - GET
    Get all implies for offers
- Rates
  - GET
    Get all rates for a offer
  - POST
    Insert the offer rate
- Rentability
  - POST
    Create rentability for a offer
- Representations
  - POST
    Create representations for offer
  - GET
    Get all representations for a resource
Operations
- Images
  - GET
    Get all images for a operation
- PeriodicalTasks
  - GET
    Get all periodical tasks
- Tasks
  - GET
    Get all operation tasks
Owners
- POST
  Create owner
- GET
  Get all owners
- GET
  Get owner
- PUT
  Update owner
- Accommodationtypes
  - GET
    Get all accommodationtype for a owner
  - GET
    Get all accommodationtypes for owners
- Associations
  - GET
    Get all homeownerassociations
- Communications
  - GET
    Get all communication for a owner
- Credentials
  - PUT
    Update credentials for a owner
- Files
  - GET
    Get all files for a owner
  - GET
    Get specific file for a owner
- Groups
  - GET
    Get all owner groups
- Login
  - POST
    Authenticate owner
- Reservations
  - Details
    - GET
      Get reservation details for a owner
- Settlements
  - Entries
    - GET
      Get all entries for a owner settlement
  - GET
    Get all owner settlements
- Units
Packages
- Items
  - GET
    Get all items for a package
  - GET
    Get all package items
Payment Term Set
- GET
  Get all paymenttermsets
Points Of Interests
- POST
  Create Point of Interest
- GET
  Get all point of interests
- PUT
  Updates a Point of Interest
- Categories
  - GET
    Get all categories for points of interests
Predefined Memo
- GET
  Get all predefined memos
Questionnaire
- Ratings
  - POST
    Create questionnaire ratings
  - GET
    Get all Questionnaire ratings
Rate Types
- GET
  Get all rate types
- Rateoptions
  - GET
    Get all rate options
  - GET
    Get rate option for ratetype
Region
- GET
  Get all regions
- GET
  Get region
Relationships
- GET
  Get all relationships
Rentability
- Config
  - GET
    Get all rentability config
- Sets
  - GET
    Get all rentability sets
- Stays
  - GET
    Gets page with rentabilities
Representation
- DELETE
  Delete representation
- GET
  Get all representations
- GET
  Get representation
- PUT
  Update representation
- Distributionchannels
Resellers
- GET
  Get all resellers
- GET
  Get reseller
- Stopsells
  - GET
    Get all reseller stopsells
Reservability
- GET
  Get all resource reservability
- GET
  Get all unit reservabilities
- Allotment
  - GET
    Get all resource reservability allotment
  - GET
    Get all unit reservability allotments
- Period
  - GET
    Get all unit reservability period
Reservations
- POST
  Creates a new reservation
- POST
  Creates a reservation proposal
- GET
  Get all reservations
- GET
  Get reservation
- PUT
  Update reservation
- Activities
  - Qrcodes
    - POST
      Register activity QR code for a reservation
- Amenities
  - GET
    Get all amenities for a reservation
  - GET
    Get all amenities for reservations
- Bills
  - GET
    Get all bills for a reservation
  - GET
    Get all bills for multiple reservations
  - Snapshots
    - GET
      Get all bill snapshots for a reservation
- Categories
  - GET
    Get all categories for multiple reservations
- Content
  - GET
    Get content for a reservation
  - GET
    Get content for multiple reservations
- Creditcardauthorisations
  - GET
    Get all creditcardauthorisations for a reservation
- Details
  - GET
    Get details for a reservation
  - GET
    Get details for multiple reservations
- Doorlocks
  - GET
    Get all doorlocks for multiple reservation
  - GET
    Get doorlocks for a reservation
- Emergencycontacts
  - POST
    Create emergencycontacts for a reservation
- Energies
  - POST
    Add energy consumption per reservation id.
  - GET
    Get a energy consumption by reservation id.
- Infotexts
  - GET
    Get all infotexts for a reservation
- Instalments
  - GET
    Get all instalments for multiple reservations.
- Journals
  - GET
    Get all journals for a reservation
- Memos
  - POST
    Create memos for a reservation
  - GET
    Get all memos for a reservation
  - GET
    Get all memos for multiple reservations
- Paymentlink
  - GET
    Get paymentlink for a reservation
- Paymentmethods
  - GET
    Get all paymentmethods for a reservation
- Payments
  - POST
    Create payments for a reservation
  - GET
    Get all payments for a reservation
  - GET
    Get all payments for multiple reservations
- Paymenttermsets
  - GET
    Get all paymenttermsets for a reservation
- Preferences
  - GET
    Get all preferences for a reservation
  - GET
    Get all preferences for multiple reservations
- Proposals
  - Additiongroups
    - POST
      create proposal for additiongroups
  - Compare
    - POST
      Creates a reservation proposal comparison
  - POST
    Creates a reserved reservation proposal
- Reminders
  - GET
    Get all reminders for multiple reservations
- Requiredfields
  - GET
    Get all required fields for a customer, payingCustomer and travelParty
- Reservedresources
  - Additions
  - Customfields
    - POST
      Create custom fields for a reservedresource
    - GET
      Get all custom fields for a reservedresource
- Sources
  - Categories
    - GET
      Get all reservation source categories
  - GET
    Get all sources
- Subjects
  - DELETE
    Delete subjects for a reservation
  - GET
    Get all subjects for a reservation
  - GET
    Get all subjects for multiple reservations
  - PUT
    Update subjects for a reservation
  - POST
    create subjects for a reservation
- Termsandconditions
  - GET
    Get all termsandconditions for a reservation
Room Types
- GET
  Get all room types
Rooms
- Amenitylinks
  - GET
    Get all amenity links for a room
  - GET
    Get all amenitylinks for rooms
Send Methods
- GET
  Get all send methods
Subjects
- Categories
  - GET
    Get all subject categories
Suppliers
- Details
  - GET
    Get all supplier details
Units
- POST
  Create unit
- GET
  Get all units
- GET
  Get unit
- PUT
  Update unit
- Allotments
  - GET
    Get all allotments for a unit
- Amenitylinks
- Capacities
  - GET
    Get all capacities for a unit
- Children
  - GET
    Get all children for a unit
- Contracts
  - GET
    Get all contracts for a unit
- Details
  - GET
    Get a unit with details.
  - GET
    Get all units with their details
- Doorlocks
  - Pincodes
    - GET
      Get all doorlock pincodes for a unit
- Doorlocktypes
  - GET
    Get all doorlock types for a unit
- Dynamicfields
  - GET
    Get all dynamic fields for a unit
  - PUT
    Update dynamic field for a unit
- Images
- Implies
  - GET
    Get all implies for a unit
- Locks
- Rooms
  - GET
    Get all rooms for a unit
- Search
  - POST
    Search units
- Workorders
  - GET
    Get all workorders
  - Issues
    - POST
      Creates Workorder

V1 docs (deprecated)

API explorer

Guides

Changelog

Theme switcher

Admin Organisation

A main level to funnel the companies, locations, employees, accounts and other properties that exclusively belongs to that Admin organisation.

Endpoints

POST

/maxxton/v2/adminorganisations

GET

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

PUT

/maxxton/v2/adminorganisations/{adminOrganisationId}

GET

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

POST

/maxxton/v2/adminorganisations/{adminOrganisationId}/exchangerates

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/exchangerates?page=&size=&sort=&filte...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions?page=&size=&sor...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTrans...

PUT

/maxxton/v2/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTrans...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions?page=&size...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFina...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFina...

PUT

/maxxton/v2/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFina...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/revenuedistributions?page=&size=&sort...

GET

/maxxton/v2/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistribu...

PUT

/maxxton/v2/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistribu...