apaleo Make integrationAutomate apaleo with Make.
Can Make take the repetitive desk work out of your apaleo property? Yes: the apaleo Make integration offers 218 modules, with 1 instant trigger, 162 actions and 55 searches. This guide is for hotel ops and revenue teams, from connection to a first working scenario.
Verified Trustpilot reviews · AI, automation & growth agency
What can the apaleo Make integration do for your hotel?
The apaleo Make integration links your apaleo property management system to Make, a no-code tool where you build a scenario: an automation made of modules, each one a brick that watches, creates or searches something. An apaleo event can start the scenario, and the actions that follow handle reservations, folios, invoices and property setup.
Corporate clients ready before they arrive. When a sales rep closes a deal in your CRM, Create Company adds the firm to apaleo, Create Group opens the group booking, and Create Group Reservation fills it with the rooms the client asked for.
Extras on the right bill. A spa treatment or a parking pass sold through another tool reaches the guest folio with Create Charge Folio, and Create Invoice turns the settled folio into an invoice when the stay is over.
Accounting data without the manual export. Create Accounting Report Export pulls the raw transactions of a property for the period you pick, and the next module can pass them to a spreadsheet or to your accounting software.
What Make will not do for you here: the apaleo doc gives no numeric limit, but every module needs the right scope on the app you register in apaleo, and a few actions, Close Folio among them, cannot be reversed. For anything the 218 modules miss, Make an API Call reaches the rest of the apaleo API with the same connection.
New to the editor? The Make training starts from zero, Make pricing explains how operations are counted, and n8n vs Make helps if you are still choosing a tool.
How do you connect apaleo to Make?
- 01
Register an app in apaleo
Sign in to your apaleo developer account, open Apps then My store apps, and click + Add a new app. Complete the form, click Save, then copy the Client ID and Client Secret and keep them somewhere safe.
- 02
Open the connection in Make
Add an apaleo module to your scenario and click Create a connection. A connection is your apaleo account linked to Make once and reused by every apaleo module. With Watch apaleo Events, click Create a webhook first.
- 03
Paste the keys and save
Name the connection in Connection name if you like, paste the two values into Client ID and Client Secret, and click Save. If apaleo asks, sign in and confirm access.
Your first apaleo scenario in Make
GoalWhen a new corporate client is added in your CRM, Make creates the matching company in apaleo.
- 01
Create the scenario
On the Scenarios page, create a new scenario and click the +. Pick your CRM as the first module: it is the source of the client details.
- 02
Add Create Company
Click the + on the right of the CRM module, search for apaleo and choose Create Company. Click Create a connection and paste the keys from the section above.
- 03
Map the client details
Fill the Create Company fields by mapping the values from the CRM module. Each bundle, one client record moving from module to module, becomes one company in apaleo.
- 04
Test with Run once
Click Run once to execute the scenario a single time, open the bundles each module received, then look for the new company in apaleo.
- 05
Schedule and switch it on
Set the schedule on the first module, every 15 minutes by default, and switch the scenario on. Every module run on a bundle is one operation on your Make plan.
What starts an apaleo scenario?
1 module starts a scenario when something happens in apaleo. A scheduled trigger is checked by Make on the scenario's schedule; an instant one is called by apaleo as soon as it happens.
Watch apaleo Events
Instant triggerIn Make“Runs when an event occurs in your apaleo account.”
Watch apaleo Events starts your scenario when something happens in your apaleo account and passes that event to the next module as a bundle, so the rest of the flow works on fresh data.
What can apaleo do in a Make scenario?
apaleo gives you 217 modules. For each one: what it does for you, when to reach for it, and what to watch out for.
Modules index
- Add City Tax Reservation
- Amend Block
- Amend Reservation
- Assign Specific Unit Reservation
- Assign Unit Reservation
- Book Service Reservation
- Cancel Block
- Cancel Invoice
- Cancel Payment
- Cancel Reservation
- Checkin Reservation
- Checkout Reservation
- Close Folio
- Confirm Block
- Correct Folio
- Create Accounting Report Aggregate
- Create Accounting Report Aggregate Daily
- Create Accounting Report Aggregate Pairs Daily
- Create Accounting Report Export
- Create Accounting Report Export Daily
- Create Accounting Report Export Gross Daily
- Create Age Category
- Create Allowance Folio
- Create Block
- Create Booking
- Create Booking Reservation
- Create Bulk Allowances Folio
- Create Cancellation Fee Folio
- Create Cancellation Policy
- Create Charge Allowance Folio
- Create Charge Folio
- Create City Tax
- Create Company
- Create Folio
- Create Group
- Create Group Reservation
- Create Invoice
- Create Maintenance
- Create Multiple Maintenances
- Create Multiple Units
- Create No Show Fee Folio
- Create No Show Policy
- Create Payment
- Create Payment By Authorization
- Create Payment By Link
- Create Payment By Payment Account
- Create Payment By Terminal
- Create Payment Refund
- Create Property
- Create Rate Plan
- Create Refund
- Create Service
- Create Sub Account
- Create Time Slice Definition
- Create Transitory Charge Folio
- Create Unit
- Create Unit Attribute
- Create Unit Group
- Delete Age Category
- Delete Block
- Delete Cancellation Policy
- Delete City Tax
- Delete Company
- Delete Folio
- Delete Group
- Delete Maintenance
- Delete Multiple Rate Plans
- Delete No Show Policy
- Delete Rate Plan
- Delete Rates
- Delete Service
- Delete Service For Reservation
- Delete Sub Account
- Delete Time Slice Definition
- Delete Unit
- Delete Unit Attribute
- Delete Unit Group
- Download PDF Invoice
- Download PDF Invoice Preview
- Force Amend Reservation
- Force Book Service Reservation
- Force Create Booking
- Force Create Booking Reservation
- Make an API Call
- Move All Charges Folio
- Move Charges Folio
- Move Charges For Multiple Folios
- Move Payments Folio
- Patch Age Category
- Patch Block
- Patch Booking
- Patch Cancellation Policy
- Patch Capture Policy
- Patch City Tax
- Patch Company
- Patch Folio
- Patch Group
- Patch Invoice Address
- Patch Maintenance
- Patch multiple Rate Plans
- Patch multiple units
- Patch No Show Policy
- Patch Property
- Patch Rates
- Patch Reservation
- Patch Service
- Patch Sub Account
- Patch Time Slice Definition
- Patch Unit
- Patch Unit Attribute
- Patch Unit Group Availability
- Pay Invoice
- Post Charges Folio
- Read Account
- Read Age Category
- Read Arrival Report
- Read Block
- Read Booking
- Read Cancellation Policy
- Read Capture Policy
- Read City Tax
- Read Company
- Read Current Account
- Read Folio
- Read Group
- Read Invoice
- Read Invoice Preview
- Read Languages
- Read Maintenance
- Read No Show Policy
- Read Payment
- Read Property
- Read Property Settings
- Read Rate Plan
- Read Refund
- Read Reservation
- Read Revenue Report
- Read Schema
- Read Service
- Read Sub Account
- Read Time Slice Definition
- Read Unit
- Read Unit Attribute
- Read Unit Group
- Release Block
- Remove City Tax Reservation
- Reopen Folio
- Set Live Current Account
- Set Reservation to No Show
- Splt Charge Folio
- Splt Payment Folio
- Suspend Current Account
- Unassign Units Reservation
- Update Current Account
- Update Invoice Address
- Update Languages
- Update Night Audit
- Update Rate Plan
- Update Rates
- Update Unit Group
- Update Units Condition
- Wash Block
- Read Offer Index
- Search Age Categories
- Search Blocks
- Search Bookings
- Search Cancellation Policies
- Search Capture Policies
- Search Child Accounts
- Search City Tax
- Search Companies
- Search Company Invoices Vat Report
- Search Corporate Codes
- Search Countries
- Search Currencies
- Search External Accounts
- Search Folio Logs
- Search Folios
- Search Global Accounts
- Search Groups
- Search Guest Accounts
- Search Invoice Address
- Search Invoices
- Search Maintenances
- Search Night Audit Logs
- Search No Show Policies
- Search Offers
- Search Offers For Reservation
- Search Ordered Services Report
- Search Payment Methods
- Search Payments
- Search Promo Codes
- Search Properties
- Search Property Performance Report
- Search Rate Plan Offers
- Search Rate Plans
- Search Rates
- Search Refunds
- Search Reservation Logs
- Search Reservations
- Search Service Availability
- Search Service Offers
- Search Service Offers For Reservation
- Search Services
- Search Services For Reservation
- Search Service Types
- Search Sources
- Search Sub Accounts
- Search Time Slice Definitions
- Search Transactions Export Logs
- Search Unit Attributes
- Search Unit Availability
- Search Unit Availability For Reservation
- Search Unit Group Availability
- Search Unit Groups
- Search Units
- Search Vat
Add City Tax Reservation
ActionIn Make“Use this if you want to add the city tax to a reservation. You must have this scope: 'reservations.manage'.”
Puts the city tax on one reservation, so the guest's bill carries the levy without anyone editing it at the front desk.
reservations.manage scope for this module.Amend Block
ActionIn Make“Use this call to modify a block. You must have at least one of these scopes: 'blocks.manage, reservations.manage'.”
Changes an existing block, the set of rooms held for a group, so the allotment in apaleo follows what was agreed with the organizer.
blocks.manage or reservations.manage; check the scope before blaming the mapping.Amend Reservation
ActionIn Make“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'.”
Edits the stay details of a reservation, such as dates, so the booking in apaleo matches what the guest asked for.
Assign Specific Unit Reservation
ActionIn Make“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'.”
Gives a reservation the exact room you name, for guests who were promised a particular unit.
Assign Unit Reservation
ActionIn Make“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'.”
Lets apaleo pick any available room for a reservation, which is the quick way to get bookings ready for check-in.
Book Service Reservation
ActionIn Make“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'.”
Adds a service, breakfast or parking for instance, to one reservation so it shows up on the stay and later on the bill.
Cancel Block
ActionIn Make“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'.”
Releases a group block by switching it to Canceled, which frees the held rooms for regular sale.
blocks.manage or reservations.manage.Cancel Invoice
ActionIn Make“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'.”
Voids an invoice by creating a cancellation invoice; for a regular or AR invoice not yet paid, the folio opens again so you can fix it.
invoices.manage.Cancel Payment
ActionIn Make“Sets a payment to cancelled and triggers the cancellation. You must have this scope: 'folios.manage'.”
Marks a payment as cancelled and starts the cancellation, so a payment taken by mistake does not stay on the folio.
folios.manage scope.Cancel Reservation
ActionIn Make“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'.”
Cancels a single reservation, sets its status to Canceled and records the cancellation date and time.
Checkin Reservation
ActionIn Make“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'.”
Checks a guest in: the reservation moves to InHouse and apaleo stores the check-in date and time.
Checkout Reservation
ActionIn Make“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'.”
Checks a guest out, sets the reservation to CheckedOut and posts every open charge on the folio.
Close Folio
ActionIn Make“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'.”
Locks a folio so no charge or payment can be added, which keeps a settled account from moving afterwards.
Confirm Block
ActionIn Make“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'.”
Turns a Tentative block into a Definite one, the signal that a group booking is firm.
Correct Folio
ActionIn Make“Allowance value posted must not exceed sum of charges minus existing allowances You must have this scope: 'folios.manage'.”
Posts a correction on a folio as an allowance, to fix an amount charged by mistake without deleting the original line.
folios.manage.Create Accounting Report Aggregate
ActionIn Make“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'.”
Returns credited and debited totals for all accounts over a period, grouped by the timestamp of each transaction.
subledger.read or accounting.read.Create Accounting Report Aggregate Daily
ActionIn Make“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'.”
Gives the same credited and debited totals, grouped by business day instead of timestamp, which is how most hotel accountants read a period.
Create Accounting Report Aggregate Pairs Daily
ActionIn Make“Returns total amount credited from one account to another You must have at least one of these scopes: 'subledger.read, accounting.read'.”
Shows how much moved from one account to another, pair by pair, so you see the flows rather than just balances.
subledger.read or accounting.read is required, as for the other aggregate modules.Create Accounting Report Export
ActionIn Make“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'.”
Pulls the raw transactions of one property over a time period, the line-level data behind every total.
transactions.export or accounting.read, and each export lands in the audit log; add an iterator if the next app expects one line per bundle.Create Accounting Report Export Daily
ActionIn Make“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'.”
Delivers the raw transaction data of a property for a period, in the daily variant of the export, for tools that load data one business day at a time.
Create Accounting Report Export Gross Daily
ActionIn Make“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'.”
Exports raw transactions for a property and period in the gross daily variant, the third flavor of the transaction export.
Create Age Category
ActionIn Make“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'.”
Adds an age category, such as infants or teens, that rates and occupancy rules can then refer to.
settings.manage or setup.manage.Create Allowance Folio
ActionIn Make“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'.”
Posts an allowance, a credit that lowers what the guest owes, on a whole folio.
Create Block
ActionIn Make“You must have at least one of these scopes: 'blocks.create, reservations.manage'.”
Holds a set of rooms for a group in apaleo, so they stop selling to individual guests while the deal is discussed.
blocks.create or reservations.manage; confirm the block later with Confirm Block.Create Booking
ActionIn Make“Creates a booking taking a list of reservations as input You must have at least one of these scopes: 'reservations.create, reservations.manage'.”
Creates a booking from a list of reservations, the container that ties several rooms to one booker.
Create Booking Reservation
ActionIn Make“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'.”
Adds new reservations to a booking that already exists, without creating a second booking for the same guest.
Create Bulk Allowances Folio
ActionIn Make“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'.”
Posts several allowances on a folio in one module run, instead of looping over them one by one.
allowances.post or folios.manage.Create Cancellation Fee Folio
ActionIn Make“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'.”
Adds a cancellation fee and posts it at once, so the penalty from your policy is actually billed.
Create Cancellation Policy
ActionIn Make“Create a cancellation policy. You must have at least one of these scopes: 'settings.manage, setup.manage'.”
Sets up a cancellation policy in apaleo, the rule that later decides which fee applies when a guest cancels.
settings.manage or setup.manage.Create Charge Allowance Folio
ActionIn Make“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'.”
Grants an allowance against one specific charge, so the credit is tied to the line it corrects.
Create Charge Folio
ActionIn Make“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'.”
Adds and posts a charge for any good or service, even one that is not part of the reservation but belongs on the invoice.
charges.create or folios.manage.Create City Tax
ActionIn Make“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'.”
Defines the city tax of a property, which Add City Tax Reservation then applies to stays.
Create Company
ActionIn Make“Use this call to create a new company. You must have at least one of these scopes: 'companies.create, companies.manage'.”
Creates a company in apaleo, the business profile that corporate bookings and invoices can point to.
Create Folio
ActionIn Make“Use this call to create a new folio. You must have at least one of these scopes: 'reservations.create, reservations.manage, folios.manage'.”
Opens a new folio, the account where charges and payments of a stay or a guest are recorded.
reservations.create, reservations.manage or folios.manage; charges come afterwards with Create Charge Folio.Create Group
ActionIn Make“You must have at least one of these scopes: 'groups.create, reservations.manage'.”
Starts a group booking, the umbrella under which blocks and group reservations are gathered.
Create Group Reservation
ActionIn Make“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'.”
Adds new reservations to an existing group booking from a list, so each traveler gets a room under the same group.
groups.manage or reservations.manage.Create Invoice
ActionIn Make“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'.”
Produces the invoice for one folio, the document the guest or the company receives at the end of the stay.
Create Maintenance
ActionIn Make“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'.”
Opens a maintenance window on one unit, so a room under repair is not sold during that time.
Create Multiple Maintenances
ActionIn Make“Use this call to create multiple maintenances. You must have at least one of these scopes: 'maintenances.create, setup.manage'.”
Creates several maintenance windows in one go, which suits a renovation that touches many rooms.
maintenances.create or setup.manage.Create Multiple Units
ActionIn Make“Use this call to create multiple units, following a naming rule. You must have at least one of these scopes: 'units.create, setup.manage'.”
Generates a batch of units, the rooms apaleo sells, from a naming rule instead of typing them one at a time.
units.create or setup.manage.Create No Show Fee Folio
ActionIn Make“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'.”
You get the no-show fee added and posted straight onto the guest's bill, with no manual step at the front desk. In apaleo, a folio is the running bill of a stay.
charges.create or folios.manage scope.Create No Show Policy
ActionIn Make“Create a no-show policy. You must have at least one of these scopes: 'settings.manage, setup.manage'.”
This module sets up a new no-show policy in apaleo from your scenario, so the rule that decides what an absent guest pays exists before any booking relies on it.
settings.manage or setup.manage scope, otherwise apaleo refuses the call.Create Payment
ActionIn Make“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'.”
You record a payment on a folio for bookkeeping, without apaleo processing any money. It suits cash, cheques, vouchers, or payments already handled by another system.
Create Payment By Authorization
ActionIn Make“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'.”
This takes a chosen amount from a card pre-authorization and posts it to the folio, so money held at booking becomes an actual payment on the bill.
CaptureOnly flow type; the payment is processed asynchronously and times out after 60 minutes.Create Payment By Link
ActionIn Make“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'.”
You get a link to a payment form that the guest opens to pay the folio, ready to drop into an email or message sent by the next module.
Create Payment By Payment Account
ActionIn Make“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'.”
This charges the folio using the payment account already stored on the reservation, so the guest pays without handing over a card again.
Create Payment By Terminal
ActionIn Make“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'.”
You send a payment request to a card terminal for a given folio, so the amount appears on the device without anyone typing it in.
Create Payment Refund
ActionIn Make“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'.”
This refunds one specific payment on a folio, so the money goes back through the same payment it came from.
Create Property
ActionIn Make“Use this call to create a new property. You must have at least one of these scopes: 'properties.create, setup.manage'.”
You create a new property in apaleo from a scenario, the hotel or building that everything else (units, rates, services) hangs from.
properties.create or setup.manage scope.Create Rate Plan
ActionIn Make“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'.”
This creates a rate plan, the pricing frame a room is sold under, with its rates already in place but empty, waiting for prices.
rateplans.create or setup.manage.Create Refund
ActionIn Make“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'.”
You trigger a general refund on a folio, not linked to one particular payment, so a credit owed to the guest can be paid back.
Create Service
ActionIn Make“Create a service. You must have at least one of these scopes: 'services.create, setup.manage'.”
This adds a service to apaleo's catalogue, an extra the guest can book on top of the room, such as breakfast or parking.
services.create or setup.manage.Create Sub Account
ActionIn Make“Create a sub-account. You must have at least one of these scopes: 'subledger.manage, setup.manage'.”
You create a sub-account in apaleo's accounting, a finer line under which revenue or charges can be booked and later reported.
subledger.manage or setup.manage scope.Create Time Slice Definition
ActionIn Make“Use this call to create a time slice definition. You must have at least one of these scopes: 'settings.manage, setup.manage'.”
This creates a time slice definition, the unit of time apaleo uses to sell and price a stay, from a scenario instead of the settings screen.
settings.manage or setup.manage scope.Create Transitory Charge Folio
ActionIn Make“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'.”
You add and post a transitory item on a folio: a sale that is not the property's own revenue but must still appear on the guest's invoice.
charges.create or folios.manage.Create Unit
ActionIn Make“Use this call to create a new unit. You must have at least one of these scopes: 'units.create, setup.manage'.”
This creates a unit in apaleo, a room or bookable space, so it can be assigned to reservations as soon as it exists.
units.create or setup.manage scope.Create Unit Attribute
ActionIn Make“Use this call to create a new unit attribute. You must have at least one of these scopes: 'unitattributes.create, setup.manage'.”
You create a unit attribute, a label such as sea view or balcony that you can then attach to rooms to describe and filter them.
unitattributes.create or setup.manage scope.Create Unit Group
ActionIn Make“Use this call to create a new unit group. You must have at least one of these scopes: 'unitgroups.create, setup.manage'.”
This creates a unit group, the room category guests actually book (for example double or suite), under which individual units are gathered.
unitgroups.create or setup.manage scope; create the group before the units that belong to it.Delete Age Category
ActionIn Make“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'.”
You remove an age category, such as a child bracket, that you no longer price separately, keeping the setup list clean.
settings.manage or setup.manage.Delete Block
ActionIn Make“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'.”
This deletes a block, a set of rooms held for a group or event, when the deal falls through before any room was taken.
Delete Cancellation Policy
ActionIn Make“Use this call to delete a cancellation policy. You must have this scope: 'setup.manage'.”
You delete a cancellation policy you no longer offer, so it stops appearing among the conditions you can attach to rates.
setup.manage scope; check first with a read or search module that no rate still depends on it.Delete City Tax
ActionIn Make“Use this call to delete a city tax. You must have at least one of these scopes: 'settings.manage, setup.manage'.”
This removes a city tax definition from apaleo, so it is no longer applied to new stays once the rule has ended.
settings.manage or setup.manage required; to take the tax off one booking only, use the reservation module that removes it.Delete Company
ActionIn Make“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'.”
You delete a company record, a corporate client, when you stop working with it, so staff cannot pick it on new bookings.
companies.manage.Delete Folio
ActionIn Make“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'.”
This deletes a folio for good, clearing an extra bill that was opened by mistake or is no longer needed.
folios.manage.Delete Group
ActionIn Make“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'.”
You delete a group booking, the umbrella record for a party of guests, when it never turned into held rooms.
groups.manage or reservations.manage.Delete Maintenance
ActionIn Make“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'.”
This deletes a planned maintenance, giving a room back to sale when the works it was blocked for are called off.
maintenances.delete or maintenances.manage.Delete Multiple Rate Plans
ActionIn Make“Use this call to delete multiple rate plans. You must have at least one of these scopes: 'rateplans.delete, setup.manage'.”
You delete several rate plans in a single call, handy when a whole season or promotion is retired at once.
rateplans.delete or setup.manage. For a single plan, Delete Rate Plan is simpler.Delete No Show Policy
ActionIn Make“Use this call to delete a no-show policy. You must have this scope: 'setup.manage'.”
This deletes a no-show policy, so a rule you no longer apply to absent guests stops being offered on your rates.
setup.manage scope; replace the policy on existing rates before removing it.Delete Rate Plan
ActionIn Make“Use this call to delete a rate plan. You must have at least one of these scopes: 'rateplans.delete, setup.manage'.”
You delete one rate plan, the pricing frame of an offer, when that offer ends for good.
rateplans.delete or setup.manage is required; to remove only some prices and keep the plan, Delete Rates is the right module.Delete Rates
ActionIn Make“Deletes all rates in the specifed time range. You must have at least one of these scopes: 'rates.delete, rates.manage'.”
This clears every rate within a time range you choose, leaving the rate plan itself in place and ready for new prices.
rates.delete or rates.manage.Delete Service
ActionIn Make“Use this call to delete a service. You must have at least one of these scopes: 'services.create, setup.manage'.”
You delete a service from the apaleo catalogue, so an extra you stopped offering can no longer be booked.
services.create or setup.manage.Delete Service For Reservation
ActionIn Make“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'.”
This takes a service off one reservation, for instance a breakfast the guest no longer wants, without touching the catalogue.
reservations.manage.Delete Sub Account
ActionIn Make“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'.”
You delete a custom sub-account from apaleo's accounting when that revenue line is no longer used.
subledger.manage or setup.manage.Delete Time Slice Definition
ActionIn Make“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'.”
This removes a time slice definition you no longer sell by, keeping the property settings free of unused options.
settings.manage or setup.manage.Delete Unit
ActionIn Make“Use this call to delete a unit. You must have at least one of these scopes: 'units.delete, setup.manage'.”
You delete a unit, a single room or space, so it no longer counts in your inventory or gets assigned to guests.
units.delete or setup.manage scope; to take a room out only for a while, a maintenance fits better.Delete Unit Attribute
ActionIn Make“Deletes unit attribute You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.”
This deletes a unit attribute, one of the labels describing your rooms, when that feature no longer exists or is no longer promoted.
unitattributes.delete or setup.manage scope.Delete Unit Group
ActionIn Make“Use this call to delete a unit group. You must have at least one of these scopes: 'unitgroups.delete, setup.manage'.”
You delete a unit group, a room category, once that type of room is no longer sold at the property.
unitgroups.delete or setup.manage scope; move or delete its units and plans first to keep the setup coherent.Download PDF Invoice
ActionIn Make“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'.”
This fetches the PDF of an issued invoice, as a file the next module can attach to an email or save to your storage.
invoices.read.Download PDF Invoice Preview
ActionIn Make“Gets a preview invoice PDF for one specific folio. You must have this scope: 'invoices.read'.”
You get a preview PDF of what the invoice for one folio would look like, before the real invoice is issued.
invoices.read.Force Amend Reservation
ActionIn Make“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'.”
This changes the stay details of a reservation, such as dates or room category, with the stronger force permission rather than the regular amend.
reservations.force-manage.Force Book Service Reservation
ActionIn Make“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'.”
Adds a service, such as breakfast or parking, to one reservation in apaleo so it shows on the guest's bill.
reservations.manage scope.Force Create Booking
ActionIn Make“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'.”
Creates a full booking in apaleo from a list of reservations you pass in, so a group of rooms lands in one place.
reservations.force-create or reservations.force-manage. Map each reservation carefully, since one bundle (one item passed between modules) becomes one whole booking.Force Create Booking Reservation
ActionIn Make“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'.”
Adds new reservations to a booking that already exists, instead of opening a second booking for the same guest.
reservations.force-create or reservations.force-manage.Make an API Call
ActionIn Make“Performs an arbitrary authorized API call.”
Calls any endpoint of the apaleo API from your scenario, reusing the connection you already created, so nothing is out of reach.
Move All Charges Folio
ActionIn Make“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'.”
Moves every movable charge from one folio (the guest's running bill in apaleo) to another in a single step.
charges.move or folios.manage.Move Charges Folio
ActionIn Make“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'.”
Moves only the charges you pick from one folio to another, leaving the rest of the bill untouched.
Move Charges For Multiple Folios
ActionIn Make“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'.”
Handles several charge transfers at once, across more than one folio, instead of calling Move Charges Folio again and again.
folios.manage only.Move Payments Folio
ActionIn Make“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'.”
Moves payments from one folio to another inside the same reservation, so money sits on the bill it belongs to.
Patch Age Category
ActionIn Make“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'.”
Updates an age category in apaleo: its name and the minimum and maximum ages it covers.
settings.manage or setup.manage, which a read-only app account will not have.Patch Block
ActionIn Make“You can replace From, To, GrossDailyRate and BlockedUnits You must have at least one of these scopes: 'blocks.manage, reservations.manage'.”
Changes a room block, the rooms you hold back for an event or a group: its dates, the gross daily rate or the number of blocked units.
blocks.manage or reservations.manage.Patch Booking
ActionIn Make“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'.”
Edits a booking as a whole: the payment account, the internal comment, the booker's comment, or the booker themselves.
reservations.manage.Patch Cancellation Policy
ActionIn Make“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'.”
Rewrites a cancellation policy: name, description, the reference moment and period, and the fixed or percentage fee.
settings.manage or setup.manage.Patch Capture Policy
ActionIn Make“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'.”
Switches the flags that decide what apaleo charges automatically: no-show fees, cancellation fees, prepayments and the payment capture setup.
settings.manage or setup.manage.Patch City Tax
ActionIn Make“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'.”
Adjusts a city tax: name, description, value and type, or its VAT type, which you can also delete.
settings.manage or setup.manage.Patch Company
ActionIn Make“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'.”
Keeps a corporate client up to date: name, address and tax ID, plus the rate plans the company can book.
companies.manage. Adding a rate plan here does not change the plan itself, only who may use it.Patch Folio
ActionIn Make“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'.”
Changes who a folio is billed to: the debitor on a guest folio, or the company attached to it.
folios.manage.Patch Group
ActionIn Make“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'.”
Edits a group booking: its name, comments, payment account, the properties it spans and the booker.
groups.manage or reservations.manage.Patch Invoice Address
ActionIn Make“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'.”
Corrects the address printed on your invoices: street lines, postal code, city and country code.
setup.manage or settings.manage.Patch Maintenance
ActionIn Make“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'.”
Updates a maintenance slot on a unit: its description and its start and end.
maintenances.manage.Patch multiple Rate Plans
ActionIn Make“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'.”
Updates several rate plans in one call: names, policies, channel codes, restrictions, surcharges, included services and more.
rateplans.manage or setup.manage.Patch multiple units
ActionIn Make“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'.”
Changes many units (rooms, in apaleo terms) in one call: condition, name, description, unit group, maximum guests and attributes.
units.manage or setup.manage.Patch No Show Policy
ActionIn Make“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'.”
Edits a no-show policy: its name and description, and the fixed or percentage fee charged when a guest never arrives.
settings.manage or setup.manage.Patch Property
ActionIn Make“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'.”
Maintains a hotel's master data in apaleo: name, legal company name, directors, tax ID, location, bank account and payment terms.
properties.manage or setup.manage.Patch Rates
ActionIn Make“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'.”
Sets prices and restrictions on the rates of a plan for the time range you choose.
rates.manage.Patch Reservation
ActionIn Make“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'.”
Edits one stay: comments, guest comment, payment account, travel purpose, extra guests, commission or the primary guest.
reservations.manage.Patch Service
ActionIn Make“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'.”
Adjusts an extra you sell, such as parking: name, description, default gross price, pricing unit, availability and channel codes.
services.manage or setup.manage.Patch Sub Account
ActionIn Make“Allows to modify the name of the sub-account. You must have at least one of these scopes: 'subledger.manage, setup.manage'.”
Renames a sub-account in apaleo's accounting, and nothing more. Handy when labels in apaleo drift away from those in your finance tool.
subledger.manage or setup.manage.Patch Time Slice Definition
ActionIn Make“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'.”
Changes a time slice definition of a property: its name and its check-in and check-out times.
settings.manage or setup.manage.Patch Unit
ActionIn Make“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'.”
Updates a single room: its condition, name, description, unit group, maximum guests or attributes.
units.manage or setup.manage.Patch Unit Attribute
ActionIn Make“Here's a list of allowed operations: - Replace / Remove Description You must have at least one of these scopes: 'unitattributes.manage, setup.manage'.”
Replaces or removes the description of a unit attribute, such as a sea view label. Guests see the result wherever apaleo shows that feature, so the wording stays consistent without editing each room by hand.
unitattributes.manage or setup.manage.Patch Unit Group Availability
ActionIn Make“You can replace AllowedOverbooking for a unit group You must have this scope: 'availability.manage'.”
Sets how much overbooking apaleo allows on a unit group, a category of rooms. It gives your team a lever on how many extra bookings a category accepts.
availability.manage.Pay Invoice
ActionIn Make“Settles the invoice, if the invoice has an amount to be paid (total != 0). You must have this scope: 'invoices.manage'.”
Marks an invoice as settled in apaleo once there is an amount left to pay.
invoices.manage.Post Charges Folio
ActionIn Make“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'.”
Posts the open charges of a folio ahead of time so it can close early, for example when a guest wants the invoice right after check-in.
folios.manage.Read Account
ActionIn Make“Returns one account, as specified by its number and the property. You must have at least one of these scopes: 'subledger.read, accounting.read'.”
Fetches one accounting account of a property, identified by its number. The account comes back as one bundle you can map into later modules.
subledger.read or accounting.read.Read Age Category
ActionIn Make“Get an age category by id. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Returns one age category from its ID, with the ages it covers.
settings.read, setup.read or setup.manage.Read Arrival Report
ActionIn Make“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'.”
Gives the number of arriving guests at a property for a month, with travel purpose and nationality.
reports.read.Read Block
ActionIn Make“Retrieves a block, specified by its ID. You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.”
Retrieves a room block from its ID with its current dates, rate and rooms.
blocks.read, reservations.read or reservations.manage.Read Booking
ActionIn Make“Retrieves a booking with all its reservations. You must have at least one of these scopes: 'reservations.read, reservations.manage'.”
Retrieves a booking together with all its reservations in one bundle.
reservations.read or reservations.manage.Read Cancellation Policy
ActionIn Make“Get a specific cancellation policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Returns one cancellation policy with its terms and fees. The terms come back as one bundle, ready to map into an email, a PDF or a message to the guest, without copying anything by hand from apaleo.
settings.read, setup.read or setup.manage.Read Capture Policy
ActionIn Make“Get a specific capture policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Returns one capture policy, so you see what apaleo charges automatically. Reading it first keeps a record of the current settings, which is handy before any change touches payments or fees.
settings.read, setup.read or setup.manage.Read City Tax
ActionIn Make“Get a specific city tax. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Gives you the full definition of one city tax set up in apaleo, fetched by its ID, so later modules can show or reuse the amount rules without anyone opening the settings screen.
settings.read, setup.read or setup.manage, otherwise the call is refused.Read Company
ActionIn Make“Get a company by ID. You must have at least one of these scopes: 'companies.read, companies.manage'.”
Pulls one company record from apaleo by its ID and hands its details to the next module as a bundle (one item passed along the scenario). Handy for corporate bookings where the billing entity matters.
companies.read or companies.manage.Read Current Account
ActionIn Make“Retrieves information about the current account. You need to be authorized (no particular scope required)”
Returns the information of the apaleo account your connection is logged into. No ID to type: the module simply reads the account behind the credentials.
Read Folio
ActionIn Make“Get a folio by ID. You must have at least one of these scopes: 'folios.read, folios.manage'.”
Fetches one folio, the running bill of a stay, by its ID, so you can see what has been charged and paid before sending anything to the guest or to accounting.
folios.read or folios.manage.Read Group
ActionIn Make“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'.”
Retrieves one group booking together with all the blocks attached to it. A single call gives you the whole picture of a wedding party or a conference allotment.
groups.read, reservations.read or reservations.manage works; without them, nothing comes back.Read Invoice
ActionIn Make“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'.”
Loads the data of an existing invoice from its ID. It is the step that lets you forward invoice details to a bookkeeping tool or a shared drive.
invoices.read scope.Read Invoice Preview
ActionIn Make“To see if the invoice creation would be successful, check the warnings. You must have this scope: 'invoices.read'.”
Shows what an invoice would look like before it exists, including warnings that tell you whether creating it would succeed. Think of it as a dry run for billing.
invoices.read.Read Languages
ActionIn Make“Get the language settings You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Returns the language settings of your apaleo account. Small module, but it tells a scenario which languages the property works with before it picks a message template.
settings.read, setup.read or setup.manage.Read Maintenance
ActionIn Make“Get a specific maintenance by ID. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'.”
Gets one maintenance entry by ID, meaning a unit taken out of service, so the housekeeping or technical team can see why a room is blocked and for which stay dates.
maintenances.read or maintenances.manage.Read No Show Policy
ActionIn Make“Get a specific no-show policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Reads one no-show policy so you know which rule applies when a guest never arrives. Useful before a scenario explains a fee to a guest or to the front desk.
settings.read, setup.read or setup.manage.Read Payment
ActionIn Make“Get a payment by its ID You must have at least one of these scopes: 'folios.read, folios.manage'.”
Brings back one payment from its ID with its details, so a scenario can confirm what was actually collected on a folio before reporting it elsewhere.
folios.read or folios.manage on the apaleo app.Read Property
ActionIn Make“Get a property by id. You need to be authorized (no particular scope required)”
Returns one property by ID. For groups running several hotels in one apaleo account, it is how a scenario learns which building a reservation belongs to.
Read Property Settings
ActionIn Make“Get base settings for a property. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Fetches the base settings of a property. Where Read Property describes the hotel, this one gives the configuration behind it, which later modules can rely on.
settings.read, setup.read or setup.manage.Read Rate Plan
ActionIn Make“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'.”
Reads a single rate plan by ID, so revenue or distribution teams can check its setup from a scenario before changing prices or publishing it elsewhere.
rateplans.read-corporate, on top of rateplans.read, setup.read or setup.manage.Read Refund
ActionIn Make“Get a refund by its ID You must have at least one of these scopes: 'folios.read, folios.manage'.”
Gets one refund by its ID. With it, a scenario can confirm what money went back to a guest and pass the details to accounting or to the support ticket.
folios.read or folios.manage.Read Reservation
ActionIn Make“Retrieves a reservation, specified by its ID. You must have at least one of these scopes: 'reservations.read, reservations.manage'.”
Retrieves a reservation from its ID with everything apaleo holds on it. Placed right after Watch apaleo Events, it turns the reservation ID into a complete record that later modules can map.
reservations.read or reservations.manage.Read Revenue Report
ActionIn Make“You must have this scope: 'reports.read'.”
Runs the apaleo revenue report and returns its figures as data a scenario can reuse. It spares someone the export and copy-paste into a spreadsheet or a dashboard.
reports.read.Read Schema
ActionIn Make“Returns the schema of subledger, split into global and guest ledger. You must have at least one of these scopes: 'subledger.read, accounting.read'.”
Returns the structure of the subledger, split into global and guest ledger. It reads the shape of the accounts rather than the bookings, which helps before mapping entries to your own chart.
subledger.read or accounting.read.Read Service
ActionIn Make“Get a specific service. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.”
Gets one service, such as an extra sold with a stay, by its ID. The scenario then knows what the add-on is before it mentions it to a guest or books it.
services.read, setup.read or setup.manage.Read Sub Account
ActionIn Make“Get a sub-account by ID. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'.”
Reads one sub-account of the subledger by ID. It helps you label postings with the right account before sending them to your own books.
subledger.read, setup.read or setup.manage.Read Time Slice Definition
ActionIn Make“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'.”
Returns one time slice definition, the pattern that tells apaleo when a stay can start or end in a property. Rate plans rely on it for pricing units.
settings.read, setup.read or setup.manage.Read Unit
ActionIn Make“Get a unit by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.”
Fetches one unit, a room or apartment in apaleo terms, by its ID, so a scenario can name it properly in a housekeeping note or a guest message.
units.read, setup.read or setup.manage.Read Unit Attribute
ActionIn Make“Get unit attribute by id You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.”
Reads one unit attribute by ID, the kind of label that describes a feature of a room. It lets a scenario explain what a guest actually gets.
unitattributes.read, setup.read or setup.manage.Read Unit Group
ActionIn Make“Get a unit group by id. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.”
Returns one unit group, the category that bundles similar rooms, by ID. Revenue and distribution flows use it to know which category a price or an availability applies to.
unitgroups.read, setup.read or setup.manage.Release Block
ActionIn Make“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'.”
Moves a block from Definite back to Tentative. The allotment stays in apaleo, but it is no longer firmly committed, which gives sales room to renegotiate.
blocks.manage or reservations.manage.Remove City Tax Reservation
ActionIn Make“Use this is you want to remove the city tax from a reservation before the stay. You must have this scope: 'reservations.manage'.”
Takes the city tax off a single reservation. The stay keeps everything else; only the tax line is dropped, for guests who are exempt.
reservations.manage.Reopen Folio
ActionIn Make“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'.”
Opens a closed folio again so charges or payments can be corrected. A scenario can do it right after someone flags a billing mistake.
folios.manage and the Reopen allowed action.Set Live Current Account
ActionIn Make“Move the current account to live. This changes the account type to 'Live'. You must have this scope: 'account.manage'.”
Switches the current apaleo account to the Live type. This is an account-level change, not a booking one, so it belongs in onboarding scenarios rather than daily flows.
account.manage; test with care, the change affects the whole account.Set Reservation to No Show
ActionIn Make“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'.”
Marks a reservation as NoShow and records the no-show date and time. That status is what lets the no-show policy and any fee follow the right path.
reservations.manage.Splt Charge Folio
ActionIn Make“You must have at least one of these scopes: 'allowances.post, charges.create, folios.manage'.”
Splits a charge on a folio, so one line can be shared out instead of billed as a whole. Useful when two parties pay for the same item. The module name is spelled Splt in Make, so search for that.
allowances.post, charges.create or folios.manage.Splt Payment Folio
ActionIn Make“You must have at least one of these scopes: 'payments.create, refunds.create, folios.manage'.”
Divides a payment recorded on a folio. It is the payment-side twin of Splt Charge Folio and helps when one amount received must be spread differently.
payments.create, refunds.create or folios.manage.Suspend Current Account
ActionIn Make“Suspends the current account. This changes the account type to 'Suspended'. You must have this scope: 'account.manage'.”
Sets the current apaleo account to the Suspended type. It is an administrative switch for the whole account, with nothing to do with individual guests.
account.manage, and a Run once test executes it for real, so check which account the connection points to.Unassign Units Reservation
ActionIn Make“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'.”
Removes every unit assigned to a reservation across its time slices, so the booking goes back to having no room attached. If nothing was assigned, it does nothing.
reservations.assign-unit or reservations.manage.Update Current Account
ActionIn Make“Completely replaces an account with the new definition passed in. The old data will be lost. You must have this scope: 'account.manage'.”
Replaces the definition of the current account with the one you send. Every field you leave out is lost, so it rewrites rather than tweaks.
account.manage.Update Invoice Address
ActionIn Make“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'.”
Writes the invoice address for the properties you list. Where it is missing, apaleo creates it; where it exists, the new one fully replaces it.
setup.manage or settings.manage.Update Languages
ActionIn Make“Use this call to modify the language settings of the account. You must have at least one of these scopes: 'settings.manage, setup.manage'.”
Changes the language settings of your apaleo account. Pair it with Read Languages to check the current state before you modify anything.
settings.manage or setup.manage.Update Night Audit
ActionIn Make“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'.”
Launches the night audit: apaleo posts the charges of services delivered on the past business day to their folios and flags occupied rooms as Dirty.
operations.manage or operations.trigger-night-audit.Update Rate Plan
ActionIn Make“Use this call to modify a rate plan. You must have at least one of these scopes: 'rateplans.manage, setup.manage'.”
Modifies an existing rate plan. It changes the plan itself, while prices per date go through Update Rates.
rateplans.manage or setup.manage.Update Rates
ActionIn Make“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'.”
Sets prices and restrictions for a rate plan over the dates you send, creating the rates or overwriting the ones already there. It is the pricing workhorse of this app.
rates.manage.Update Unit Group
ActionIn Make“Use this call to modify a unit group. You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.”
Edits a unit group, the room category, so its setup matches what you sell. Category names and details stay consistent across channels when one scenario owns the change.
unitgroups.manage or setup.manage.Update Units Condition
ActionIn Make“You must have this scope: 'operations.change-room-state'.”
Changes the housekeeping condition of rooms in apaleo straight from the scenario, so the front desk sees which units are ready without anyone updating the board by hand.
operations.change-room-state scope, otherwise the module is refused.Wash Block
ActionIn Make“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'.”
Hands back to general inventory every unit of a confirmed block that nobody has picked up yet, which frees rooms that a group or allotment will not use.
blocks.manage or reservations.manage.Read Offer Index
SearchIn Make“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'.”
Returns the offers of one rate plan split per time slice for an arrival and a departure date, a handy view when a scenario compares prices night by night.
offer-index.read or offers.read; for offers across a whole property, Search Offers fits better.Search Age Categories
SearchIn Make“Get the list of age categories. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Lists the age categories set up in apaleo, such as children or adults, so the scenario can pick the right category ID before it creates or amends a booking.
settings.read, setup.read or setup.manage.Search Blocks
SearchIn Make“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'.”
Finds the room blocks held for groups or allotments, filtered by the criteria filled in the module, and hands each block to the next module as its own bundle (one item of data).
Search Bookings
SearchIn Make“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'.”
Pulls bookings from apaleo, the envelope that holds one or more reservations and the booker's details, filtered by the parameters set in the module.
reservations.read or reservations.manage.Search Cancellation Policies
SearchIn Make“Get the list of cancellation policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Reads the cancellation policies defined in apaleo, so a scenario can show a guest the terms or pick the policy ID a new rate plan should carry.
settings.read, setup.read or setup.manage; no-show rules live in a separate module.Search Capture Policies
SearchIn Make“Get the list of capture policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Returns the capture policies of the account, the rules that decide when a guest's payment gets captured, ready to be mapped into rate plan or payment modules.
Search Child Accounts
SearchIn Make“You must have at least one of these scopes: 'subledger.read, accounting.read'.”
Walks the accounting tree of apaleo and returns the sub-accounts found under a parent account, useful when a finance scenario rebuilds the ledger structure in a spreadsheet.
subledger.read or accounting.read, scopes that the apaleo app registration must grant.Search City Tax
SearchIn Make“Get the list of all city taxes. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Lists every city tax configured in apaleo, so the scenario knows which tax to add or remove on a reservation without guessing its ID.
settings.read, setup.read or setup.manage.Search Companies
SearchIn Make“Get the list of companies. You must have at least one of these scopes: 'companies.read, companies.manage'.”
Finds the corporate customers stored in apaleo, which lets a CRM sync check whether a company already exists before creating it a second time.
companies.read or companies.manage.Search Company Invoices Vat Report
SearchIn Make“You must have this scope: 'reports.read'.”
Pulls the VAT report on invoices issued to companies, a ready source for an accountant who wants the figures in a sheet or an email.
reports.read scope. The doc does not list the report columns, so check them with Run once before mapping.Search Corporate Codes
SearchIn Make“Returns all existing corporate codes that match given criteria. You must have this scope: 'rateplans.read-corporate'.”
Returns the corporate codes that match the criteria set in the module, the codes that unlock negotiated rates for a company's staff.
rateplans.read-corporate scope, not the regular rate plan scopes.Search Countries
SearchIn Make“Returns a list of ISO country codes that could be used to create properties. You need to be authorized (no particular scope required)”
Gives the ISO country codes apaleo accepts when a property is created, which spares a scenario from sending a country code the system will reject.
Search Currencies
SearchIn Make“Returns a list of all currencies.”
Returns the list of currencies apaleo knows, a small lookup that keeps amounts and currency codes consistent across the modules of a scenario.
Search External Accounts
SearchIn Make“Returns a list of accounts in one property for a folio. You must have at least one of these scopes: 'subledger.read, accounting.read'.”
Returns the accounts of one property tied to a folio, the invoice record of a guest or company, so finance flows can trace where charges end up.
subledger.read or accounting.read.Search Folio Logs
SearchIn Make“You must have this scope: 'logs.read'.”
Reads the history of changes on folios, which helps explain who moved a charge or closed an invoice record when a figure looks wrong.
logs.read scope, which a standard setup may not grant.Search Folios
SearchIn Make“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'.”
Lists folios, the billing records attached to a reservation or a company, so a scenario can check balances or pick the folio to charge.
Search Global Accounts
SearchIn Make“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'.”
Returns the accounts of one property that share the same global account as parent, a quick way to read one branch of the ledger.
subledger.read or accounting.read is required.Search Groups
SearchIn Make“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'.”
Finds group bookings, the stays that bundle many rooms under one organizer, filtered by the parameters filled in the module.
groups.read, reservations.read or reservations.manage.Search Guest Accounts
SearchIn Make“Returns a list of accounts in one property for a reservation. You must have at least one of these scopes: 'subledger.read, accounting.read'.”
Returns the accounts of one property linked to a reservation, so a scenario can read what a guest owes on the accounting side.
subledger.read or accounting.read.Search Invoice Address
SearchIn Make“Get the list of all invoice addresses. You must have at least one of these scopes: 'setup.read, setup.manage, settings.read, settings.manage'.”
Lists the invoice addresses stored in the account setup, the details printed on invoices, so a scenario can check or reuse them.
setup.read, setup.manage, settings.read or settings.manage is needed.Search Invoices
SearchIn Make“Gets the list of all invoices (the metadata only, not the files). You must have this scope: 'invoices.read'.”
Returns the invoices of the account with their metadata, enough to feed an accounting sheet or trigger a follow-up per invoice.
invoices.read.Search Maintenances
SearchIn Make“Get a list of maintenances matching your filter. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'.”
Finds the maintenance entries that block or restrict units, matching the filter set in the module, so repairs stay visible outside apaleo.
maintenances.read or maintenances.manage.Search Night Audit Logs
SearchIn Make“Returns a log of all night audits Newest log entries are returned first. You must have this scope: 'logs.read'.”
Reads the log of night audits, the closing run that rolls the hotel day forward, with the most recent entries first.
logs.read.Search No Show Policies
SearchIn Make“Get the list of no-show policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.”
Lists the no-show policies of the account, the rules applied when a guest never arrives, to reuse their IDs in rate plan scenarios.
Search Offers
SearchIn Make“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'.”
Calculates what a property can sell for an arrival and a departure date, returning each available offer as a bundle the scenario can price or book.
offers.read or reservations.manage; for a single rate plan, Search Rate Plan Offers is narrower.Search Offers For Reservation
SearchIn Make“Calculates and returns offers for amending a specific reservation. You must have at least one of these scopes: 'offers.read, reservations.manage'.”
Computes the offers available to change an existing reservation, such as new dates, before the scenario amends it.
Search Ordered Services Report
SearchIn Make“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'.”
Returns the extra services ordered per day, with the guest and the reservation behind each, a clean feed for the kitchen or the spa.
reports.read scope on the apaleo app.Search Payment Methods
SearchIn Make“Returns a list of all supported payment methods.”
Gives the payment methods apaleo supports, a lookup that keeps a payment module from receiving a method it cannot process.
Search Payments
SearchIn Make“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'.”
Lists every payment on one folio, newest first, so a scenario can confirm a guest paid before sending a receipt or closing the folio.
folios.read or folios.manage.Search Promo Codes
SearchIn Make“Returns all existing promo codes that match given criteria. You must have this scope: 'rateplans.read-corporate'.”
Returns the promo codes that match the criteria set in the module, so a campaign scenario can check a code before advertising it.
rateplans.read-corporate, the same scope as corporate codes.Search Properties
SearchIn Make“Get the list of properties. You need to be authorized (no particular scope required)”
Lists the hotels of the account, which gives a multi-property scenario the property IDs most other modules ask for.
Search Property Performance Report
SearchIn Make“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'.”
Returns occupancy, ADR and RevPAR for a property, the core figures of hotel revenue, ready to land in a dashboard or a message.
reports.read.Search Rate Plan Offers
SearchIn Make“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'.”
Calculates the offers of one rate plan for an arrival and a departure date, a focused answer when only one price type matters.
offers.read or reservations.manage.Search Rate Plans
SearchIn Make“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'.”
Lists the rate plans the connection can see, each with its ID, so a scenario can pick the plan to price, update or book.
rateplans.read-corporate scope, only public rate plans come back.Search Rates
SearchIn Make“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'.”
Returns the rates of one rate plan over a time range, the prices a scenario can compare, copy to another tool or correct.
Search Refunds
SearchIn Make“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'.”
Lists the refunds recorded on one folio, newest first, so a scenario can confirm money went back before telling the guest.
folios.read or folios.manage.Search Reservation Logs
SearchIn Make“You must have this scope: 'logs.read'.”
Reads the change history of reservations, handy to find out who amended a stay or when a status changed.
logs.read. The doc does not describe the log fields, so inspect them with Run once.Search Reservations
SearchIn Make“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'.”
Pulls reservations matching the filters set in the module, each one as a bundle, the usual starting point for guest messages and reports.
reservations.read or reservations.manage.Search Service Availability
SearchIn Make“Get the list of available services for a specific property and time period. You must have this scope: 'availability.read'.”
You get the services a property can still sell over a period you choose, one bundle per service, ready to feed a later module.
availability.read scope, otherwise the search returns nothing useful.Search Service Offers
SearchIn Make“You must have at least one of these scopes: 'offers.read, reservations.manage'.”
This search hands back the service offers apaleo can quote, so a scenario can show a guest what extras exist and what they would pay.
offers.read or reservations.manage on the apaleo side.Search Service Offers For Reservation
SearchIn Make“Calculates and returns service offers for a specific reservation. You must have at least one of these scopes: 'offers.read, reservations.manage'.”
Starting from one reservation, apaleo calculates which service offers apply to that stay and returns them as bundles you can map.
offers.read or reservations.manage; without one of them the module fails.Search Services
SearchIn Make“Get the list of services. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.”
Here you read the catalogue of services configured in apaleo, the list your team set up, whatever their availability on a given day.
services.read, setup.read or setup.manage must be granted to your apaleo app.Search Services For Reservation
SearchIn Make“Returns the services booked for a specific reservation. You must have at least one of these scopes: 'reservations.read, reservations.manage'.”
What a guest already booked on top of the room comes back from this module: the services attached to one reservation.
reservations.read or reservations.manage, or the list stays out of reach.Search Service Types
SearchIn Make“Returns a list of all supported service types.”
With this search, Make returns every service type apaleo supports, a short reference list rather than your own services.
Search Sources
SearchIn Make“Returns a list of channels that could be used as a source to create bookings.”
apaleo exposes the channels a booking can come from, and this module lists them so you can tag new bookings correctly.
Search Sub Accounts
SearchIn Make“Returns a list of all sub-accounts. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'.”
Sub-accounts of your apaleo ledger come back as a list, useful when a scenario has to route amounts to the right account.
subledger.read, setup.read or setup.manage on the app.Search Time Slice Definitions
SearchIn Make“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'.”
You learn the time slots a property allows for a stay to start or end, the pattern that rate plans rely on when prices are set.
settings.read, setup.read or setup.manage; a read-only app is enough.Search Transactions Export Logs
SearchIn Make“Returns the audit log for all exports if accounting data that have been done. You must have this scope: 'logs.read'.”
An audit trail of the accounting exports already done in apaleo is what this search returns, one bundle per export.
logs.read opens it; the other accounting scopes do not.Search Unit Attributes
SearchIn Make“Get unit attribute list You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.”
The attributes you defined for rooms and units, such as a view or a feature, come back as a list you can reuse.
unitattributes.read, setup.read or setup.manage, or the search is refused.Search Unit Availability
SearchIn Make“Get the list of available units for a specific property and time period. You must have this scope: 'availability.read'.”
For a property and a date range, apaleo returns the individual units still free, so a scenario knows which room it can offer.
availability.read scope works here.Search Unit Availability For Reservation
SearchIn Make“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'.”
Tied to one reservation, this search lists the units free for that stay's period, a shortcut before assigning a room.
availability.read or reservations.manage.Search Unit Group Availability
SearchIn Make“Get the list of available unit groups for a specific property and time period. You must have this scope: 'availability.read'.”
Instead of single rooms, this module works at the level of room categories and tells you which unit groups stay open over a period.
availability.read scope is required.Search Unit Groups
SearchIn Make“Get the list of unit groups. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.”
Every unit group of your apaleo setup is listed, the categories rooms belong to, with the IDs other modules expect.
unitgroups.read, setup.read or setup.manage to the app.Search Units
SearchIn Make“Get the list of units. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.”
This one returns the units themselves, your rooms or apartments as apaleo knows them, one bundle per unit.
units.read, setup.read or setup.manage.Search Vat
SearchIn Make“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)”
Asked for a country, apaleo answers with its VAT types and rates, so a scenario can apply the right tax when it prepares a charge.
Need help automating apaleo with Make?
A person reads every message.