Scheduling ยท CONNECTIONManage apaleo properties, units, rate plans, bookings, reservations, folios, charges, invoices, reports and availability (no payments or refunds).
Explore 238 workflow actions for apaleo, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a cancellation fee, and directly posts it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a charge for any good or service, and directly posts it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a no-show fee, and directly posts it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a transitory item for any good or service, and directly posts it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this if you want to add the city tax to a reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns credited and debited amounts aggregated by transactions' date (business day) for all accounts and a given period.
Returns credited and debited amounts aggregated by transactions' timestamp for all accounts and a given period.
Returns total amount credited from one account to another You must have at least one of these scopes: 'subledger.read, accounting.read'.
Use this call to modify a block.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You can replace HouseOverbookingLimit on the property-level.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Add, replace and remove MarketSegment You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Add, replace and remove PaymentAccount - Add, replace and remove RegisteredCard - Add, replace and remove Comment -.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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 -.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace name and description - Replace type - Replace taxHandlingType - Replace value - Replace limit - Replace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace areCustomRevenueSubAccountsEnabled flag - Replace performAccountingForOpenInvoiceActions flag - Replace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace name - Add, replace and remove description - Add, replace and remove propertyIds You must have at least one.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here's a list of allowed operations: - Replace Name - Add, replace and remove Description - Replace CompanyName - Add, replace and remove ManagingDirectors - Replace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Allows to modify the name of the sub-account.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You can replace AllowedOverbooking for a unit group You must have this scope: 'availability.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here's a list of allowed operations: - Replace / Remove Description You must have at least one of these scopes: 'unitattributes.manage, setup.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Note that the specified PATCH operations are applied to each and every rate for the specified time ranges.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace Name - Replace Description - Replace MinGuaranteeType - Replace PriceCalculationMode - Replace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Note that the specified PATCH operations are applied to each and every rate for the specified time range.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Modifies the stay-related data of a reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Modifies the stay-related data of a reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Internal callback the scheduler invokes when an 'Optional' block's cutoff timer fires.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this endpoint to archive an existing live property This operation set the IsArchived flag to true You must have at least one of these scopes: 'properties.manage, setup.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive the specific rate plan.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive the specific unit.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assigns a specific unit to a reservation which is in state 'Confirmed' or 'InHouse'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assigns one of the available units to a reservation which is in state 'Confirmed' or 'InHouse'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this to book a service for a specific reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this to book a service for a specific reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel a specific block which is in status 'Definite' or 'Tentative'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel a specific reservation which is in status 'Confirmed' and where the arrival time is in the future.
A repeated request may repeat the external action. Review the previous result before retrying a write.
For regular invoices and AR invoices that haven't been paid yet, creates a new cancellation invoice and opens the folio again.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace AddressLine1 - Add, replace or delete AddressLine2 - Replace PostalCode - Replace City - Replace CountryCode.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have this scope: 'operations.change-room-state'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check in a specific reservation which is in status 'Confirmed', and has a unit assigned.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check out a specific reservation which is in status 'InHouse'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to clone a specific property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark a folio as closed to prevent adding charges and payments.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Confirm a specific block which is in status 'Tentative'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Internal callback the scheduler invokes when an 'Optional' block's start timer fires.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Allowance value posted must not exceed sum of charges minus existing allowances You must have this scope: 'folios.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a cancellation policy.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have at least one of these scopes: 'settings.manage, setup.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new company.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have at least one of these scopes: 'settings.manage, setup.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new maintenance window for the given unit.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a no-show policy.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new rate plan.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have at least one of these scopes: 'routings.create, routings.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a service.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a sub-account.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new unit.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new unit attribute.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new unit group.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new folio.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new age category.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create multiple maintenances.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create multiple units, following a naming rule.
A repeated request may repeat the external action. Review the previous result before retrying a write.
If the address does not exist for one of the specified properties, it is created.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have at least one of these scopes: 'blocks.create, reservations.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a booking taking a list of reservations as input.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a booking taking a list of reservations as input.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have at least one of these scopes: 'groups.create, reservations.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a new property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to create a time slice definition.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates an invoice for one specific folio.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a cancellation policy.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a group booking.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a time slice definition.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a city tax.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a company.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a custom sub-accounts.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a maintenance.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a market segment.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a no-show policy.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a rate plan.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a routing.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a service.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a block.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a unit.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete a unit group.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete an age category.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to delete multiple rate plans.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a folio.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this endpoint to delete a property and all related data: transactional, setup.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes all rates in the specifed time range.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes unit attribute You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a company by ID.
Get the list of available services for a specific property and time period.
Get the list of available unit groups for a specific property and time period.
Get the list of available units for a specific reservation and time period.
Get the list of available units for a specific property and time period.
Get the list of companies.
Get a market segment by id.
Get the list of properties.
Get a property by id.
Get a rate plan by id.
Get the list of rate plans depending on client scopes.
Get a refund by its ID You must have at least one of these scopes: 'folios.read, folios.manage'.
Get a specific cancellation policy.
Get a specific city tax.
Get a specific maintenance by ID.
Get a specific no-show policy.
You must have at least one of these scopes: 'routings.read, setup.read, setup.manage'.
Get a specific service.
Get a specific time slice definition for a property.
Get a unit by id.
Get a unit group by id.
Get the list of units.
Get the list of cancellation policies.
Get the list of all city taxes.
Get the list of no-show policies.
You must have at least one of these scopes: 'routings.read, setup.read, setup.manage'.
Get the list of services.
Get the list of unit groups.
Get an age category by id.
Get the list of age categories.
Get feature settings for a property.
You must have this scope: 'availability.read'.
Get the list of all invoice addresses.
Get a list of maintenances matching your filter.
Get base settings for a property.
Get the language settings You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.
Get all time slice definitions for a property.
Get unit attribute by id You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Get unit attribute list You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
To see if the invoice creation would be successful, check the warnings.
Gets invoice data by its ID.
Gets the list of all invoices (the metadata only, not the files).
All rates specified in the request will be initialized, or overwritten if they already exist.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns a list of ordered services per day with information about the guest and the reservation this service was ordered for.
Locks the currently assigned unit(s) for a reservation, preventing any reassignment or unassignment operations.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to modify a time slice definition of the property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace name, invoicingEmail, phone, taxId, additionalTaxId, additionalTaxId2, invoiceNetworkIdentity, address.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You can only change maintenances which are in the future or still ongoing today.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace Filter - Replace DestinationFolio You must have at least one of these scopes: 'routings.manage, setup.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Here is the list of operations that are currently allowed: - Replace Name - Replace Description - Replace DefaultGrossPrice - Replace PricingUnit - Replace PostNextDay - Replace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
If one of the folios is closed, this action cannot be performed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
If one of the folios is closed, this action cannot be performed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
If one of the folios is closed, this action cannot be performed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Move payments from one guest/booking folio to another - moving between different bookings is not supported, and will lead to an error.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this endpoint to move an existing test property to live This operation changes the property status to 'Live' You must have at least one of these scopes: 'properties.manage.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call for cases when the folio should be closed early.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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'.
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'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
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'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Release a specific block which is in status 'Definite'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a service from a reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this is you want to remove the city tax from a reservation before the stay.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reopens a closed folio.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to modify a rate plan.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to modify a unit group.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Completely replaces an account with the new definition passed in.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this call to modify the language settings of the account.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this endpoint to delete all transactional data related to some test property This operation deletes all transactional data related to the specified property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Return total count of properties You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.properties.read'.
Returns a list of all bookings, filtered by the specified parameters.
Returns a list of all currencies.
Allowed actions are only returned, when the list is filtered by reservation ID.
Returns a list of all group bookings, filtered by the specified parameters.
You must have at least one of these scopes: 'setup.read, setup.manage'.
Returns a list of all reservations, filtered by the specified parameters.
Returns a list of all sub-accounts.
Returns a list of all supported payment methods.
Returns a list of all supported service types.
Returns a list of all VAT types and percents for a country.
Returns a list of all blocks, filtered by the specified parameters.
You must have at least one of these scopes: 'subledger.read, accounting.read'.
Returns all existing corporate codes that match given criteria.
Returns a list of accounts in one property for a folio.
Returns a list of accounts in one property, having the same global account as parent.
Returns a list of accounts in one property for a reservation.
Returns all existing promo codes that match given criteria.
Returns all rates for a specific rate plan within the specified time range.
Returns a list of ISO country codes that could be used to create properties.
Returns a list of channels that could be used as a source to create bookings.
You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.booking_types.read'.
Retrieves a block, specified by its ID.
Retrieves a booking with all its reservations.
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 a reservation, specified by its ID.
Get the list of accounts.
You must have this scope: 'logs.read'.
Returns the raw transaction data for a given property and time period.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns number of blocks matching the filter criteria You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.
Returns number of folios matching the filter criteria.
Returns number of group bookings matching the filter criteria You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'.
Returns the number of maintenances matching your filter.
Returns number of market segments.
Returns number of rate plans matching the filter criteria, and depending on client scopes If a client has no additional scopes, only public rate plans are counted.
Returns number of services You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.
Returns number of sub-account.
Returns number of unit groups matching the filter criteria You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Returns number of units matching the filter criteria You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Calculates and returns offers for amending a specific reservation.
Calculates and returns available offers for a specific property, arrival and departure date.
Calculates and returns offers per time slice for a specific rate plan, arrival and departure date.
Returns one account, as specified by its number and the property.
Get a folio by ID.
Get a sub-account by ID.
You must have this scope: 'logs.read'.
Calculates and returns service offers for a specific reservation.
You must have at least one of these scopes: 'offers.read, reservations.manage'.
Returns the audit log for all exports if accounting data that have been done.
Returns the schema of subledger, split into global and guest ledger.
Retrieves information about the current account.
You must have this scope: 'reports.read'.
Returns a log of all night audits Newest log entries are returned first.
Returns number of arriving guests for a property for a certain month.
To be able to count rates for a corporate rate plan a client must additionaly have the 'rateplans.read-corporate' scope.
If no parameters are set, returns the total count of reservations.
The property performance API return you key performance indicator for the selected property like occupancy, ADR and RevPAR.
You must have this scope: 'reports.read'.
Returns the services booked for a specific reservation.
Returns the raw transaction data for a given property and time period.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns the raw transaction data for a given property and time period.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have this scope: 'reservations.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a specific block which is in status 'Tentative' to 'Optional'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a specific reservation to No-show which is in status 'Confirmed' and where the arrival date is in the past.
A repeated request may repeat the external action. Review the previous result before retrying a write.
You must have at least one of these scopes: 'allowances.post, charges.create, folios.manage'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unassigns units for all time slices of the given reservation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlocks the currently assigned unit(s) for a reservation that were previously locked, allowing reassignment or unassignment operations.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Wash a specific block which is in status 'Definite'.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in apaleo. A saved workflow is not a completed provider action.
