Streamline Hotel Data and Operations with apaleo's No-Code Integration
When it comes to managing a hotel, having a reliable system in place is essential. This is where apaleo comes in – a cloud-based hotel management system designed to streamline operations, enhance guest experience, and optimize efficiency. With apaleo’s user-friendly interface, managing reservations, check-in and check-out, housekeeping, invoicing, and reporting becomes a breeze, allowing staff to focus on more important tasks. One of the most common use cases for apaleo is its ability to integrate with third-party applications and services through its open API. This means hotels can easily connect with payment gateways, channel managers, and revenue management tools, all without the need for code. By synchronizing data across their toolset using a platform like boost.space, hotels can take this integration to the next level, increasing efficiency and reducing costs in the process. By automating tasks, providing real-time data, and allowing for easy integration with other applications, apaleo and boost.space work together to create a seamless hotel management experience. So if you’re looking to streamline your hotel’s operations, enhance guest experience, and optimize efficiency, consider implementing apaleo and boost.space into your toolset today.
Join more than 15,000+ teams across the world
Loved by hundreds companies and freelancers around the world.
4.9 star avg. rating based on 700+ reviews on
Connection status - Active
This application does not need additional settings. So you can make connection only by using your login credentials or by following the instructions in our documentation.
apaleo Modules (234)
Centralise apaleo data now
Get a head start with our apaleo integration templates or create your own
Watch apaleo Events
Runs when an event occurs in your apaleo account.
Watch Blocks (deprecated)
Events coming in for blocks. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Bookings (deprecated)
Events coming in for bookings. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch City Taxes (deprecated)
Events coming in for city taxes. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Companies (deprecated)
Events coming in for companies. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Folios (deprecated)
Events coming in for folios. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Groups (deprecated)
Events coming in for groups. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Invoices (deprecated)
Events coming in for invoices. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Maintenances (deprecated)
Events coming in for maintenances. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Night Audits (deprecated)
Events coming in for night audits. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Properties (deprecated)
Events coming in for properties. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Rate Plans (deprecated)
Events coming in for rate plans. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Reservations (deprecated)
Events coming in for reservations. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Services (deprecated)
Events coming in for services. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Units (deprecated)
Events coming in for units. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Watch Unit Groups (deprecated)
Events coming in for unit groups. Going to be deprecated on March 15, 2023, Please use "Watch apaleo Events" instead.
Add City Tax Reservation
Use this if you want to add the city tax to a reservation. You must have this scope: 'reservations.manage'.
Amend Block
Use this call to modify a block. You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Amend Reservation
Modifies the stay-related data of a reservation. If a reservation is 'Confirmed', you can change all fields. If a reservation is 'InHouse', only changes to future time slices are possible. Changes to reservations that are in the status 'CheckedOut' or 'Canceled' are not possible at all. You must have this scope: 'reservations.manage'.
Assign Specific Unit Reservation
Assigns a specific unit to a reservation which is in state 'Confirmed' or 'InHouse'. If the unit is not available, the call will return an error, and no unit will be assigned. You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'.
Assign Unit Reservation
Assigns one of the available units to a reservation which is in state 'Confirmed' or 'InHouse'. You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'.
Book Service Reservation
Use this to book a service for a specific reservation. Please note that when dates are specified, all desired dates must be specified or they will be removed if not posted to the folio. You must have this scope: 'reservations.manage'.
Move Charges For Multiple Folios
If one of the folios is closed, this action cannot be performed. If any of the specified charges does not exist, this action cannot be performed. Moving negative charges to a house folio is not supported. Create additional folios instead, and move the charges there. You must have this scope: 'folios.manage'.
Cancel Block
Cancel a specific block which is in status 'Definite' or 'Tentative'. This changes the status to 'Canceled'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Cancel Invoice
For regular invoices and AR invoices that haven't been paid yet, creates a new cancellation invoice and opens the folio again. For advance invoices, creates a new cancellation invoice. You must have this scope: 'invoices.manage'.
Cancel Payment
Sets a payment to cancelled and triggers the cancellation. You must have this scope: 'folios.manage'.
Cancel Reservation
Cancel a specific reservation which is in status 'Confirmed' and where the arrival time is in the future. This changes the status to 'Canceled', and sets the cancellation date and time. You must have this scope: 'reservations.manage'.
Checkin Reservation
Check in a specific reservation which is in status 'Confirmed', and has a unit assigned. This changes the status to 'InHouse', and sets the check-in date and time. You must have this scope: 'reservations.manage'.
Checkout Reservation
Check out a specific reservation which is in status 'InHouse'. This changes the status to 'CheckedOut', and sets the check-out date and time. All open charges on the folio will be posted. Check-out is only possible, if the departure date is not later than tomorrow. Otherwise, first amend the reservation and shorten the stay. You must have this scope: 'reservations.manage'.
Close Folio
Mark a folio as closed to prevent adding charges and payments. This action cannot be undone, and is only possible if the balance is 0. Requires 'allowed action': Close. You must have this scope: 'folios.manage'.
Confirm Block
Confirm a specific block which is in status 'Tentative'. This changes the status to 'Definite'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Correct Folio
Allowance value posted must not exceed sum of charges minus existing allowances You must have this scope: 'folios.manage'.
Create Accounting Report Aggregate
Returns credited and debited amounts aggregated by transactions' timestamp for all accounts and a given period. Stores an entry in the export audit log. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Create Accounting Report Aggregate Daily
Returns credited and debited amounts aggregated by transactions' date (business day) for all accounts and a given period. Stores an entry in the export audit log. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Create Accounting Report Aggregate Pairs Daily
Returns total amount credited from one account to another You must have at least one of these scopes: 'subledger.read, accounting.read'.
Create Accounting Report Export
Returns the raw transaction data for a given property and time period. Stores an entry in the export audit log. You must have at least one of these scopes: 'transactions.export, accounting.read'.
Create Accounting Report Export Daily
Returns the raw transaction data for a given property and time period. Stores an entry in the export audit log. You must have at least one of these scopes: 'transactions.export, accounting.read'.
Create Accounting Report Export Gross Daily
Returns the raw transaction data for a given property and time period. Stores an entry in the export audit log. You must have at least one of these scopes: 'transactions.export, accounting.read'.
Create Age Category
Use this call to create a new age category. The age ranges for categories must not overlap each other and the allowed values span from 0 to 17. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Create Allowance Folio
Allowance value posted must not exceed sum of charges minus existing allowances You must have at least one of these scopes: 'allowances.post, folios.manage'.
Create Block
You must have at least one of these scopes: 'blocks.create, reservations.manage'.
Create Booking
Creates a booking taking a list of reservations as input You must have at least one of these scopes: 'reservations.create, reservations.manage'.
Create Booking Reservation
Creates new reservations and adds them to an existing booking taking a list of reservations as input You must have at least one of these scopes: 'reservations.create, reservations.manage'.
Create Bulk Allowances Folio
Allowance value posted must not exceed sum of charges minus existing allowances You must have at least one of these scopes: 'allowances.post, folios.manage'.
Create Cancellation Fee Folio
Adds a cancellation fee, and directly posts it. Cancellation fees can only be posted on guest folios. Requires 'allowed action': AddCancellationFee. You must have at least one of these scopes: 'charges.create, folios.manage'.
Create Cancellation Policy
Create a cancellation policy. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Create Charge Allowance Folio
Allowance value posted must not exceed source charge minus allowances posted for this charge You must have at least one of these scopes: 'allowances.post, folios.manage'.
Create Charge Folio
Adds a charge for any good or service, and directly posts it. Can be used to charge items that are not part of the reservation, but should appear on the invoice. Requires 'allowed action': AddCharge. You must have at least one of these scopes: 'charges.create, folios.manage'.
Create City Tax
You can only create one city tax per property. It can be changed and deleted any time. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Create Company
Use this call to create a new company. You must have at least one of these scopes: 'companies.create, companies.manage'.
Create Folio
Use this call to create a new folio. You must have at least one of these scopes: 'reservations.create, reservations.manage, folios.manage'.
Create Group
You must have at least one of these scopes: 'groups.create, reservations.manage'.
Create Group Reservation
Creates new reservations and adds them to an existing group booking taking a list of reservations as input You must have at least one of these scopes: 'groups.manage, reservations.manage'.
Create Invoice
Creates an invoice for one specific folio. The invoice can only be created once. The debitor needs to have name, city, postal code and country code, as these are required for invoices. If the folio is not fully paid, this will check out the reservation on AR and create an invoice with outstanding payments. You must have at least one of these scopes: 'invoices.create, invoices.manage'.
Create Maintenance
Use this call to create a new maintenance window for the given unit. You can only create maintenances for today and days in the future. You must have at least one of these scopes: 'maintenances.create, maintenances.manage'.
Create Multiple Maintenances
Use this call to create multiple maintenances. You must have at least one of these scopes: 'maintenances.create, setup.manage'.
Create No Show Fee Folio
Adds a no-show fee, and directly posts it. No-show fees can only be posted on guest folios. Requires 'allowed action': AddNoShowFee. You must have at least one of these scopes: 'charges.create, folios.manage'.
Create No Show Policy
Create a no-show policy. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Create Payment
A custom payment will not involve any automatic processing. This is best to be used for cash, cheque or voucher payments or payments that have been processed by an external system and it should just be recorded in apaleo for accounting purposes. You must have this scope: 'folios.manage'.
Create Payment By Authorization
Captures a specific amount from a pre-authorization and posts it to the folio. For the pre-authorization please ensure to set the respective metadata in the original payment transaction. The flow type has to be set to <i>CaptureOnly</i>. For more information please refer to the documentation of <a href="https://apaleo.dev/guides/business-cases/ibe/getting-the-money" target="_blank">how to do a pre-authorization on a booking engine</a>. The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as a payment is pending it reduces the amount of allowed payments for the folio. The payment times out after 60 minutes automatically You must have this scope: 'folios.manage'.
Create Payment By Link
Creates a link to a payment form where guests can pay. To enable open invoice payment methods you need to provide at least the paid charges with the request. For some open invoice payment methods you also need to ensure that the full billing address of the folio is set, before you create the payment link. The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as a payment is pending it reduces the amount of allowed payments for the folio. You must have this scope: 'folios.manage'.
Create Payment By Payment Account
Trigger a payment for the folio using the payment account stored on the reservation. The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as a payment is pending it reduces the amount of allowed payments for the folio. The payment times out after 60 minutes automatically You must have this scope: 'folios.manage'.
Create Payment By Terminal
Trigger a terminal payment for the folio. The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as a payment is pending it reduces the amount of allowed payments for the folio. The payment times out after 60 minutes automatically You must have this scope: 'folios.manage'.
Create Payment Refund
Trigger a refund for a specific payment on this folio. The refund will be processed asynchronously. Use the location header to poll for the status of the refund. As long as a refund is pending the allowed refund amount for this payment will be reduced by the amount. The refund times out after 10 minutes automatically You must have this scope: 'folios.manage'.
Create Property
Use this call to create a new property. You must have at least one of these scopes: 'properties.create, setup.manage'.
Create Rate Plan
Use this call to create a new rate plan. The rate plan will already contain empty rates, fill them later using PUT rates. You must have at least one of these scopes: 'rateplans.create, setup.manage'.
Create Refund
Trigger a generic refund for the folio. The refund will be processed asynchronously. Use the location header to poll for the status of the refund. As long as a refund is pending it reduces the amount of allowed refunds for the folio. The refund times out after 60 minutes automatically You must have this scope: 'folios.manage'.
Create Service
Create a service. You must have at least one of these scopes: 'services.create, setup.manage'.
Create Sub Account
Create a sub-account. You must have at least one of these scopes: 'subledger.manage, setup.manage'.
Create Time Slice Definition
Use this call to create a time slice definition. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Create Transitory Charge Folio
Adds a transitory item for any good or service, and directly posts it. To be used for sales that are not revenue of the property, but should appear on te guest's invoice. Requires 'allowed action': AddCharge. You must have at least one of these scopes: 'charges.create, folios.manage'.
Create Unit
Use this call to create a new unit. You must have at least one of these scopes: 'units.create, setup.manage'.
Create Unit Attribute
Use this call to create a new unit attribute. You must have at least one of these scopes: 'unitattributes.create, setup.manage'.
Create Unit Group
Use this call to create a new unit group. You must have at least one of these scopes: 'unitgroups.create, setup.manage'.
Create Multiple Units
Use this call to create multiple units, following a naming rule. You must have at least one of these scopes: 'units.create, setup.manage'.
Delete Age Category
Use this call to delete an age category. You can only delete an age category if it is not already used in a rate plan to define age specific prices. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Delete Block
Use this call to delete a block. This is only possible as long as no reservation was picked up yet even if all of them are canceled You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Delete Cancellation Policy
Use this call to delete a cancellation policy. You must have this scope: 'setup.manage'.
Delete City Tax
Use this call to delete a city tax. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Delete Company
Deletes a company. Warning: This operation also removes company from all rate plans if not yet used. The deleted company won't be available in the company VAT report anymore. You must have this scope: 'companies.manage'.
Delete Folio
Deletes a folio. This cannot be undone. You can delete a folio only if it's not a main folio, and the folio is empty (it has no charges, allowance, payments or pending payments). Requires 'allowed action': Delete. You must have this scope: 'folios.manage'.
Delete Group
Use this call to delete a group booking. This is only possible as long as no blocks exist that are linked to this group booking You must have at least one of these scopes: 'groups.manage, reservations.manage'.
Delete Maintenance
Use this call to delete a maintenance. It is not possible to delete maintenances that started yesterday or earlier. You must have at least one of these scopes: 'maintenances.delete, maintenances.manage'.
Delete No Show Policy
Use this call to delete a no-show policy. You must have this scope: 'setup.manage'.
Delete Rate Plan
Use this call to delete a rate plan. You must have at least one of these scopes: 'rateplans.delete, setup.manage'.
Delete Multiple Rate Plans
Use this call to delete multiple rate plans. You must have at least one of these scopes: 'rateplans.delete, setup.manage'.
Delete Rates
Deletes all rates in the specifed time range. You must have at least one of these scopes: 'rates.delete, rates.manage'.
Delete Service
Use this call to delete a service. You must have at least one of these scopes: 'services.create, setup.manage'.
Delete Service For Reservation
Removes a service from a reservation. The service will not be removed if it is mandatory, already posted or if the service date is in the past. You must have this scope: 'reservations.manage'.
Delete Sub Account
Use this call to delete a custom sub-accounts. When you delete a custom sub-account, the corresponding accounting accounts are either archived (if there are some transactions posted), or deleted (if no transactions were posted). You must have at least one of these scopes: 'subledger.manage, setup.manage'.
Delete Time Slice Definition
Use this call to delete a time slice definition. This is only possible if a time slice definition is not in-use You must have at least one of these scopes: 'settings.manage, setup.manage'.
Delete Unit
Use this call to delete a unit. You must have at least one of these scopes: 'units.delete, setup.manage'.
Delete Unit Attribute
Deletes unit attribute You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
Delete Unit Group
Use this call to delete a unit group. You must have at least one of these scopes: 'unitgroups.delete, setup.manage'.
Download PDF Invoice
Gets an invoice PDF file by its ID. Only works for invoices that have already been created using POST /invoices. You must have this scope: 'invoices.read'.
Download PDF Invoice Preview
Gets a preview invoice PDF for one specific folio. You must have this scope: 'invoices.read'.
Force Amend Reservation
Modifies the stay-related data of a reservation. If a reservation is 'Confirmed', you can change all fields. If a reservation is 'InHouse', only changes to future time slices are possible. Changes to reservations that are in the status 'CheckedOut' or 'Canceled' are not possible at all. You must have this scope: 'reservations.force-manage'.
Force Book Service Reservation
Use this to book a service for a specific reservation. Please note that when dates are specified, all desired dates must be specified or they will be removed if not posted to the folio. You must have this scope: 'reservations.manage'.
Force Create Booking
Creates a booking taking a list of reservations as input You must have at least one of these scopes: 'reservations.force-create, reservations.force-manage'.
Force Create Booking Reservation
Creates new reservations and adds them to an existing booking taking a list of reservations as input You must have at least one of these scopes: 'reservations.force-create, reservations.force-manage'.
Make an API Call
Performs an arbitrary authorized API call.
Move All Charges Folio
If one of the folios is closed, this action cannot be performed. Only charges that can be moved will be moved. You must have at least one of these scopes: 'charges.move, folios.manage'.
Move Charges Folio
If one of the folios is closed, this action cannot be performed. If any of the specified charges does not exist, this action cannot be performed. Moving negative charges to a house folio is not supported. Create additional folios instead, and move the charges there. You must have at least one of these scopes: 'charges.move, folios.manage'.
Move Payments Folio
Move payments from one folio of a reservation to another - moving between different reservations is not supported, and will lead to an error. If one of the folios is closed, this action cannot be performed. The PSP reference, if present, will be removed when moving and only be persisted on the original payment. You must have at least one of these scopes: 'charges.move, folios.manage'.
Set Reservation to No Show
Set a specific reservation to No-show which is in status 'Confirmed' and where the arrival date is in the past. This changes the status to 'NoShow', and sets the no-show date and time. You must have this scope: 'reservations.manage'.
Patch Age Category
Here is the list of operations that are currently allowed: - Replace name, minimum age and maximum age You must have at least one of these scopes: 'settings.manage, setup.manage'.
Patch Block
You can replace From, To, GrossDailyRate and BlockedUnits You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Patch Booking
Here is the list of operations that are currently allowed: - Add, replace and remove PaymentAccount - Add, replace and remove Comment - Add, replace and remove BookerComment - Copy PaymentAccount, Comment and BookerComment from the booking to any reservation, or the other way around - Replace Booker You must have this scope: 'reservations.manage'.
Patch Cancellation Policy
Here is the list of operations that are currently allowed: - Replace name and description - Replace the period from reference - Replace the reference - Replace the fee details: fixed and percent values You must have at least one of these scopes: 'settings.manage, setup.manage'.
Patch Capture Policy
Here is the list of operations that are currently allowed: - Replace captureNoShowFee flag - Replace captureCancellationFee flag - Replace capturePrepayment flag - Replace PostOtaBankTransferOnCheckOut flag - Replace capturePayment configuration You must have at least one of these scopes: 'settings.manage, setup.manage'.
Patch City Tax
Here is the list of operations that are currently allowed: - Replace name and description - Replace value and type - Replace or delete the VAT type You must have at least one of these scopes: 'settings.manage, setup.manage'.
Patch Company
Here is the list of operations that are currently allowed: - Replace name, address, tax ID - Add and remove rate plans You must have this scope: 'companies.manage'.
Patch Folio
Here is the list of operations that are currently allowed: - Replace debitor (for guest folios only) - Add a company (not for house folios) - Replace/remove a company (not for house folios) You must have this scope: 'folios.manage'.
Patch Group
Here is the list of operations that are currently allowed: - Add and replace Name - Add, replace and remove Comment - Add, replace and remove BookerComment - Add, replace and remove PaymentAccount - Add, replace and remove PropertyIds - Replace Booker You must have at least one of these scopes: 'groups.manage, reservations.manage'.
Patch Invoice Address
Here is the list of operations that are currently allowed: - Replace AddressLine1 - Add, replace or delete AddressLine2 - Replace PostalCode - Replace City - Replace CountryCode You must have at least one of these scopes: 'setup.manage, settings.manage'.
Patch Maintenance
You can only change maintenances which are in the future or still ongoing today. Here is the list of operations that are currently allowed: - Add, replace and remove Description - Replace From and To. 'From' cannot be changed, if the maintenance started yesterday or before. You must have this scope: 'maintenances.manage'.
Patch No Show Policy
Here is the list of operations that are currently allowed: - Replace name and description - Replace the fee details: fixed and percent values You must have at least one of these scopes: 'settings.manage, setup.manage'.
Patch Property
Here's a list of allowed operations: - Replace Name - Add, replace and remove Description - Replace CompanyName - Add, replace and remove ManagingDirectors - Replace CommercialRegisterEntry - Replace TaxId - Replace Location - Add, replace and remove BankAccount - Replace PaymentTerms - Set IsTemplate You must have at least one of these scopes: 'properties.manage, setup.manage'.
Patch multiple Rate Plans
Here is the list of operations that are currently allowed: - Replace Name - Replace Description - Replace MinGuaranteeType - Replace PriceCalculationMode - Replace CancellationPolicy - Replace NoShowPolicy - Replace ChannelCodes - Replace Companies - Add, replace and remove PromoCode - Add, replace and remove Restrictions - Add, replace and remove BookingPeriods - Add, replace and remove IsSubjectToCityTax - Add, replace and remove PricingRule - Add, replace and remove Surcharges - Add, replace and remove AgeCategories - Add, replace and remove IncludedServices - Add/Replace/Remove/Update AccountingConfigs You must have at least one of these scopes: 'rateplans.manage, setup.manage'.
Patch Rates
Note that the specified PATCH operations are applied to each and every rate for the specified time range. Here is the list of operations that are currently allowed: - Add, replace and remove Price - Add, replace and remove Restrictions You must have this scope: 'rates.manage'.
Patch Reservation
Here is the list of operations that are currently allowed: - Add, replace and remove Comment - Add, replace and remove GuestComment - Add, replace and remove PaymentAccount - Add, replace and remove TravelPurpose - Add, replace and remove AdditionalGuests - Add a company (using company/Id, and only if not already set) - Add, replace and remove Commission - Replace PrimaryGuest - Remove ValidationMessages You must have this scope: 'reservations.manage'.
Patch Service
Here is the list of operations that are currently allowed: - Replace Name - Replace Description - Replace DefaultGrossPrice - Replace PricingUnit - Replace PostNextDay - Replace Availability - Add/Replace/Remove/Update AccountingConfigs - Replace ChannelCodes You must have at least one of these scopes: 'services.manage, setup.manage'.
Patch Sub Account
Allows to modify the name of the sub-account. You must have at least one of these scopes: 'subledger.manage, setup.manage'.
Patch Time Slice Definition
Use this call to modify a time slice definition of the property. Here is the list of operations that are currently allowed: - Replace Name - Replace CheckInTime (only possible if the time slice definition is not in-use) - Replace CheckOutTime (only possible if the time slice definition is not in-use) You must have at least one of these scopes: 'settings.manage, setup.manage'.
Patch Unit
Here's a list of allowed operations: - Set unit condition - Set unit description - Set unit name - Set unit unitGroupId - Set unit maxPersons - Add unit attribute - Remove unit attribute You must have at least one of these scopes: 'units.manage, setup.manage'.
Patch Unit Attribute
Here's a list of allowed operations: - Replace / Remove Description You must have at least one of these scopes: 'unitattributes.manage, setup.manage'.
Patch Unit Group Availability
You can replace AllowedOverbooking for a unit group You must have this scope: 'availability.manage'.
Patch multiple units
Here's a list of allowed operations: - Set unit condition - Set unit description - Set unit name - Set unit unitGroupId - Set unit maxPersons - Add unit attribute - Remove unit attribute You must have at least one of these scopes: 'units.manage, setup.manage'.
Pay Invoice
Settles the invoice, if the invoice has an amount to be paid (total != 0). You must have this scope: 'invoices.manage'.
Post Charges Folio
Use this call for cases when the folio should be closed early. For example, when a guest wants to get the invoice right after the check-in As posting charges before the service is delivered is potentially risky, this operation will fail if there are any unposted charges further in the future than 7 days. Posting open charges is only possible for fully prepaid folios. Requires 'allowed action': PostOpenCharges. You must have this scope: 'folios.manage'.
Read Account
Returns one account, as specified by its number and the property. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Read Age Category
Get an age category by id. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Arrival Report
Returns number of arriving guests for a property for a certain month. Only over-night rateplans are considered. Includes statistical information on purpose of travel, and nationality. The data is taken from the primary guest only. The status considered are: in-house, confirmed, and checked out. You must have this scope: 'reports.read'.
Read Block
Retrieves a block, specified by its ID. You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.
Read Booking
Retrieves a booking with all its reservations. You must have at least one of these scopes: 'reservations.read, reservations.manage'.
Read Cancellation Policy
Get a specific cancellation policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Capture Policy
Get a specific capture policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read City Tax
Get a specific city tax. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Company
Get a company by ID. You must have at least one of these scopes: 'companies.read, companies.manage'.
Read Current Account
Retrieves information about the current account. You need to be authorized (no particular scope required)
Read Folio
Get a folio by ID. You must have at least one of these scopes: 'folios.read, folios.manage'.
Read Group
Retrieves a specific group booking with all its related blocks You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'.
Read Invoice
Gets invoice data by its ID. Only works for invoices that have already been created using POST /invoices. You must have this scope: 'invoices.read'.
Read Invoice Preview
To see if the invoice creation would be successful, check the warnings. You must have this scope: 'invoices.read'.
Read Languages
Get the language settings You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Maintenance
Get a specific maintenance by ID. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'.
Read No Show Policy
Get a specific no-show policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Payment
Get a payment by its ID You must have at least one of these scopes: 'folios.read, folios.manage'.
Read Property
Get a property by id. You need to be authorized (no particular scope required)
Read Property Settings
Get base settings for a property. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Rate Plan
Get a rate plan by id. To be able to read a corporate rate plan a client must additionaly have 'rateplans.read-corporate' scope assigned. You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.
Read Refund
Get a refund by its ID You must have at least one of these scopes: 'folios.read, folios.manage'.
Read Reservation
Retrieves a reservation, specified by its ID. You must have at least one of these scopes: 'reservations.read, reservations.manage'.
Read Revenue Report
You must have this scope: 'reports.read'.
Read Schema
Returns the schema of subledger, split into global and guest ledger. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Read Service
Get a specific service. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.
Read Sub Account
Get a sub-account by ID. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'.
Read Time Slice Definition
Get a specific time slice definition for a property. A time slice definition specifies the pattern for recurring time slots. The time slots define when reservations in the property can start or end. It is used in the rate plans when managing prices for renting out the units. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Read Unit
Get a unit by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Read Unit Attribute
Get unit attribute by id You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Read Unit Group
Get a unit group by id. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Release Block
Release a specific block which is in status 'Definite'. This changes the status to 'Tentative'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Remove City Tax Reservation
Use this is you want to remove the city tax from a reservation before the stay. You must have this scope: 'reservations.manage'.
Reopen Folio
Reopens a closed folio. You can only reopen a folio if no invoice has been created for the folio. Otherwise, use `invoice-actions/{invoiceId}/cancel` endpoint to cancel an invoice and reopen the folio. Requires 'allowed action': Reopen. You must have this scope: 'folios.manage'.
Set Live Current Account
Move the current account to live. This changes the account type to 'Live'. You must have this scope: 'account.manage'.
Splt Charge Folio
You must have at least one of these scopes: 'allowances.post, charges.create, folios.manage'.
Splt Payment Folio
You must have at least one of these scopes: 'payments.create, refunds.create, folios.manage'.
Suspend Current Account
Suspends the current account. This changes the account type to 'Suspended'. You must have this scope: 'account.manage'.
Unassign Units Reservation
Unassigns units for all time slices of the given reservation. If no units are assigned for the reservation nothing will happen. It will fail for reservations in status 'CheckedOut'. You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'.
Update Current Account
Completely replaces an account with the new definition passed in. The old data will be lost. You must have this scope: 'account.manage'.
Update Invoice Address
If the address does not exist for one of the specified properties, it is created. If it exists, it is completely replaced. You must have at least one of these scopes: 'setup.manage, settings.manage'.
Update Languages
Use this call to modify the language settings of the account. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Update Night Audit
The night audit will post all charges for services that were delivered on the past business day in the folio and set all occupied rooms to 'Dirty' You must have at least one of these scopes: 'operations.manage, operations.trigger-night-audit'.
Update Rate Plan
Use this call to modify a rate plan. You must have at least one of these scopes: 'rateplans.manage, setup.manage'.
Update Rates
All rates specified in the request will be initialized, or overwritten if they already exist. Make sure that the from and to date and time in the rates match the time slice definition of the rate plan. The easiest way to achieve this is calling the GET /rate-plans/{id}/rates for the time range you want to update and then resend the payload with the set prices and restrictions. You must have this scope: 'rates.manage'.
Update Unit Group
Use this call to modify a unit group. You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.
Update Units Condition
You must have this scope: 'operations.change-room-state'.
Wash Block
Wash a specific block which is in status 'Definite'. This releases all unpicked units. You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Read Offer Index
Calculates and returns offers per time slice for a specific rate plan, arrival and departure date. You must have at least one of these scopes: 'offer-index.read, offers.read'.
Search Age Categories
Get the list of age categories. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Search Blocks
Returns a list of all blocks, filtered by the specified parameters. If no parameters are set, returns the entire list. You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.
Search Bookings
Returns a list of all bookings, filtered by the specified parameters. If no parameters are set, returns the entire list. You must have at least one of these scopes: 'reservations.read, reservations.manage'.
Search Cancellation Policies
Get the list of cancellation policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Search Capture Policies
Get the list of capture policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Search Child Accounts
You must have at least one of these scopes: 'subledger.read, accounting.read'.
Search City Tax
Get the list of all city taxes. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Search Companies
Get the list of companies. You must have at least one of these scopes: 'companies.read, companies.manage'.
Search Company Invoices Vat Report
You must have this scope: 'reports.read'.
Search Corporate Codes
Returns all existing corporate codes that match given criteria. You must have this scope: 'rateplans.read-corporate'.
Search Countries
Returns a list of ISO country codes that could be used to create properties. You need to be authorized (no particular scope required)
Search Currencies
Returns a list of all currencies.
Search External Accounts
Returns a list of accounts in one property for a folio. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Search Folio Logs
You must have this scope: 'logs.read'.
Search Folios
Allowed actions are only returned, when the list is filtered by reservation ID. You must have at least one of these scopes: 'folios.read, folios.manage'.
Search Global Accounts
Returns a list of accounts in one property, having the same global account as parent. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Search Groups
Returns a list of all group bookings, filtered by the specified parameters. If no parameters are set, returns the entire list You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'.
Search Guest Accounts
Returns a list of accounts in one property for a reservation. You must have at least one of these scopes: 'subledger.read, accounting.read'.
Search Invoice Address
Get the list of all invoice addresses. You must have at least one of these scopes: 'setup.read, setup.manage, settings.read, settings.manage'.
Search Invoices
Gets the list of all invoices (the metadata only, not the files). You must have this scope: 'invoices.read'.
Search Maintenances
Get a list of maintenances matching your filter. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'.
Search Night Audit Logs
Returns a log of all night audits Newest log entries are returned first. You must have this scope: 'logs.read'.
Search No Show Policies
Get the list of no-show policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Search Offers
Calculates and returns available offers for a specific property, arrival and departure date. You must have at least one of these scopes: 'offers.read, reservations.manage'.
Search Offers For Reservation
Calculates and returns offers for amending a specific reservation. You must have at least one of these scopes: 'offers.read, reservations.manage'.
Search Ordered Services Report
Returns a list of ordered services per day with information about the guest and the reservation this service was ordered for. You must have this scope: 'reports.read'.
Search Payment Methods
Returns a list of all supported payment methods.
Search Payments
Returns a list of all payments for this folio ordered by creation date, newest first You must have at least one of these scopes: 'folios.read, folios.manage'.
Search Promo Codes
Returns all existing promo codes that match given criteria. You must have this scope: 'rateplans.read-corporate'.
Search Properties
Get the list of properties. You need to be authorized (no particular scope required)
Search Property Performance Report
The property performance API return you key performance indicator for the selected property like occupancy, ADR and RevPAR. It only considers the originally booked amounts for sold units excluding any additional services or manually posted charges or allowances. The results can be filterd to only show you data for a certain part of the business. For example you can exclude day-use reservations or complimentary rate plans. You must have this scope: 'reports.read'.
Search Rateplan Codes [DEPRECATED]
Returns all existing rate plan codes that match given criteria. You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.
Search Rate Plan Offers
Calculates and returns available offers for a specific rate plan, arrival and departure date. You must have at least one of these scopes: 'offers.read, reservations.manage'.
Search Rate Plans
Get the list of rate plans depending on client scopes. If a client has no additional scopes, only public rate plans are returned. The 'rateplans.read-corporate' scope adds corporate rate plans to the response. You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.
Search Rates
Returns all rates for a specific rate plan within the specified time range. If a rate has not been initialized, it will still be returned, but anything besides the from and to values will be empty. The time range of a rate is defined by the time slice definition of the rate plan. Time ranges with no initialized rates will not be available for sell. To be able to read rates for a corporate rate plan a client must additionally have the 'rateplans.read-corporate' scope. You must have at least one of these scopes: 'rates.read, rates.manage'.
Search Refunds
Returns a list of all refunds for this folio ordered by creation date, newest first You must have at least one of these scopes: 'folios.read, folios.manage'.
Search Reservation Logs
You must have this scope: 'logs.read'.
Search Reservations
Returns a list of all reservations, filtered by the specified parameters. If no parameters are set, returns the entire list. You must have at least one of these scopes: 'reservations.read, reservations.manage'.
Search Service Availability
Get the list of available services for a specific property and time period. You must have this scope: 'availability.read'.
Search Service Offers
You must have at least one of these scopes: 'offers.read, reservations.manage'.
Search Service Offers For Reservation
Calculates and returns service offers for a specific reservation. You must have at least one of these scopes: 'offers.read, reservations.manage'.
Search Services
Get the list of services. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.
Search Services For Reservation
Returns the services booked for a specific reservation. You must have at least one of these scopes: 'reservations.read, reservations.manage'.
Search Service Types
Returns a list of all supported service types.
Search Sources
Returns a list of channels that could be used as a source to create bookings.
Search Sub Accounts
Returns a list of all sub-accounts. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'.
Search Time Slice Definitions
Get all time slice definitions for a property. A time slice definition specifies the pattern for recurring time slots. The time slots define when reservations in the property can start or end. They are used in the rate plans when managing prices for renting out the units. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Search Transactions Export Logs
Returns the audit log for all exports if accounting data that have been done. You must have this scope: 'logs.read'.
Search Unit Attributes
Get unit attribute list You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Search Unit Availability
Get the list of available units for a specific property and time period. You must have this scope: 'availability.read'.
Search Unit Availability For Reservation
Get the list of available units for a specific reservation and time period. You must have at least one of these scopes: 'availability.read, reservations.manage'.
Search Unit Group Availability
Get the list of available unit groups for a specific property and time period. You must have this scope: 'availability.read'.
Search Unit Groups
Get the list of unit groups. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Search Units
Get the list of units. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Search Vat
Returns a list of all VAT types and percents for a country. Supported: - Belgium (BE) - Botswana (BW) - Cape Verde (CV) - Croatia (HR) - Czech Republic (CZ) - Denmark (DK) - Finland (FI) - France (FR) - without the super-reduced 2.1% VAT - French Polynesia (PF) - Germany (DE) - Morocco (MA) - Netherlands (NL) - Norway (NO) - without the VAT for raw fish supplies - Spain (ES) - South Africa (ZA) - Sweden (SE) - Switzerland (CH) - United Kingdom (GB)
Join more than 15,000+ teams across the world
