Apaleo integration: operations for AI agents
Apaleo connects to Type.com as an integration. This page lists the 289 operations documented for Claude and Codex in Type.com: 125 read, 88 write, 76 destructive.
About Apaleo
Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses
Categories: Communication & Meetings
How to connect Apaleo to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.
To add the connection, follow the steps in Space connections.
Documented operations
289 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
289 operations listed.
Property
- Read
Get a properties list
Get the list of properties. You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.properties.read'.
- Read
Return total count of properties
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'.
- Read
Get a property
Get a property by id. You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.properties.read'.
- Read
Check if a property exists
Check if a property exists by id. You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.properties.read'.
- Write
Creates a property
Use this call to create a new property. You must have at least one of these scopes: 'properties.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.properties.create'.
- Write
Allows to modify property
Here's a list of allowed operations: - Replace Name - Add, replace and remove Description - Replace CompanyName - Add, replace and remove ManagingDirectors - Replace CommercialRegisterEntry - Replace TaxId - Replace Location - Add, replace and remove BankAccount - Replace Paymen…
- Destructive
Deletes a property
Use this endpoint to delete a property and all related data: transactional, setup. The property must be in 'Test' status. You must have at least one of these scopes: 'properties.manage, setup.manage'.
Property Actions
- Write
Clones a property
Use this call to clone a specific property. This operation creates a new property with inventory and rate plans from the specified property. You must have at least one of these scopes: 'properties.create, setup.manage'.
- Destructive
Archive a property
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'. For fine-grained clients, you must have this permission: 'core.properties.archive'.
- Destructive
Move property to live
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, setup.manage'. For fine-grained clients, you must have this permission: 'core.properties.setlive'.
- Destructive
Reset a test property and delete all transactional data
Use this endpoint to delete all transactional data related to some test property This operation deletes all transactional data related to the specified property. The property must be in 'Test' status. You must have at least one of these scopes: 'properties.manage, setup.manage'.
Types
- Read
Returns a list of supported countries.
Returns a list of ISO country codes that could be used to create properties. You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.types.read'.
- Read
Returns a list of supported sources.
Returns a list of channels that could be used as a source to create bookings. For fine-grained clients, you must have this permission: 'core.bookingtypes.read'.
- Read
Returns a list of values that a field of the specified type can take in the specified country.
You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.bookingtypes.read'.
- Read
Returns a list of all currencies.
Returns a list of all currencies. For fine-grained clients, you must have this permission: 'core.types.read'.
- Read
Returns a list of all supported payment methods.
Returns a list of all supported payment methods. For fine-grained clients, you must have this permission: 'core.types.read'.
- Read
Returns a list of all supported service types.
Returns a list of all supported service types. For fine-grained clients, you must have this permission: 'core.types.read'.
- Read
Returns a list of all VAT types.
Returns a list of all VAT types and percents for a country. Supported: - Andorra (AD) - Albania (AL) - Argentina (AR) - Austria (AT) - Aruba (AW) - Australia (AU) - Azerbaijan (AZ) - Bahamas (BS) - Belgium (BE) - Bulgaria (BG) - Cape Verde (CV) - Costa Rica (CR) - Croatia (HR) -…
Unit
- Read
Get a unit
Get a unit by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.read'.
- Read
Check if a unit exists
Check if a unit exists by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.read'.
- Read
Get a units list
Get the list of units. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.read'.
- Read
Returns number of units
Returns number of units matching the filter criteria You must have at least one of these scopes: 'units.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.read'.
- Write
Allows to patch unit
Here's a list of allowed operations: - Set unit condition - Set unit description - Set unit name - Set unit unitGroupId - Set unit maxPersons - Add unit attribute - Remove unit attribute You must have at least one of these scopes: 'units.manage, setup.manage'.
- Write
Create a unit
Use this call to create a new unit. You must have at least one of these scopes: 'units.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.create'.
- Write
Allows to patch one or more units
Here's a list of allowed operations: - Set unit condition - Set unit description - Set unit name - Set unit unitGroupId - Set unit maxPersons - Add unit attribute - Remove unit attribute You must have at least one of these scopes: 'units.manage, setup.manage'.
- Write
Create multiple units
Use this call to create multiple units, following a naming rule. You must have at least one of these scopes: 'units.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.create'.
- Destructive
Delete a unit
Use this call to delete a unit. You must have at least one of these scopes: 'units.delete, setup.manage'. For fine-grained clients, you must have this permission: 'core.units.delete'.
Unit Actions
- Destructive
Archive a unit
Archive the specific unit. This action makes unit unavailable for all operations and cannot be undone. You must have this scope: 'setup.manage'. For fine-grained clients, you must have this permission: 'core.units.archive'.
Unit Attribute
- Read
Get unit attribute by id
Get unit attribute by id You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitattributes.read'.
- Read
Check if a unit attribute exists
Check if a unit attribute exists You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitattributes.read'.
- Read
Get unit attribute list
Get unit attribute list You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitattributes.read'.
- Write
Allows to modify unit attribute
Here's a list of allowed operations: - Replace / Remove Description You must have at least one of these scopes: 'unitattributes.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitattributes.modify'.
- Write
Create a unit attribute
Use this call to create a new unit attribute. You must have at least one of these scopes: 'unitattributes.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitattributes.create'.
- Destructive
Deletes unit attribute
Deletes unit attribute You must have at least one of these scopes: 'unitattributes.delete, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitattributes.delete'.
Unit Group
- Read
Get all unit groups, or all unit groups for a property
Get the list of unit groups. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.read'.
- Read
Returns number of unit groups
Returns number of unit groups matching the filter criteria You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.read'.
- Read
Get a unit group
Get a unit group by id. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.read'.
- Read
Check if a unit group exists
Check if a unit group exists by id. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.read'.
- Write
Create a unit group
Use this call to create a new unit group. You must have at least one of these scopes: 'unitgroups.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.create'.
- Destructive
Replace a unit group
Use this call to modify a unit group. You must have at least one of these scopes: 'unitgroups.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.modify'.
- Destructive
Delete a unit group
Use this call to delete a unit group. You must have at least one of these scopes: 'unitgroups.delete, setup.manage'. For fine-grained clients, you must have this permission: 'core.unitgroups.delete'.
Age Category
- Read
Get an age category
Get an age category by id. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.agecategories.read'.
- Read
Get an age category list
Get the list of age categories. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.agecategories.read'.
- Write
Allows to modify properties of an age category
Here is the list of operations that are currently allowed: - Replace name, minimum age and maximum age You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.agecategories.modify'.
- Write
Create an age category
Use this call to create a new age category. The age ranges for categories must not overlap each other and the allowed values span from 0 to 17. You must have at least one of these scopes: 'settings.manage, setup.manage'.
- Destructive
Delete an age category
Use this call to delete an age category. You can only delete an age category if it is not already used in a rate plan to define age specific prices. You must have at least one of these scopes: 'settings.manage, setup.manage'.
Cancellation Policy
- Read
Get all cancellation policies.
Get the list of cancellation policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.cancellationpolicies.read'.
- Read
Get a specific cancellation policy.
Get a specific cancellation policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.cancellationpolicies.read'.
- Write
Create a cancellation policy.
Create a cancellation policy. You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.cancellationpolicies.create'.
- Write
Allows to modify properties of a cancellation policy
Here is the list of operations that are currently allowed: - Replace name and description - Replace the period from reference - Replace the reference - Replace the fee details: fixed and percent values You must have at least one of these scopes: 'settings.manage, setup.manage'.
- Destructive
Delete a cancellation policy
Use this call to delete a cancellation policy. You must have this scope: 'setup.manage'. For fine-grained clients, you must have this permission: 'core.cancellationpolicies.delete'.
Company
- Read
Get a list of companies
Get the list of companies. You must have at least one of these scopes: 'companies.read, companies.manage'. For fine-grained clients, you must have this permission: 'core.companies.read'.
- Read
Get a company
Get a company by ID. You must have at least one of these scopes: 'companies.read, companies.manage'. For fine-grained clients, you must have this permission: 'core.companies.read'.
- Write
Create a company
Use this call to create a new company. You must have at least one of these scopes: 'companies.create, companies.manage'. For fine-grained clients, you must have this permission: 'core.companies.create'.
- Write
Modify a company
Here is the list of operations that are currently allowed: - Replace name, invoicingEmail, phone, taxId, additionalTaxId, additionalTaxId2, invoiceNetworkIdentity, address, canCheckOutOnAr - Add, replace and remove rate plans You must have this scope: 'companies.manage'.
- Destructive
Delete a company
Deletes a company. Warning: This operation also removes company from all rate plans if not yet used. The deleted company won't be available in the company VAT report anymore. You must have this scope: 'companies.manage'.
Corporate Codes
- Read
Returns a list of corporate codes.
Returns all existing corporate codes that match given criteria. You must have this scope: 'rateplans.read-corporate'. For fine-grained clients, you must have this permission: 'core.corporatecodes.read'.
No Show Policy
- Read
Get all no-show policies.
Get the list of no-show policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.noshowpolicies.read'.
- Read
Get a specific no-show policy.
Get a specific no-show policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.noshowpolicies.read'.
- Write
Create a no-show policy.
Create a no-show policy. You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.noshowpolicies.create'.
- Write
Allows to modify properties of a no-show policy
Here is the list of operations that are currently allowed: - Replace name and description - Replace the fee details: fixed and percent values You must have at least one of these scopes: 'settings.manage, setup.manage'.
- Destructive
Delete a no-show policy
Use this call to delete a no-show policy. You must have this scope: 'setup.manage'. For fine-grained clients, you must have this permission: 'core.noshowpolicies.delete'.
Promo Codes
- Read
Returns a list of promo codes.
Returns all existing promo codes that match given criteria. You must have this scope: 'rateplans.read-corporate'. For fine-grained clients, you must have this permission: 'core.promocodes.read'.
Rate
- Read
Returns a list of rates.
Returns all rates for a specific rate plan within the specified time range. If a rate has not been initialized, it will still be returned, but anything besides the from and to values will be empty. The time range of a rate is defined by the time slice definition of the rate plan.
- Read
Returns the number of rates for a specific rate plan within the specifed time range.
To be able to count rates for a corporate rate plan a client must additionaly have the 'rateplans.read-corporate' scope. You must have at least one of these scopes: 'rates.read, rates.manage'. For fine-grained clients, you must have this permission: 'core.rates.read'.
- Write
Allows to patch multiple rates of a single rate plan.
Note that the specified PATCH operations are applied to each and every rate for the specified time ranges.
- Write
Allows to patch the rates of multiple rate plans.
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'.
- Destructive
Initializes and changes the rates for the rate plan.
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.
- Destructive
Deletes the rates for the rate plan
Deletes all rates in the specifed time range. You must have at least one of these scopes: 'rates.delete, rates.manage'. For fine-grained clients, you must have this permission: 'core.rates.delete'.
Rate Plan
- Read
Get a rate plan list
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.
- Read
Returns number of rate plans
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. The 'rateplans.read-corporate' scope adds corporate rate plans to the result number.
- Read
Get a rate plan
Get a rate plan by id. To be able to read a corporate rate plan a client must additionaly have 'rateplans.read-corporate' scope assigned. You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.
- Read
Check if a rate plan exists
Check if a rate plan exists by id. To be able to check if a corporate rate plan exists 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'.
- Write
Create a rate plan
Use this call to create a new rate plan. The rate plan will already contain empty rates, fill them later using PUT rates. You must have at least one of these scopes: 'rateplans.create, setup.manage'.
- Write
Allows to patch one or more rate plans
Here is the list of operations that are currently allowed: - Replace Name - Replace Description - Replace MinGuaranteeType - Replace PriceCalculationMode - Replace CancellationPolicy - Replace NoShowPolicy - Replace ChannelCodes - Replace Companies - Add, replace and remove Prom…
- Destructive
Delete multiple rate plans
Use this call to delete multiple rate plans. You must have at least one of these scopes: 'rateplans.delete, setup.manage'. For fine-grained clients, you must have this permission: 'core.rateplans.delete'.
- Destructive
Replace a rate plan
Use this call to modify a rate plan. You must have this scope: 'setup.manage'. For fine-grained clients, you must have this permission: 'core.rateplans.modify'.
- Destructive
Delete a rate plan
Use this call to delete a rate plan. You must have at least one of these scopes: 'rateplans.delete, setup.manage'. For fine-grained clients, you must have this permission: 'core.rateplans.delete'.
Rate Plan Actions
- Destructive
Archive a rate plan
Archive the specific rate plan. This action makes rate plan unavailable for all operations and cannot be undone. You must have this scope: 'setup.manage'. For fine-grained clients, you must have this permission: 'core.rateplans.archive'.
Service
- Read
Get all services.
Get the list of services. Pass languages to return each service's name and description in those languages (names and descriptions). languages=all returns every translation in one call. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.
- Read
Get a specific service.
Get a specific service. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.services.read'.
- Read
Check if a service exists
Check if a service exists by id. You must have at least one of these scopes: 'services.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.services.read'.
- Read
Returns number of services.
Returns number of services You must have at least one of these scopes: 'services.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.services.read'.
- Write
Create a service.
Create a service. You must have at least one of these scopes: 'services.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.services.create'.
- Write
Modify a service.
Here is the list of operations that are currently allowed: - Replace Name - Replace Description - Replace DefaultGrossPrice - Replace PricingUnit - Replace PostNextDay - Replace Availability - Add/Replace/Remove/Update AccountingConfigs - Replace ChannelCodes - Replace AgeCatego…
- Destructive
Delete a service
Use this call to delete a service. You must have at least one of these scopes: 'services.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.services.delete'.
Authorization
- Read
Returns a single authorization by ID
You must have at least one of these scopes: 'authorizations.read, authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.read'.
- Read
Returns a list of authorizations based on the query parameters
You must have at least one of these scopes: 'authorizations.read, authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.read'.
- Write
Creates a link to a payment form that allows guests to complete the authorization
You must have this scope: 'authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.create'.
- Write
Creates the authorization by using the terminal
You must have this scope: 'authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.create'.
- Write
Creates authorization by using a previously created payment account
You must have this scope: 'authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.create'.
- Write
Creates the authorization based on an existing pre-authorization created prior directly with the payment service provid…
Creates the authorization based on an existing pre-authorization created prior directly with the payment service provider. For the pre-authorization, please ensure to set the respective metadata in the original authorization request. The flow type has to be set to BlockNHold .
Authorization Actions
- Destructive
Cancels the authorization
You must have this scope: 'authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.modify'.
- Destructive
Updates the requested amount and extends the expiry date of the authorization
Allows to top up the authorization and renew expiry date. The top-up amount is specified in the payload and needs to be greater than the original amount. If the amount specified is the same as the original one, the authorization is renewed and changes its expiry date.
- Destructive
Expires the pending payment link with the payment provider and updates the status to Expired
You must have this scope: 'authorizations.manage'. For fine-grained clients, you must have this permission: 'core.authorizations.modify'.
Block
- Read
Returns a list of blocks
Returns a list of all blocks, filtered by the specified parameters. If no parameters are set, returns the entire list. You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.
- Read
Returns number of blocks
Returns number of blocks matching the filter criteria You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.read'.
- Read
Returns a specific block.
Retrieves a block, specified by its ID. You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.read'.
- Read
Check if a block exists
Check if a block exists by id You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.read'.
- Write
Creates a block
You must have at least one of these scopes: 'blocks.create, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.create'.
- Write
Allows to modify certain block properties
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'. For fine-grained clients, you must have this permission: 'core.blocks.modify'.
- Destructive
Delete a specific block
Use this call to delete a block. This is only possible as long as no reservation was picked up yet even if all of them are canceled You must have at least one of these scopes: 'blocks.manage, reservations.manage'.
Block Actions
- Destructive
Confirm a block.
Confirm a specific block which is in status 'Tentative'. This changes the status to 'Definite'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.confirm'.
- Destructive
Set a block to optional.
Set a specific block which is in status 'Tentative' to 'Optional'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.settooptional'.
- Destructive
Apply the optional cutoff behavior for a block whose cutoff has been reached.
Internal callback the scheduler invokes when an 'Optional' block's cutoff timer fires. Depending on the block's stored cutoff behavior, this either releases the block ('Optional' to 'Tentative') or leaves it untouched.
- Destructive
Convert an optional block to tentative when its booking window opens.
Internal callback the scheduler invokes when an 'Optional' block's start timer fires. It releases the block ('Optional' to 'Tentative'). A stale fire - the block already left 'Optional', or its stored start no longer matches the payload - is a no-op.
- Destructive
Release a block.
Release a specific block which is in status 'Definite'. This changes the status to 'Tentative'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.release'.
- Destructive
Cancel a block.
Cancel a specific block which is in status 'Definite' or 'Tentative'. This changes the status to 'Canceled'. You must have at least one of these scopes: 'blocks.manage, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.cancel'.
- Destructive
Wash a block.
Wash a specific block which is in status 'Definite'. This releases all unpicked units. You must have at least one of these scopes: 'blocks.manage, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.wash'.
- Destructive
Allow to modify a block
Use this call to modify a block. You must have at least one of these scopes: 'blocks.manage, reservations.manage'. For fine-grained clients, you must have this permission: 'core.blocks.amend'.
Booking
- Read
Returns a list of all bookings, filtered by the specified parameters.
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'.
- Read
Returns a specific booking.
Retrieves a booking with all its reservations. You must have at least one of these scopes: 'reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.bookings.read'.
- Write
Creates a booking for one or more reservations.
Creates a booking taking a list of reservations as input. You must have at least one of these scopes: 'reservations.create, reservations.manage'. For fine-grained clients, you must have this permission: 'core.bookings.create'.
- Write
Creates a booking for one or more reservations regardless of availability or restrictions.
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'. For fine-grained clients, you must have this permission: 'core.bookings.create.force'.
- Write
Add one or multiple reservations to an existing booking.
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'. For fine-grained clients, you must have this permission: 'core.bookings.modify'.
- Write
Add one or multiple reservations to an existing booking regardless of availability or restrictions.
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'. For fine-grained clients, you must have this permission: 'core.bookings.modify.
- Write
Allows to modify certain booking properties
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 - Add, replace and remove BookerComment - Copy PaymentAccount, Comment and BookerComment from the bookin…
Group
- Read
Returns a list of all group bookings, filtered by the specified parameters.
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'.
- Read
Returns a specific group booking.
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'. For fine-grained clients, you must have this permission: 'core.groups.read'.
- Read
Check if a certain group booking exists
Check if a group booking exists by id You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.groups.read'.
- Read
Returns number of group bookings
Returns number of group bookings matching the filter criteria You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.groups.read'.
- Write
Creates a group booking.
You must have at least one of these scopes: 'groups.create, reservations.manage'. For fine-grained clients, you must have this permission: 'core.groups.create'.
- Write
Allows to modify certain group booking properties
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…
- Write
Add one or multiple reservations to an existing group booking using blocked inventory.
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'. For fine-grained clients, you must have this permission: 'core.groups.modify'.
- Destructive
Delete a certain group booking
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'. For fine-grained clients, you must have this permission: 'core.groups.
Offer
- Read
Returns offers for one specific stay.
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'. For fine-grained clients, you must have this permission: 'core.offers.read'.
- Read
Returns offers for a specific rate plan.
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'. For fine-grained clients, you must have this permission: 'core.offers.read'.
- Read
Returns service offers for one specific stay.
You must have at least one of these scopes: 'offers.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.offers.read'.
- Read
Returns offers with rates and availabilities for the specified range.
Calculates and returns offers per time slice for a specific rate plan, arrival and departure date. Each time slice is priced as its own arrival, independent of the requested range. Prices are for adults only.
Payment Account
- Read
Returns a single payment account by ID
You must have at least one of these scopes: 'payment-accounts.read, payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.read'.
- Read
Returns a list of payment accounts based on the query parameters
You must have at least one of these scopes: 'payment-accounts.read, payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.read'.
- Write
Creates payment account by using the terminal
You must have this scope: 'payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.create'.
- Write
Creates a link to a payment form that allows guests to complete the payment account
You must have this scope: 'payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.create'.
- Write
Creates payment account based on an existing authorization created prior externally with the Payment Service Provider
You must have this scope: 'payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.create'.
- Write
Creates payment account based on an existing authorization created prior externally with the Payment Service Provider
You must have this scope: 'payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.create'.
Payment Account Actions
- Destructive
Sets payment account status to Canceled
You must have this scope: 'payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.cancel'.
- Destructive
Expires the pending payment link with the payment provider and updates the status to Expired
You must have this scope: 'payment-accounts.manage'. For fine-grained clients, you must have this permission: 'core.paymentaccounts.expirepaymentlink'.
Reservation
- Read
Returns a list of all reservations, filtered by the specified parameters.
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'.
- Read
Returns the number of reservations fulfilling the criteria specified in the parameters.
If no parameters are set, returns the total count of reservations. You must have at least one of these scopes: 'reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.read'.
- Read
Returns a specific reservation.
Retrieves a reservation, specified by its ID. You must have at least one of these scopes: 'reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.read'.
- Read
Returns offers for one specific reservation.
Calculates and returns offers for amending a specific reservation. You must have at least one of these scopes: 'offers.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.read'.
- Read
Returns service offers for one specific reservation.
Calculates and returns service offers for a specific reservation. You must have at least one of these scopes: 'offers.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.read'.
- Read
Returns the services booked for a specific reservation.
Returns the services booked for a specific reservation. You must have at least one of these scopes: 'reservations.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.read'.
- Write
Allows to modify certain reservation properties
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 RegisteredCard - Add, replace and remove TravelPurpose - Add, replace and remove…
- Destructive
Removes a service from a reservation.
Removes a service from a reservation. The service will not be removed if it is mandatory, already posted or if the service date is in the past. You must have this scope: 'reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.modify'.
Reservation Actions
- Destructive
Assign a unit to a reservation.
Assigns one of the available units to a reservation which is in state 'Confirmed' or 'InHouse'. You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.modify'.
- Destructive
Assign a specific unit to a reservation.
Assigns a specific unit to a reservation which is in state 'Confirmed' or 'InHouse'. If the unit is not available, the call will return an error, and no unit will be assigned. You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'.
- Destructive
Unassign units from a reservation.
Unassigns units for all time slices of the given reservation. If no units are assigned for the reservation nothing will happen. It will fail for reservations in status 'CheckedOut'. You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'.
- Destructive
Check-in of a reservation.
Check in a specific reservation which is in status 'Confirmed', and has a unit assigned. This changes the status to 'InHouse', and sets the check-in date and time. You must have this scope: 'reservations.manage'.
- Destructive
Reverses the check-in of a reservation.
You must have this scope: 'reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.modify'.
- Destructive
Check-out of a reservation.
Check out a specific reservation which is in status 'InHouse'. This changes the status to 'CheckedOut', and sets the check-out date and time. All open charges on the folio will be posted. Check-out is only possible, if the departure date is not later than tomorrow.
- Destructive
Cancel a reservation.
Cancel a specific reservation which is in status 'Confirmed' and where the arrival time is in the future. This changes the status to 'Canceled', and sets the cancellation date and time. You must have this scope: 'reservations.manage'.
- Destructive
Set a reservation to No-show.
Set a specific reservation to No-show which is in status 'Confirmed' and where the arrival date is in the past. This changes the status to 'NoShow', and sets the no-show date and time. You must have this scope: 'reservations.manage'.
- Destructive
Allows you to amend the stay details of a reservation
Modifies the stay-related data of a reservation. If a reservation is 'Confirmed', you can change all fields. If a reservation is 'InHouse', only changes to future time slices are possible.
- Destructive
Allows you to amend the stay details of a reservation regardless of availability or restrictions.
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.
- Destructive
Book the service for a specific reservation.
Use this to book a service for a specific reservation. Please note that when dates are specified, all desired dates must be specified or they will be removed if not posted to the folio.
- Destructive
Book the service for a specific reservation regardless of availability.
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.
- Destructive
Removes the city tax from a reservation.
Use this is you want to remove the city tax from a reservation before the stay. You must have this scope: 'reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.modify'.
- Destructive
Adds the city tax to a reservation.
Use this if you want to add the city tax to a reservation. You must have this scope: 'reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservations.modify'.
- Destructive
Lock unit assignment for a reservation.
Locks the currently assigned unit(s) for a reservation, preventing any reassignment or unassignment operations. Only reservations in 'Confirmed' or 'InHouse' status can be locked. At least one unit must be assigned to the reservation before locking.
- Destructive
Unlock unit assignment for a reservation.
Unlocks the currently assigned unit(s) for a reservation that were previously locked, allowing reassignment or unassignment operations. The unit assignment must currently be in a locked state. You must have this scope: 'reservations.manage'.
Folio
- Read
Returns a list of all folios.
Allowed actions are only returned, when the list is filtered by reservation ID. You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.read'.
- Read
Returns number of folios.
Returns number of folios matching the filter criteria. You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.read'.
- Read
Returns one folio.
Get a folio by ID. You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.read'.
- Read
Check if the folio exists.
Check if the folio exists. You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.read'.
- Write
Create additional folios for a reservation, or new external folios
Use this call to create a new folio. You must have at least one of these scopes: 'reservations.create, reservations.manage, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.create'.
- Write
Allows to modify certain properties of a folio
Here is the list of operations that are currently allowed: - Replace debitor (for guest folios only) - Add a company (not for house folios) - Replace/remove a company (not for house folios) You must have this scope: 'folios.manage'.
- Destructive
Deletes a folio.
Deletes a folio. This cannot be undone. You can delete a folio only if it's not a main folio, and the folio is empty (it has no charges, allowance, payments or pending payments). Requires 'allowed action': Delete. You must have this scope: 'folios.manage'.
Folio Actions
- Write
Adds and directly posts a charge to the folio. If there are any fees configured for the property, an additional charge…
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'.
- Write
Adds and directly posts a transitory charge to the folio. If there are any fees configured for the property, an additio…
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.
- Write
Adds and directly posts a cancellation fee to the folio. If there are any fees configured for the property, an addition…
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'.
- Write
Adds and directly posts a no-show fee to the folio. If there are any fees configured for the property, an additional ch…
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'. For fine-grained clients, you must have this permission: 'core.folios.
- Write
Posts an allowance for a charge
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'. For fine-grained clients, you must have this permission: 'core.folios.postchargeallowance'.
- Write
Posts an allowance for a folio
Allowance value posted must not exceed sum of charges minus existing allowances You must have at least one of these scopes: 'allowances.post, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.postfolioallowance'.
- Write
Posts allowances for a folio
Allowance value posted must not exceed sum of charges minus existing allowances You must have at least one of these scopes: 'allowances.post, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.postchargeallowance'.
- Write
Corrects a folio by moving some charges. This operation creates a new folio with the charges from the request.
Allowance value posted must not exceed sum of charges minus existing allowances You must have this scope: 'folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.correct'.
- Write
Splits a charge into two using the percent or amount provided Creates an allowance and two new charges.
You must have at least one of these scopes: 'allowances.post, charges.create, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.splitcharge'.
- Write
Splits a payment into two using the percent or amount provided Creates a refund and two new payments.
You must have at least one of these scopes: 'payments.create, refunds.create, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.splitpayment'.
- Destructive
Closes a folio.
Mark a folio as closed to prevent adding charges and payments. This action cannot be undone, and is only possible if the balance is 0. Requires 'allowed action': Close. You must have this scope: 'folios.manage'.
- Destructive
Reopens a folio.
Reopens a closed folio. You can only reopen a folio if no invoice has been created for the folio. Otherwise, use invoice-actions/{invoiceId}/cancel endpoint to cancel an invoice and reopen the folio. Requires 'allowed action': Reopen. You must have this scope: 'folios.manage'.
- Destructive
Move multiple charges, allowances and transitory charges from one folio to another.
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.
- Destructive
Move multiple charges from one folio to another. Multiple source folios and multiple target folios can be specified.
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.
- Destructive
Move all charges and transitory charges from one folio to another.
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'. For fine-grained clients, you must have this permission: 'core.folios.movecharge'.
- Destructive
Posts all unposted charges for the whole length of stay.
Use this call for cases when the folio should be closed early.
- Destructive
Move multiple payments from one guest/booking folio to another.
Move payments from one guest/booking folio to another - moving between different bookings is not supported, and will lead to an error. If one of the folios is closed, this action cannot be performed.
Folio Payments
- Read
Get a list of payments.
Returns a list of all payments for this folio ordered by creation date, newest first You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.foliopayments.read'.
- Read
Get a payment by ID.
Get a payment by its ID You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.foliopayments.read'.
- Read
Get a list of refunds.
Returns a list of all refunds for this folio ordered by creation date, newest first You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.foliorefunds.read'.
- Read
Get a refund by ID.
Get a refund by its ID You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.foliorefunds.read'.
- Write
Trigger a custom payment for the folio.
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.
- Write
Trigger a payment on a card terminal for the folio.
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.
- Write
Captures a specific amount from a pre-authorization and posts it to the folio.
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 CaptureOnly .
- Write
Trigger a payment using the payment account stored on the reservation or booking.
Trigger a payment for the folio using the payment account stored on the reservation or booking. The payment will be processed asynchronously. Use the location header to poll for the status of the payment.
- Write
Creates a link to a payment form where guests can pay.
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.
- Write
Trigger a refund for the folio.
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.
- Write
Trigger a refund for a specific payment.
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.
- Destructive
Cancels a pending payment link.
Sets a pending payment with payment link to cancelled and triggers the cancellation. You must have this scope: 'folios.manage'. For fine-grained clients, you must have this permission: 'core.foliopayments.cancel'.
Invoice
- Read
Gets a preview invoice PDF for one specific folio.
Gets a preview invoice PDF for one specific folio. You must have this scope: 'invoices.read'. For fine-grained clients, you must have this permission: 'core.invoices.read'.
- Read
Gets an invoice preview for one specific folio.
To see if the invoice creation would be successful, check the warnings. You must have this scope: 'invoices.read'. For fine-grained clients, you must have this permission: 'core.invoices.read'.
- Read
Gets the list of all invoices (the metadata only, not the files).
Gets the list of all invoices (the metadata only, not the files). You must have this scope: 'invoices.read'. For fine-grained clients, you must have this permission: 'core.invoices.read'.
- Read
Gets an invoice PDF file.
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'. For fine-grained clients, you must have this permission: 'core.invoices.read'.
- Read
Gets invoice data.
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'. For fine-grained clients, you must have this permission: 'core.invoices.read'.
- Write
Creates an invoice for one specific folio.
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.
Invoice Action
- Destructive
Marks an invoice as paid.
Settles the invoice, if the invoice has an amount to be paid (total != 0). You must have this scope: 'invoices.manage'. For fine-grained clients, you must have this permission: 'core.invoiceactions.pay'.
- Destructive
Cancels an invoice
For regular invoices and AR invoices that haven't been paid yet, creates a new cancellation invoice and opens the folio again. For advance invoices, creates a new cancellation invoice. For deposit invoices, creates a deposit cancellation.
Routing
- Read
Get all routings.
You must have at least one of these scopes: 'routings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.routings.read'.
- Read
Get a specific routing.
You must have at least one of these scopes: 'routings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.routings.read'.
- Write
Create a routing.
You must have at least one of these scopes: 'routings.create, routings.manage'. For fine-grained clients, you must have this permission: 'core.routings.create'.
- Write
Modify a routing.
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'. For fine-grained clients, you must have this permission: 'core.routings.modify'.
- Destructive
Delete a routing.
Use this call to delete a routing. You must have at least one of these scopes: 'routings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.routings.delete'.
Sub Ledger
- Read
Returns the chart of accounts of the subledger.
Returns the schema of subledger, split into global and guest ledger. You must have at least one of these scopes: 'subledger.read, accounting.read'. For fine-grained clients, you must have this permission: 'core.subledgerschema.read'.
- Read
Returns a list of global accounts.
Returns a list of accounts in one property, having the same global account as parent. You must have at least one of these scopes: 'subledger.read, accounting.read'. For fine-grained clients, you must have this permission: 'core.subledgerglobalaccounts.read'.
- Read
Returns a list of guest accounts.
Returns a list of accounts in one property for a reservation. You must have at least one of these scopes: 'subledger.read, accounting.read'. For fine-grained clients, you must have this permission: 'core.subledgerguestaccounts.read'.
- Read
Returns a list of external accounts.
Returns a list of accounts in one property for a folio. You must have at least one of these scopes: 'subledger.read, accounting.read'. For fine-grained clients, you must have this permission: 'core.subledgerexternalaccounts.read'.
- Read
Returns one account.
Returns one account, as specified by its number and the property. You must have at least one of these scopes: 'subledger.read, accounting.read'. For fine-grained clients, you must have this permission: 'core.subledgeraccounts.read'.
- Read
Returns a list of child accounts for a specified parent account.
You must have at least one of these scopes: 'subledger.read, accounting.read'. For fine-grained clients, you must have this permission: 'core.subledgeraccounts.read'.
- Write
Aggregates transactions pairs by date (business day) 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'. For fine-grained clients, you must have this permission: 'core.subledgeraggregate.create'.
- Write
Aggregates transactions by date (business day) for all accounts and a given period.
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'.
- Write
Aggregates transactions by timestamp for all accounts and a given period.
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'.
- Write
Returns transactions filtered by timestamp for a property for a given period.
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'.
- Write
Returns transactions filtered by date (business day) for a property for a given period.
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'.
- Write
Returns gross transactions filtered by date (business day) for a property for a given period.
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'.
Capture Policies
- Read
Get all capture policies.
Get the list of capture policies. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.capturepolicies.read'.
- Read
Get a specific capture policy.
Get a specific capture policy. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.capturepolicies.read'.
- Write
Allows to modify properties of a capture policy.
Here is the list of operations that are currently allowed: - Replace captureNoShowFee flag - Replace captureCancellationFee flag - Replace capturePrepayment flag - Replace PostOtaBankTransferOnCheckOut flag - Replace capturePayment configuration You must have at least one of the…
City Tax
- Read
Get all city taxes.
Get the list of all city taxes. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.citytaxes.read'.
- Read
Get a specific city tax.
Get a specific city tax. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.citytaxes.read'.
- Write
Create a city tax.
You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.citytaxes.create'.
- Write
Allows to modify city tax
Here is the list of operations that are currently allowed: - Replace name and description - Replace type - Replace taxHandlingType - Replace value - Replace limit - Replace, add, or remove subcategories - Replace, add, or remove pricingRules - Replace vatType - Replace priority…
- Destructive
Delete a city tax
Use this call to delete a city tax. You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.citytaxes.delete'.
Custom Sub Accounts
- Read
Returns a list of all sub-accounts.
Returns a list of all sub-accounts. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.subaccounts.read'.
- Read
Returns number of sub-accounts.
Returns number of sub-account. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.subaccounts.read'.
- Read
Returns one sub-account.
Get a sub-account by ID. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.subaccounts.read'.
- Read
Check if the sub-account exists.
Check if the sub-account exists. You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.subaccounts.read'.
- Write
Create a sub-account.
Create a sub-account. You must have at least one of these scopes: 'subledger.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.subaccounts.create'.
- Write
Allows to modify the name of the sub-account.
Allows to modify the name of the sub-account. You must have at least one of these scopes: 'subledger.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.subaccounts.modify'.
- Destructive
Delete a custom sub-account
Use this call to delete a custom sub-accounts. When you delete a custom sub-account, the corresponding accounting accounts are either archived (if there are some transactions posted), or deleted (if no transactions were posted).
Feature Settings
- Read
Get feature settings for a property.
Get feature settings for a property. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.features.read'.
- Write
Allows to modify feature settings
Here is the list of operations that are currently allowed: - Replace areCustomRevenueSubAccountsEnabled flag - Replace performAccountingForOpenInvoiceActions flag - Replace showRecipientForEachLineItemOnTheInvoice flag - Replace addCityTaxOnReservationCreation flag - Replace max…
Invoice Address
- Read
Get invoice addresses
Get the list of all invoice addresses. You must have at least one of these scopes: 'setup.read, setup.manage, settings.read, settings.manage'. For fine-grained clients, you must have this permission: 'core.invoiceaddresses.read'.
- Write
Change fields in the invoice address of one or more properties.
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'.
- Destructive
Create or update invoice addresses for one or more properties.
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'.
Languages
- Read
Get the language settings for the account
Get the language settings You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.languages.read'.
- Destructive
Replaces the language settings for the account
Use this call to modify the language settings of the account. You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.languages.modify'.
Market Segment
- Read
Get a market segment.
Get a market segment by id. You must have at least one of these scopes: 'setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.marketsegments.read'.
- Read
Check if a market segment exists.
Check if a market segment exists by id. You must have at least one of these scopes: 'setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.marketsegments.read'.
- Read
Returns a list of all market segments, filtered by the specified parameters.
You must have at least one of these scopes: 'setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.marketsegments.read'.
- Read
Returns number of market segments.
Returns number of market segments. You must have at least one of these scopes: 'setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.marketsegments.read'.
- Write
Allows to modify market segment.
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 of these scopes: 'settings.manage, setup.manage'.
- Write
Create a market segment
You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.marketsegments.create'.
- Destructive
Delete a market segment.
Use this call to delete a market segment. You must have this scope: 'setup.manage'. For fine-grained clients, you must have this permission: 'core.marketsegments.delete'.
Property Settings
- Read
Get property settings
Get base settings for a property. You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'. For fine-grained clients, you must have this permission: 'core.propertysettings.read'.
Time Slice Definitions
- Read
Get a specific time slice definition
Get a specific time slice definition for a property. A time slice definition specifies the pattern for recurring time slots. The time slots define when reservations in the property can start or end. It is used in the rate plans when managing prices for renting out the units.
- Read
Get time slice definitions
Get all time slice definitions for a property. A time slice definition specifies the pattern for recurring time slots. The time slots define when reservations in the property can start or end. They are used in the rate plans when managing prices for renting out the units.
- Write
Modifies a specific time slice definition for the property
Use this call to modify a time slice definition of the property.
- Write
Creates a time slice definition
Use this call to create a time slice definition. You must have at least one of these scopes: 'settings.manage, setup.manage'. For fine-grained clients, you must have this permission: 'core.timeslicedefinitions.create'.
- Destructive
Delete a certain time slice definition
Use this call to delete a time slice definition. This is only possible if a time slice definition is not in-use You must have at least one of these scopes: 'settings.manage, setup.manage'.
Account
- Read
Returns the current account.
Retrieves information about the current account. You need to be authorized (no particular scope required) For fine-grained clients, you must have this permission: 'core.currentaccount.read'.
- Read
Returns all accounts.
Get the list of accounts. You must have this scope: 'accounts.read'. For fine-grained clients, you must have this permission: 'core.accounts.read'.
- Write
Creates an account with an admin user.
Use this call to create a new account. You must have this scope: 'account.create'. For fine-grained clients, you must have this permission: 'core.accounts.create'.
- Destructive
Replaces an existing account.
Completely replaces an account with the new definition passed in. The old data will be lost. You must have this scope: 'account.manage'. For fine-grained clients, you must have this permission: 'core.currentaccount.modify'.
Account Actions
- Destructive
Suspend the account.
Suspends the current account. This changes the account type to 'Suspended'. You must have this scope: 'account.manage'. For fine-grained clients, you must have this permission: 'core.currentaccount.suspend'.
- Destructive
Move the account to live.
Move the current account to live. This changes the account type to 'Live'. You must have this scope: 'account.manage'. For fine-grained clients, you must have this permission: 'core.currentaccount.setlive'.
Maintenance
- Read
Get list of maintenances
Get a list of maintenances matching your filter. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'. For fine-grained clients, you must have this permission: 'core.maintenances.read'.
- Read
Returns number of maintenances
Returns the number of maintenances matching your filter. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'. For fine-grained clients, you must have this permission: 'core.maintenances.read'.
- Read
Get a specific maintenance
Get a specific maintenance by ID. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'. For fine-grained clients, you must have this permission: 'core.maintenances.read'.
- Read
Check if a maintenance exists
Check if a maintenance exists by ID. You must have at least one of these scopes: 'maintenances.read, maintenances.manage'. For fine-grained clients, you must have this permission: 'core.maintenances.read'.
- Write
Create a new maintenance window
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'.
- Write
Create multiple maintenances
Use this call to create multiple maintenances. You must have at least one of these scopes: 'maintenances.create, setup.manage'. For fine-grained clients, you must have this permission: 'core.maintenances.create'.
- Write
Modify a maintenance
You can only change maintenances which are in the future or still ongoing today. Here is the list of operations that are currently allowed: - Add, replace and remove Description - Replace From and To. 'From' cannot be changed, if the maintenance started yesterday or before.
- Destructive
Delete a maintenance
Use this call to delete a maintenance. It is not possible to delete maintenances that started yesterday or earlier. You must have at least one of these scopes: 'maintenances.delete, maintenances.manage'. For fine-grained clients, you must have this permission: 'core.maintenances.
Operations
- Destructive
Performs the night audit for one property.
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'.
- Destructive
Change the condition of a unit
You must have this scope: 'operations.change-room-state'. For fine-grained clients, you must have this permission: 'core.unitcondition.modify'.
Booking Logs
- Read
Returns reservation change log entries sorted by the timestamp
You must have this scope: 'logs.read'. For fine-grained clients, you must have this permission: 'core.reservationlog.read'.
Finance Logs
- Read
Returns folio change log entries sorted by the timestamp.
You must have this scope: 'logs.read'. For fine-grained clients, you must have this permission: 'core.foliolog.read'.
- Read
Returns the night audit logs.
Returns a log of all night audits Newest log entries are returned first. You must have this scope: 'logs.read'. For fine-grained clients, you must have this permission: 'core.nightauditlog.read'.
- Read
Returns the audit log for all accounting exports that have been done.
Returns the audit log for all exports if accounting data that have been done. You must have this scope: 'logs.read'. For fine-grained clients, you must have this permission: 'core.transactionsexportlog.read'.
Reports
- Read
List of ordered services
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'. For fine-grained clients, you must have this permission: 'core.orderedservicesreports.read'.
- Read
Returns the number of arrivals in a month for a property
Returns number of arriving guests for a property for a certain month. Only over-night time slices are considered. Includes statistical information on purpose of travel, and nationality. The data is taken from the primary guest only.
- Read
Returns the property performance report which includes the ADR and the RevPAR for each business day.
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.
- Read
Returns the list of company invoices with information on the company and the VAT breakdown
You must have this scope: 'reports.read'. For fine-grained clients, you must have this permission: 'core.companyinvoicesvatreports.read'.
- Read
Returns the revenues report for a property
You must have this scope: 'reports.read'. For fine-grained clients, you must have this permission: 'core.revenuesreports.read'.
Availability
- Read
Get a list of all available units in a property
Get the list of available units for a specific property and time period. You must have this scope: 'availability.read'. For fine-grained clients, you must have this permission: 'core.unitsavailability.read'.
- Read
Get a list of all available unit groups in a property
Get the list of available unit groups for a specific property and time period. You must have this scope: 'availability.read'. For fine-grained clients, you must have this permission: 'core.unitgroupsavailability.read'.
- Read
Get a list of all available services in a property
Get the list of available services for a specific property and time period. You must have this scope: 'availability.read'. For fine-grained clients, you must have this permission: 'core.servicesavailability.read'.
- Read
Get house-level overbooking for a given property.
You must have this scope: 'availability.read'. For fine-grained clients, you must have this permission: 'core.propertiesavailability.read'.
- Write
Allows to modify the unit group availability
You can replace AllowedOverbooking for a unit group You must have this scope: 'availability.manage'. For fine-grained clients, you must have this permission: 'core.unitgroupsavailability.modify'.
- Write
Allows to modify availability of a given property.
You can replace HouseOverbookingLimit on the property-level. You must have this scope: 'availability.manage'. For fine-grained clients, you must have this permission: 'core.propertiesavailability.modify'.
Reservation Availability
- Read
Get a list of all available units for a reservation
Get the list of available units for a specific reservation and time period. You must have at least one of these scopes: 'availability.read, reservations.manage'. For fine-grained clients, you must have this permission: 'core.reservationsavailability.read'.
No operations match.
See How connections work for access and permissions, or browse all integrations.