The Apaleo connector lets your AI agent act in each user's Apaleo account. Each user signs in to Apaleo once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 92 tools.
- Tools
- 92
- What they doRead · write · destructive
- 55 · 33 · 455 read33 write4 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Apaleo app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Apaleo connection
In AgentKit > Connections, create an Apaleo connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Apaleo connections use your own OAuth app. Register one with Apaleo and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Apaleo connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'apaleo'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Apaleo:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'apaleo_count_properties',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "apaleo"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Apaleo:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="apaleo_count_properties",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolapaleo_count_propertiesCount the properties in the account.Read-onlyCount Properties
Count the properties in the account. Returns an object with `count`. Use when only the number of properties matters. Use list_properties for the records.
Inputs
This tool takes no inputs.
apaleo_count_reservationsCount reservations matching the filters.Read-onlyCount Reservations
Count reservations matching the filters. Returns an object with `count`. Use when only the total matters.
Inputs
allFoliosHaveInvoiceboolean- If set to `true`, returns only reservations, in which all folios are closed and have an invoice. If set to `false`, returns only reservations, in which some of the folios are open or don't have an invoice
balanceFilterstring- This will filter reservations based on their balance. You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean... Comma-separated list.
blockIdsstring- Filter result by requested blocks Comma-separated list.
bookingIdstring- Filter result by booking id
channelCodestring- Filter result by the channel code Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
companyIdsstring- Filter result by requested companies Comma-separated list.
dateFilterstring- Filter by date and time attributes of reservation. Use in combination with the 'To' and 'From' attributes. All filters will check if the date specified by the filter type is between from (included) and to (excluded). The exception being filtering for 'stay', which will return all reservations that are overlapping with the interval specified by from and to.one of
ArrivalDepartureStayCreationModificationCancellationArrivalAndCheckInDepartureAndCheckOut externalCodestring- Filter result by the external code. The result set will contain all reservations that have an external code starting with the provided value
externalReferencesstring- This will filter all reservation where the provided external references have an exact match on at least one of the properties in Apaleo.Api.Modules.Booking.Models.Reservation.ExternalReferencesModel Comma-separated list.
fromstring- The start of the time interval. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
hasActivePaymentAccountboolean- If set to `true`, returns only the reservations with an active payment account. If set to `false`, returns only the reservations without an active payment account.
isPreCheckedInboolean- If set to `true`, returns only the reservations marked as pre-checked-in. If set to `false`, returns only the reservations not marked as pre-checked-in.
marketSegmentIdsstring- Filter result by requested market segments Comma-separated list.
propertyIdsstring- Filter result by requested properties Comma-separated list.
ratePlanIdsstring- Filter result by requested rate plans Comma-separated list.
sourcesstring- Filter result by source Comma-separated list.
statusstring- Filter result by reservation status Comma-separated list of: Confirmed, InHouse, CheckedOut, Canceled, NoShow.
textSearchstring- Filters reservations by searching for the provided text across multiple fields. The search is case-insensitive and includes: - Booker information (first name, last name, email, company name) - Primary guest information (first name, last name, email, company name) - Additional guest information (first name, last name, email, company name) - Reservation details (external code, external references, reservation ID) - Unit name - Group name
tostring- The end of the time interval, must be larger than 'from'. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
unitGroupIdsstring- Filter result by requested unit groups Comma-separated list.
unitGroupTypesstring- Filter result by requested unit group types Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
unitIdsstring- Filter result by assigned units Comma-separated list.
validationMessageCategorystring- Filter result by validation message category Comma-separated list of: OfferNotAvailable, AutoUnitAssignment, GuestLoyalty.
apaleo_get_arrivals_reportGet the arrivals and departures report for a property over a date range.Read-onlyGet Arrivals Report
Get the arrivals and departures report for a property over a date range. Returns an object with `total`, `totalAdults`, `totalChildren`, `travelPurposeBreakdown`, `nationalityBreakdown`, `countryOfResidenceBreakdown`. Use for front-desk planning.
Inputs
monthintegerrequired- Requested month for the report.
propertyIdstringrequired- Requested property.
yearintegerrequired- Requested year for the report.
apaleo_get_blockGet one room block by its id.Read-onlyGet Block
Get one room block by its id. Returns an object with `id`, `group`, `status`, `property`, `ratePlan`, `unitGroup`, `grossDailyRate` and more. Use after list_blocks for details.
Inputs
blockIdstringrequired- Id of the block to be retrieved.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: actions, timeSlices. All other values will be silently ignored. Comma-separated list of: actions, timeSlices.
apaleo_get_bookingGet one booking, including its booker and reservations.Read-onlyGet Booking
Get one booking, including its booker and reservations. Returns an object with `id`, `groupId`, `booker`, `paymentAccount`, `hasActivePaymentAccount`, `registeredCard`, `comment` and more. Use after list_bookings for the full booking.
Inputs
bookingIdstringrequired- Id of the booking to be retrieved.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, ratePlan, services, reservations, propertyValues. All other values will be silently ignored. Comma-separated list of: property, unitGroup, ratePlan, services, reservations, propertyValues.
apaleo_get_companyGet one company by its id.Read-onlyGet Company
Get one company by its id. Returns an object with `id`, `code`, `propertyId`, `name`, `invoicingEmail`, `phone`, `taxId` and more. Use after list_companies for a single company's details.
Inputs
companyIdstringrequired- The ID of the company.
apaleo_get_current_accountGet the Apaleo account the connected user belongs to.Read-onlyGet Current Account
Get the Apaleo account the connected user belongs to. Returns an object with `code`, `name`, `description`, `defaultLanguage`, `logoUrl`, `location`, `type` and more. Use first to confirm which account is connected.
Inputs
This tool takes no inputs.
apaleo_get_folioGet one folio with its charges, payments and balance.Read-onlyGet Folio
Get one folio with its charges, payments and balance. Returns an object with `id`, `created`, `updated`, `type`, `debitor`, `closingDate`, `reservation` and more. Use after list_folios for the full bill.
Inputs
folioIdstringrequired- The ID of the folio.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: folios. All other values will be silently ignored. Comma-separated list of: folios.
apaleo_get_groupGet one group booking by its id.Read-onlyGet Group Booking
Get one group booking by its id. Returns an object with `id`, `name`, `from`, `to`, `booker`, `comment`, `bookerComment` and more. Use after list_groups for details.
Inputs
groupIdstringrequired- Id of the group booking to be retrieved.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: blocks, actions. All other values will be silently ignored. Comma-separated list of: blocks, actions.
apaleo_get_invoiceGet one invoice by its id.Read-onlyGet Invoice
Get one invoice by its id. Returns an object with `id`, `number`, `type`, `series`, `to`, `paymentSettled`, `status` and more. Use after list_invoices for details.
Inputs
invoiceIdstringrequired- The invoice ID.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: company. All other values will be silently ignored. Comma-separated list of: company.
apaleo_get_maintenanceGet one maintenance task by its id.Read-onlyGet Maintenance
Get one maintenance task by its id. Returns an object with `id`, `unit`, `from`, `to`, `type`, `description`. Use after list_maintenances for details.
Inputs
maintenanceIdstringrequired- The ID of the maintenance.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: unit. All other values will be silently ignored. Comma-separated list of: unit.
apaleo_get_propertyGet one property by its id, including address, currency and time zone.Read-onlyGet Property
Get one property by its id, including address, currency and time zone. Returns an object with `id`, `code`, `propertyTemplateId`, `isTemplate`, `name`, `description`, `companyName` and more. Use after list_properties when you need details of a single property.
Inputs
propertyIdstringrequired- The id of the property.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored. Comma-separated list of: actions.
languagesstring- 'all' or comma separated list of two-letter language codes (ISO Alpha-2) Comma-separated list.
apaleo_get_property_availabilityGet house-level overbooking settings for a property.Read-onlyGet Property Availability
Get house-level overbooking settings for a property. Returns an object with `timeSlices`, `count`. Use to read the overbooking limit of a property.
Inputs
fromstringrequired- The first day of the time period from which availability will be modified.
propertyIdstringrequired- The ID of the property.
timeSliceTemplatestringrequired- The time slice template.one of
DayUseOverNight tostringrequired- The last day of the time period until which availability will be modified.
unitGroupTypestringrequired- The unit group type.one of
BedRoomMeetingRoomEventSpaceParkingLotOther
apaleo_get_property_performance_reportGet occupancy, ADR and RevPAR figures for a property over a date range.Read-onlyGet Property Performance Report
Get occupancy, ADR and RevPAR figures for a property over a date range. Returns an object with `houseCount`, `houseItemsCount`, `soldCount`, `soldItemsCount`, `unsoldCount`, `unsoldItemsCount`, `outOfOrderCount` and more. Use for performance summaries.
Inputs
fromstringrequired- The inclusive start date of the interval
propertyIdstringrequired- The ID of the property
tostringrequired- The inclusive end date of the interval
channelCodesstring- The channel codes used to filter the retrieved data Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
companyIdsstring- The company IDs used to filter the retrieved data Comma-separated list.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: businessDays. All other values will be silently ignored. Comma-separated list of: businessDays.
marketSegmentIdsstring- The market segment IDs used to filter the retrieved data Comma-separated list.
ratePlanIdsstring- The rate plan IDs used to filter the retrieved data Comma-separated list.
sourcesstring- The sources used to filter the retrieved data Comma-separated list.
timeSliceDefinitionIdsstring- The time slice definition IDs used to filter the retrieved data Comma-separated list.
travelPurposestring- The travel purpose to filter the retrieved dataone of
BusinessLeisure unitGroupIdsstring- The unit group IDs used to filter the retrieved data Comma-separated list.
unitGroupTypesstring- The unit group types used to filter the retrieved data Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
apaleo_get_property_settingsGet the settings of a property such as check-in times and policies.Read-onlyGet Property Settings
Get the settings of a property such as check-in times and policies. Returns an object with `timeZone`, `currency`. Use to read configuration rather than inventory data.
Inputs
propertyIdstringrequired- The id of the property.
apaleo_get_rate_planGet one rate plan by its id.Read-onlyGet Rate Plan
Get one rate plan by its id. Returns an object with `id`, `code`, `name`, `description`, `minGuaranteeType`, `priceCalculationMode`, `property` and more. Use after list_rate_plans for details of a single rate plan.
Inputs
ratePlanIdstringrequired- The id of the rate plan.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, cancellationPolicy. All other values will be silently ignored. Comma-separated list of: property, cancellationPolicy.
languagesstring- 'all' or comma separated list of two-letter language codes (ISO Alpha-2) Comma-separated list.
apaleo_get_reservationGet one reservation with guest, stay, price and unit details.Read-onlyGet Reservation
Get one reservation with guest, stay, price and unit details. Returns an object with `id`, `bookingId`, `blockId`, `groupName`, `status`, `checkInTime`, `checkOutTime` and more. Use after list_reservations for a single stay.
Inputs
reservationIdstringrequired- Id of the reservation to be retrieved.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: timeSlices, services, booker, actions, company, assignedUnits. All other values will be silently ignored. Comma-separated list of: timeSlices, services, booker, actions, company, assignedUnits.
apaleo_get_revenues_reportGet revenue totals by account for a property over a date range.Read-onlyGet Revenues Report
Get revenue totals by account for a property over a date range. Returns an object with `account`, `netAmount`, `grossAmount`, `children`. Use for revenue breakdowns.
Inputs
fromstringrequired- The inclusive start date of the interval.
propertyIdstringrequired- Property ID
tostringrequired- The exclusive end date of the interval. The interval is limited to one year.
languageCodestring- The language for the the report
apaleo_get_serviceGet one service by its id.Read-onlyGet Service
Get one service by its id. Returns an object with `id`, `code`, `name`, `description`, `defaultGrossPrice`, `pricingUnit`, `postNextDay` and more. Use after list_services for details of a single service.
Inputs
serviceIdstringrequired- The id of the service.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property. All other values will be silently ignored. Comma-separated list of: property.
languagesstring- 'all' or comma separated list of two-letter language codes (ISO Alpha-2) Comma-separated list.
apaleo_get_unitGet one unit by its id.Read-onlyGet Unit
Get one unit by its id. Returns an object with `id`, `name`, `description`, `property`, `unitGroup`, `connectingUnit`, `status` and more. Use after list_units for a single unit's details.
Inputs
unitIdstringrequired- The id of the unit.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits, actions. All other values will be silently ignored. Comma-separated list of: property, unitGroup, connectedUnits, actions.
languagesstring- 'all' or comma separated list of two-letter language codes (ISO Alpha-2) Comma-separated list.
apaleo_get_unit_groupGet one unit group by its id.Read-onlyGet Unit Group
Get one unit group by its id. Returns an object with `id`, `code`, `property`, `name`, `memberCount`, `description`, `maxPersons` and more. Use after list_unit_groups for a single room type's details.
Inputs
unitGroupIdstringrequired- The id of the unit group.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, connectedUnitGroups. All other values will be silently ignored. Comma-separated list of: property, connectedUnitGroups.
languagesstring- 'all' or comma separated list of two-letter language codes (ISO Alpha-2) Comma-separated list.
apaleo_list_available_servicesList the availability of services in a property over a time range.Read-onlyList Available Services
List the availability of services in a property over a time range. Returns an object with `timeSlices`, `count`. Use for services with limited capacity.
Inputs
fromstringrequired- First day of the requested time period. The given day will be included in the response.
propertyIdstringrequired- The property id
tostringrequired- Last day of the requested time period. The given day will be included in the response.
channelCodesstring- The channel code used to filter the services Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
timeSliceDefinitionIdsstring- The time slice definition ids Comma-separated list.
timeSliceTemplatestring- The time slice template, defaults to 'over night'one of
DayUseOverNight
apaleo_list_available_unit_groupsList the availability of unit groups (room types) in a property over a time range.Read-onlyList Available Unit Groups
List the availability of unit groups (room types) in a property over a time range. Returns an object with `timeSlices`, `count`. Use to check how many rooms of each type are free.
Inputs
fromstringrequired- First day of the requested time period. The given day will be included in the response.
propertyIdstringrequired- The property id
tostringrequired- Last day of the requested time period. The given day will be included in the response.
adultsinteger- The number of adults you want availability for, defaults to 1
childrenAgesstring- The ages of the children you want availability for Comma-separated list.
onlySellableboolean- When set to 'true', only the unit groups sold by the specified time slice template and time slice definition ids are returned, otherwise all unit groups are returned
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
timeSliceDefinitionIdsstring- The time slice definition ids Comma-separated list.
timeSliceTemplatestring- The time slice template, defaults to 'over night'one of
DayUseOverNight unitGroupIdsstring- The unit group ids Comma-separated list.
unitGroupTypesstring- Filter result by requested unit group types Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
apaleo_list_available_unitsList units available for a property in a time range.Read-onlyList Available Units
List units available for a property in a time range. Returns an object with `units`, `count`. Use to check which specific rooms are free. Use list_available_unit_groups for room-type availability.
Inputs
fromstringrequired- The from date and time A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
propertyIdstringrequired- The property id
tostringrequired- The to date and time A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
includeOutOfServiceboolean- Should units that are set OutOfService in the defined time period be returned as available.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
unitAttributeIdsstring- Return units with the specific unit attributes Comma-separated list.
unitConditionstring- The unit conditionone of
CleanCleanToBeInspectedDirty unitGroupIdstring- The unit group id
apaleo_list_blocksList room blocks held for groups.Read-onlyList Blocks
List room blocks held for groups. Returns an object with `blocks`, `count`. Use to see blocked inventory.
Inputs
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: actions, timeSlices. All other values will be silently ignored. Comma-separated list of: actions, timeSlices.
fromstring- The start of the time range. All blocks that are overlapping with the interval specified by from and to will be returned A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
groupIdstring- Return blocks for the specific group
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdsstring- Return blocks filtered by properties Comma-separated list.
ratePlanIdsstring- Return blocks with any of the specified rate plans Comma-separated list.
statusstring- Return blocks filtered by statuses Comma-separated list of: Tentative, Definite, Canceled, Optional.
timeSliceDefinitionIdsstring- Return blocks with any of the specified time slice definitions Comma-separated list.
timeSliceTemplatestring- The time slice template, defaults to 'over night'one of
DayUseOverNight tostring- The end of the time range. All blocks that are overlapping with the interval specified by from and to will be returned A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
unitGroupIdsstring- Return blocks with any of the specified unit groups Comma-separated list.
unitGroupTypesstring- Return blocks with any of the specified unit group types Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
apaleo_list_booking_sourcesList the booking source values that reservations can use.Read-onlyList Booking Sources
List the booking source values that reservations can use. Returns an object with `sources`. Use to pick a valid source when creating a booking.
Inputs
This tool takes no inputs.
apaleo_list_bookingsList bookings, filtered by property, guest, dates or status.Read-onlyList Bookings
List bookings, filtered by property, guest, dates or status. Returns an object with `bookings`, `count`. Use to find a booking. Use list_reservations to work at the individual stay level.
Inputs
bookingIdsstring- Filter result by booking id. Returns only the bookings matching the specified ids Comma-separated list.
channelCodestring- Filter result by the channel code. The resul set will contain all bookings having reservations with the specified channel code Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, ratePlan, services, reservations. All other values will be silently ignored. Comma-separated list of: property, unitGroup, ratePlan, services, reservations.
externalCodestring- Filter result by the external code. The result set will contain all bookings having reservations with external code starting with provided value
groupIdstring- Filter result by group id. The result set will contain all bookings having groups with the specified id
hasActivePaymentAccountboolean- If set to `true`, returns only the bookings with an active payment account. If set to `false`, returns only the bookings without an active payment account.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
reservationIdstring- Filter result by reservation id. The result set will contain all bookings having reservations with the specified id
textSearchstring- This will filter all bookings for the provided free text. Currently it only looks up if either the lastname, firstname, email or company name of the booker contains one of the provided values
apaleo_list_cancellation_policiesList cancellation policies defined for properties.Read-onlyList Cancellation Policies
List cancellation policies defined for properties. Returns an object with `cancellationPolicies`, `count`. Use to find policy ids for rate plans.
Inputs
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Filter cancellation policies by the specified property
apaleo_list_city_taxesList city tax definitions.Read-onlyList City Taxes
List city tax definitions. Returns an object with `cityTaxes`, `count`. Use to read tax setup per property.
Inputs
propertyIdstring- Filter by the specified property
apaleo_list_companiesList companies (corporate customers) with their negotiated rates.Read-onlyList Companies
List companies (corporate customers) with their negotiated rates. Returns an object with `companies`, `count`. Use to find company ids or search by name or code.
Inputs
corporateCodesstring- Return companies that have any of the requested corporate codes. Comma-separated list.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Filter by the specified property
ratePlanIdsstring- Return companies with any of the specified rate plans Comma-separated list.
textSearchstring- This will filter all companies for the provided free text. Currently it only looks up if the company name contains one of the provided values
apaleo_list_currenciesList the currency codes supported by Apaleo.Read-onlyList Currencies
List the currency codes supported by Apaleo. Returns an object with `isoCurrencies`. Use to validate currency input.
Inputs
This tool takes no inputs.
apaleo_list_folio_paymentsList the payments posted on a folio.Read-onlyList Folio Payments
List the payments posted on a folio. Returns an object with `payments`, `count`. Use to see what a guest paid.
Inputs
folioIdstringrequired- Id of the folio.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored. Comma-separated list of: actions.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
statusCodesstring- Filter payments by one or more status. Comma-separated list of: Pending, Success, Failure, Canceled.
apaleo_list_folio_refundsList the refunds on a folio.Read-onlyList Folio Refunds
List the refunds on a folio. Returns an object with `refunds`, `count`. Use to see refunds issued to a guest.
Inputs
folioIdstringrequired- Id of the folio.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
statusCodesstring- Filter refunds by one or more status Comma-separated list of: Pending, Success, Failure, Canceled.
apaleo_list_foliosList guest folios filtered by reservation, booking, company or status.Read-onlyList Folios
List guest folios filtered by reservation, booking, company or status. Returns an object with `folios`, `count`. Use to find the bill of a stay.
Inputs
balanceFilterstring- This will filter reservations based on their balance. You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean... Comma-separated list.
bookingIdsstring- Filter folio list by booking IDs Comma-separated list.
companyIdsstring- Filter folio list by company IDs Comma-separated list.
createdFromstring- The inclusive start time of the date of creation. Mostly useful for external folios A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
createdTostring- The exclusive end time of the date of creation. Mostly useful for external folios A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
excludeClosedboolean- If set to `true`, closed folios are filtered out from the result collection - DEPRECATED: This field will be removed soon. Please use Status=Open instead.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: allowances, allowedActions, transitoryCharges, charges, company, payments, warnings. All other values will be silently ignored. Comma-separated list of: allowances, allowedActions, transitoryCharges, charges, company, payments, warnings.
externalFolioCodestring- Allows filtering external folios by code. Useful when you use external folios with custom codes. Specifying this parameter will ignore the Type parameter and treat as if it would be set to "External" instead.
hasInvoicesboolean- If set to `true`, only folios with invoices are returned. If set to `false`, only folios without invoices are returned. If omitted/`null`, all folios are returned.
isEmptyboolean- If set to `true`, only return empty folios (no unmoved [transitory] charges, no unmoved payments, no allowances). If set to `false`, only return non-empty folios
onlyMainboolean- If set to `true`, only main folios are returned, otherwise all.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdsstring- Filter folio list by property IDs Comma-separated list.
reservationIdsstring- Filter folio list by reservation IDs Comma-separated list.
sortstring- List of all fields that can be used to sort the results. Possible values are: created:asc, created:desc, balance:asc, balance:desc. All other values will be silently ignored. Comma-separated list of: created:asc, created:desc, balance:asc, balance:desc.
statusstring- The status of the folioone of
OpenClosed textSearchstring- This will filter all folios where the provided text is contained in: debitor first name or last name or company name, folio id. The search is case insensitive.
typestring- The type of the folioone of
HouseGuestExternalBooking updatedFromstring- The inclusive start time of the date of the last update. Mostly useful for external folios A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
updatedTostring- The exclusive end time of the date of the last update. Mostly useful for external folios A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
apaleo_list_groupsList group bookings.Read-onlyList Group Bookings
List group bookings. Returns an object with `groups`, `count`. Use to find group ids. Use list_blocks for room blocks.
Inputs
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: blocks, actions. All other values will be silently ignored. Comma-separated list of: blocks, actions.
fromstring- The start of the time range. All groups that have blocks overlapping with the interval specified by from and to will be returned A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
hasActivePaymentAccountboolean- If set to `true`, returns only the groups with an active payment account. If set to `false`, returns only the groups without an active payment account.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdsstring- Filter result by requested properties Comma-separated list.
textSearchstring- This will filter all group bookings for the provided free text. Currently it only looks up if either the group name, lastname, firstname, email or company name of the booker contains one of the provided values
tostring- The end of the time range. All groups that have blocks overlapping with the interval specified by from and to will be returned A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
apaleo_list_invoicesList invoices filtered by property, status or dates.Read-onlyList Invoices
List invoices filtered by property, status or dates. Returns an object with `invoices`, `count`. Use to find invoices. Use get_invoice for one invoice.
Inputs
bookingIdsstring- Filter by booking IDs Comma-separated list.
checkedOutOnAccountsReceivableboolean- If set to `true`, only return invoices with an open balance (AR) Otherwise, returns all.
companyIdsstring- Filter by company IDs Comma-separated list.
dateFilterstring- Filter by invoice date You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean the value should be less than... Comma-separated list.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: allowedActions, company. All other values will be silently ignored. Comma-separated list of: allowedActions, company.
folioIdsstring- Filter by folio IDs Comma-separated list.
nameSearchstring- Find invoices for a recipient name or company. Provide at least three characters.
numberstring- The invoice number
outstandingPaymentFilterstring- Filter for the outstanding balance for invoices You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean the... Comma-separated list.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
paymentSettledboolean- If set to `true`, returns only invoices having no outstanding payments or marked as settled. If set to `false`, returns only invoices with outstanding payment and not marked as settled. If not set, returns all invoices. - DEPRECATED: This field will be removed at 25.06.2022. Use filtering by `Status` instead
propertyIdsstring- Filter by property IDs Comma-separated list.
recipientTypestring- If nothing is set, invoices addressed both companies and individuals will be returned. If set to `Person`, invoices that addressed to individuals will be returned. If set to `Company`, invoice that addressed to companies will be returned.one of
PersonCompany reservationIdsstring- Filter by reservation IDs Comma-separated list.
statusstring- Filter by invoice statusone of
FullyPaidUnpaidWrittenOff
apaleo_list_languagesList the languages enabled for the account.Read-onlyList Languages
List the languages enabled for the account. Returns an object with `languages`. Use to check supported guest languages.
Inputs
This tool takes no inputs.
apaleo_list_maintenancesList unit maintenance tasks.Read-onlyList Maintenances
List unit maintenance tasks. Returns an object with `maintenances`, `count`. Use to see rooms out of order or service.
Inputs
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: unit. All other values will be silently ignored. Comma-separated list of: unit.
fromstring- Filter all maintenance windows that end after the specified date and time A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Filter result by property id
tostring- Filter all maintenance windows that start before the specified date and time A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
typesstring- Filter result by maintenance types Comma-separated list of: OutOfService, OutOfOrder, OutOfInventory.
unitIdstring- Filter result by unit id
apaleo_list_market_segmentsList market segments defined for properties.Read-onlyList Market Segments
List market segments defined for properties. Returns an object with `marketSegments`, `count`. Use to find segment ids for rate plans and reservations.
Inputs
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdsstring- Return market segments with any of the specified property ids Comma-separated list.
apaleo_list_no_show_policiesList no-show policies defined for properties.Read-onlyList No-Show Policies
List no-show policies defined for properties. Returns an object with `noShowPolicies`, `count`. Use to find policy ids for rate plans.
Inputs
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Filter no-show policies by the specified property
apaleo_list_offersList bookable offers with prices for a property, dates and guest count.Read-onlyList Offers
List bookable offers with prices for a property, dates and guest count. Returns an object with `property`, `offers`. Use before create_booking to get available rates and unit groups.
Inputs
adultsintegerrequired- The number of adults you want offers for
arrivalstringrequired- Date and optional time of arrival Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
departurestringrequired- Date and optional time of departure. Cannot be more than 5 years after arrival. Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
propertyIdstringrequired- The property ID
channelCodestring- Channel code, used to filter the rate plansone of
DirectBookingComIbeChannelManagerExpediaHomelikeHrsAltoVitaDesVuGimsi childrenAgesstring- The ages of the children you want offers for Comma-separated list.
corporateCodestring- The code associated with a corporate rate
includeUnavailableboolean- Return also offers that are currently not publicly bookable as restrictions are violated. By default only available offers are returned
promoCodestring- The promo code associated with a certain special offer
timeSliceDefinitionIdsstring- Time slice definition IDs, used to filter rate plans Comma-separated list.
timeSliceTemplatestring- The time slice template used to filter the rate plans, defaults to 'over night'one of
DayUseOverNight unitGroupIdsstring- Unit group IDs, used to filter rate plans Comma-separated list.
unitGroupTypesstring- Unit group types, used to filter rate plans Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
apaleo_list_payment_methodsList the payment method values supported by Apaleo.Read-onlyList Payment Methods
List the payment method values supported by Apaleo. Returns an object with `paymentMethods`. Use to pick a valid method for create_folio_payment.
Inputs
This tool takes no inputs.
apaleo_list_promo_codesList the promo codes of a rate plan.Read-onlyList Promo Codes
List the promo codes of a rate plan. Returns an object with `promoCodes`, `count`. Use to look up codes guests can use at booking.
Inputs
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Return codes for a specific property
apaleo_list_propertiesList the hotel properties in the account, optionally filtered by status or country.Read-onlyList Properties
List the hotel properties in the account, optionally filtered by status or country. Returns an object with `properties`, `count`. Use to find property ids needed by most other tools. Use get_property for one property.
Inputs
countryCodestring- Filter result by country code Comma-separated list.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored. Comma-separated list of: actions.
includeArchivedboolean- Include archived properties in the result. If not set, or set to false, it only returns non-archived properties
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
statusstring- Filter result by property status Comma-separated list of: Test, Live.
apaleo_list_rate_plansList rate plans, optionally filtered by property, unit group or channel.Read-onlyList Rate Plans
List rate plans, optionally filtered by property, unit group or channel. Returns an object with `ratePlans`, `count`. Use to find rate plan ids for offers and bookings.
Inputs
baseRatePlanIdsstring- Return rate plans derived from any of the specified rate plans Comma-separated list.
cancellationPolicyIdsstring- Return rate plans with any of the specified cancellation policies Comma-separated list.
channelCodesstring- Return rate plans that are sold though any of the specified channels Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
companyIdsstring- Return rate plans filtered by requested companies Comma-separated list.
derivationLevelFilterstring- This will filter rate plans based on their derivation level. You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7'... Comma-separated list.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, cancellationPolicy, services, bookingPeriods, surcharges, ageCategories. All other values will be silently ignored. Comma-separated list of: property, unitGroup, cancellationPolicy, services, bookingPeriods, surcharges, ageCategories.
includeArchivedboolean- Return archived rate plans. Defaults to false
includedServiceIdsstring- Return rate plans that have any of the requested included services Comma-separated list.
isDerivedboolean- Return only derived or base rate plans
minGuaranteeTypesstring- Return rate plans with any of the specified min guarantee types Comma-separated list of: PM6Hold, CreditCard, Prepayment, Company.
noShowPolicyIdsstring- Return rate plans with any of the specified no-show policies Comma-separated list.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
promoCodesstring- Return rate plans that have any of the requested promo codes Comma-separated list.
propertyIdstring- Return rate plans for the specific property
ratePlanCodesstring- Return rate plans filtered by requested codes Comma-separated list.
timeSliceDefinitionIdsstring- Return rate plans with any of the specified time slice definitions Comma-separated list.
timeSliceTemplatestring- The time slice template, defaults to 'over night'one of
DayUseOverNight unitGroupIdsstring- Return rate plans with any of the specified unit groups Comma-separated list.
unitGroupTypesstring- Return rate plans with any of the specified unit group types Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
apaleo_list_ratesList the daily rates of a rate plan over a time range.Read-onlyList Rates
List the daily rates of a rate plan over a time range. Returns an object with `rates`, `count`. Use to read prices. Use update_rates to change them.
Inputs
fromstringrequired- The start of the time range to filter the rates by. All rates where the from date and time is equal or later than the specified date and optional time will be affected Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
ratePlanIdstringrequired- The id of the rate plan.
tostringrequired- The end of the time range to filter the rates by. All rates where the from date and time is earlier than the specified date and optional time will be affected Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
apaleo_list_reservation_available_unitsList the units that can be assigned to a specific reservation.Read-onlyList Units Available For Reservation
List the units that can be assigned to a specific reservation. Returns an object with `units`, `count`. Use before assign_unit to choose a valid unit.
Inputs
reservationIdstringrequired- The id of the reservation
fromstring- The from date and time A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
includeOutOfServiceboolean- Should units that are set OutOfService in the defined time period be returned as available.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
tostring- The to date and time A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
unitAttributeIdsstring- Return units with the specific unit attributes Comma-separated list.
unitConditionstring- The unit conditionone of
CleanCleanToBeInspectedDirty unitGroupIdstring- The unit group id
apaleo_list_reservation_servicesList the services booked on a reservation.Read-onlyList Reservation Services
List the services booked on a reservation. Returns an object with `services`, `count`. Use to see extras such as breakfast on a stay.
Inputs
reservationIdstringrequired- Id of the reservation.
apaleo_list_reservationsList reservations filtered by property, status, dates, guest or unit.Read-onlyList Reservations
List reservations filtered by property, status, dates, guest or unit. Returns an object with `reservations`, `count`. Use to browse stays. Use get_reservation for one stay.
Inputs
allFoliosHaveInvoiceboolean- If set to `true`, returns only reservations, in which all folios are closed and have an invoice. If set to `false`, returns only reservations, in which some of the folios are open or don't have an invoice
balanceFilterstring- This will filter reservations based on their balance. You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean... Comma-separated list.
blockIdsstring- Filter result by requested blocks Comma-separated list.
bookingIdstring- Filter result by booking id
channelCodestring- Filter result by the channel code Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
companyIdsstring- Filter result by requested companies Comma-separated list.
dateFilterstring- Filter by date and time attributes of reservation. Use in combination with the 'To' and 'From' attributes. All filters will check if the date specified by the filter type is between from (included) and to (excluded). The exception being filtering for 'stay', which will return all reservations that are overlapping with the interval specified by from and to.one of
ArrivalDepartureStayCreationModificationCancellationArrivalAndCheckInDepartureAndCheckOut expandstring- List of all embedded resources that should be expanded in the response. Possible values are: booker, actions, timeSlices, services, assignedUnits, company. All other values will be silently ignored. Comma-separated list of: booker, actions, timeSlices, services, assignedUnits, company.
externalCodestring- Filter result by the external code. The result set will contain all reservations that have an external code starting with the provided value
externalReferencesstring- This will filter all reservation where the provided external references have an exact match on at least one of the properties in Apaleo.Api.Modules.Booking.Models.Reservation.ExternalReferencesModel Comma-separated list.
fromstring- The start of the time interval. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
hasActivePaymentAccountboolean- If set to `true`, returns only the reservations with an active payment account. If set to `false`, returns only the reservations without an active payment account.
isPreCheckedInboolean- If set to `true`, returns only the reservations marked as pre-checked-in. If set to `false`, returns only the reservations not marked as pre-checked-in.
marketSegmentIdsstring- Filter result by requested market segments Comma-separated list.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdsstring- Filter result by requested properties Comma-separated list.
ratePlanIdsstring- Filter result by requested rate plans Comma-separated list.
sortstring- List of all fields that can be used to sort the results. Possible values are: arrival:asc, arrival:desc, departure:asc, departure:desc, created:asc, created:desc, updated:asc, updated:desc, balance:asc, balance:desc, id:asc, id:desc, firstname:asc, firstname:desc, lastname:asc, lastname:desc, unitname:asc, unitname:desc. All other values will be silently ignored. Comma-separated list of: arrival:asc, arrival:desc, departure:asc, departure:desc, created:asc, created:desc, updated:asc, updated:desc, balance:asc, balance:desc, id:asc, id:desc, firstname:asc, firstname:desc, lastname:asc, lastname:desc, unitname:asc, unitname:desc.
sourcesstring- Filter result by source Comma-separated list.
statusstring- Filter result by reservation status Comma-separated list of: Confirmed, InHouse, CheckedOut, Canceled, NoShow.
textSearchstring- Filters reservations by searching for the provided text across multiple fields. The search is case-insensitive and includes: - Booker information (first name, last name, email, company name) - Primary guest information (first name, last name, email, company name) - Additional guest information (first name, last name, email, company name) - Reservation details (external code, external references, reservation ID) - Unit name - Group name
tostring- The end of the time interval, must be larger than 'from'. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
unitGroupIdsstring- Filter result by requested unit groups Comma-separated list.
unitGroupTypesstring- Filter result by requested unit group types Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
unitIdsstring- Filter result by assigned units Comma-separated list.
validationMessageCategorystring- Filter result by validation message category Comma-separated list of: OfferNotAvailable, AutoUnitAssignment, GuestLoyalty.
apaleo_list_service_offersList bookable service offers with prices for a stay.Read-onlyList Service Offers
List bookable service offers with prices for a stay. Returns an object with `services`. Use to price extras before booking them.
Inputs
adultsintegerrequired- The number of adults you want offers for
arrivalstringrequired- Date and optional time of arrival Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
departurestringrequired- Date and optional time of departure. Cannot be more than 5 years after arrival. Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
ratePlanIdstringrequired- The rate plan ID
channelCodestring- The channel code used to filter the servicesone of
DirectBookingComIbeChannelManagerExpediaHomelikeHrsAltoVitaDesVuGimsi childrenAgesstring- The ages of the children you want offers for Comma-separated list.
includeUnavailableboolean- Return also offers that are currently not publicly bookable as restrictions are violated. By default only available offers are returned
onlyDefaultDatesboolean- Depending on the postNextDay setting of a service it will be posted before or after midnight. Breakfast is usually delivered on the next morning, having 'postNextDay' set to true. Its 'default dates' are from the day after arrival until the departure day. For services like dinner 'postNextDay' is false, and default dates are day of arrival until one day before departure. With this query parameter set to 'false', you can also ask for dates outside of those default dates. It...
apaleo_list_servicesList bookable services such as breakfast or parking.Read-onlyList Services
List bookable services such as breakfast or parking. Returns an object with `services`, `count`. Use to find service ids to book with book_service.
Inputs
channelCodesstring- The channel codes the service is sold through Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property. All other values will be silently ignored. Comma-separated list of: property.
onlySoldAsExtrasboolean- If set to true, return only services that can be sold as extras. Otherwise, it returns both, extras, and include-only.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Filter services by the specified property
serviceTypesstring- The service types offered Comma-separated list of: Other, Accommodation, FoodAndBeverages.
textSearchstring- This will filter all services for the provided free text. Currently it only looks up if the service name contains one of the provided values.
apaleo_list_sub_accountsList sub-accounts used to categorize charges.Read-onlyList Sub-Accounts
List sub-accounts used to categorize charges. Returns an object with `subAccounts`, `count`. Use to find sub-account ids for charges.
Inputs
propertyIdstringrequired- ID of the property
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
apaleo_list_unit_attributesList unit attributes such as view or amenities that can be assigned to units.Read-onlyList Unit Attributes
List unit attributes such as view or amenities that can be assigned to units. Returns an object with `unitAttributes`, `count`. Use to find attribute ids before creating or updating units.
Inputs
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
apaleo_list_unit_groupsList unit groups (room types) in the account, optionally filtered by property or type.Read-onlyList Unit Groups
List unit groups (room types) in the account, optionally filtered by property or type. Returns an object with `unitGroups`, `count`. Use to find unit group ids for offers, reservations and rates.
Inputs
expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, connectedUnitGroups. All other values will be silently ignored. Comma-separated list of: property, connectedUnitGroups.
pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Return unit groups for specific property
unitGroupTypesstring- unitGroupTypes Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
apaleo_list_unitsList physical units (rooms, spaces) in the account, optionally filtered by property, unit group or condition.Read-onlyList Units
List physical units (rooms, spaces) in the account, optionally filtered by property, unit group or condition. Returns an object with `units`, `count`. Use to browse inventory. Use list_available_units for what is free to book.
Inputs
conditionstring- Return units with a specific conditionone of
CleanCleanToBeInspectedDirty expandstring- List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits, actions. All other values will be silently ignored. Comma-separated list of: property, unitGroup, connectedUnits, actions.
isOccupiedboolean- Return only occupied or vacant units
maintenanceTypestring- Return units with the specific maintenance typeone of
OutOfServiceOutOfOrderOutOfInventory pageNumberinteger- Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
pageSizeinteger- Items per page. Default: 500. Maximum: 500.
propertyIdstring- Return units for specific property
statusstring- Return active units, archived units, or all units. Defaults to active.one of
ActiveArchivedAll textSearchstring- This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
unitAttributeIdsstring- Return units with the specific unit attributes Comma-separated list.
unitGroupIdstring- Return units for the specific unit group - DEPRECATED: This property will be removed 20.04.2022. Use `UnitGroupIds` instead
unitGroupIdsstring- Return units with the specific unit groups Comma-separated list.
apaleo_add_reservations_to_bookingAdd one or more reservations to an existing booking.WriteAdd Reservations To Booking
Add one or more reservations to an existing booking. Returns an object with `reservationIds`. Use to extend a booking with extra rooms.
Inputs
bookingIdstringrequired- Id of the booking the reservations should be attached to.
reservationsarrayrequired- List of reservations to add to the existing booking. Each item needs: adults, arrival, channelCode, departure, timeSlices. Example: [{"arrival":"2026-11-01","departure":"2026-11-01","adults":2,"channelCode":"Direct","timeSlices":[{"ratePlanId":"MUC-FLEX-DBL"}]}]
transactionReferencestring- The reference of a payment transaction. This should be set when a payment transaction has been initiated and should be used to complete the transaction upon reservation creation. When set, the payment transaction completion is always triggered regardless of the reservation guarantee type and payment automation settings.
apaleo_amend_reservationChange the stay of a reservation such as dates, guests, unit group or rate plan.WriteAmend Reservation
Change the stay of a reservation such as dates, guests, unit group or rate plan. Returns no response body on success (HTTP 204). Use to modify the stay itself. Use update_reservation for non-stay fields.
- Idempotent
Inputs
adultsintegerrequired- Number of adults.
arrivalstringrequired- Date and optional time of arrival Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004.
departurestringrequired- Date and optional time of departure. Cannot be more than 5 years after arrival. Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004.
reservationIdstringrequired- Id of the reservation that should be modified
timeSlicesarrayrequired- The list of time slices. Each item needs: ratePlanId. Example: [{"ratePlanId":"MUC-FLEX-DBL"}]
childrenAgesarray- Ages of the children.
requoteboolean- Whether the prices for time slices with no change to the rate plan should be re-quoted based on current prices, or if only additions like change of number of adults should be calculated. If a reservation is part of a block, the time slices prices will always be re-quoted to the current price of the block. Defaults to 'false'.
apaleo_assign_specific_unitAssign a chosen unit to a reservation.WriteAssign Specific Unit
Assign a chosen unit to a reservation. Returns an object with `unit`. Use when the unit is already decided. Check options with list_reservation_available_units.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation the unit should be assigned to.
unitIdstringrequired- The id of the unit to be assigned.
fromstring- The start date and optional time for the unit assignment. If not specified, the reservation's arrival will be used. Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
lockUnitboolean- Whether to lock the unit for the duration of the reservation. If not specified, the unit will not be locked.
tostring- The end date and optional time for the unit assignment. If not specified, the reservation's departure will be used. Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
apaleo_assign_unitAutomatically assign an available unit to a reservation.WriteAssign Unit
Automatically assign an available unit to a reservation. Returns an object with `timeSlices`. Use for automatic room assignment. Use assign_specific_unit to pick the unit.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation a unit should be assigned to.
unitConditionsstring- The optional unit conditions for unit that you want to auto assign for. Comma-separated list of: Clean, CleanToBeInspected, Dirty.
apaleo_book_serviceAdd a service to a reservation.WriteBook Service
Add a service to a reservation. Returns no response body on success (HTTP 204). Use to add an extra. Find service ids with list_services.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation.
serviceIdstringrequired- The id of the service you want to book.
amountobject- The amount of the request. Required fields: amount, currency. Example: {"amount":99.5,"currency":"example"}
countinteger- The number of services to book for each service date. It defaults to the service offer count when not specified.
datesarray- The optional dates you want to book the service for; if not specified the default service pattern will be used (e.g. whole stay). Each item needs: serviceDate. Example: [{"serviceDate":"2026-11-01"}]
apaleo_cancel_reservationCancel a confirmed reservation whose arrival is in the future.WriteCancel Reservation
Cancel a confirmed reservation whose arrival is in the future. Returns no response body on success (HTTP 204). Use to cancel a stay. Use mark_no_show for guests who did not arrive.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation that should be processed.
apaleo_check_in_reservationCheck in a confirmed reservation that has a unit assigned.WriteCheck In Reservation
Check in a confirmed reservation that has a unit assigned. Returns no response body on success (HTTP 204). Use at arrival. Assign a unit first.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation that should be processed.
withCityTaxboolean- Define if city tax should be added for this reservation or not. The default is "true".
apaleo_check_out_reservationCheck out an in-house reservation.WriteCheck Out Reservation
Check out an in-house reservation. Returns no response body on success (HTTP 204). Use at departure after the folio is settled.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation that should be processed.
apaleo_close_folioClose a folio so no further changes are possible.WriteClose Folio
Close a folio so no further changes are possible. Returns no response body on success (HTTP 204). Use once the bill is settled.
- Idempotent
Inputs
folioIdstringrequired- The folio ID.
apaleo_create_bookingCreate a booking with a booker and one or more reservations.WriteCreate Booking
Create a booking with a booker and one or more reservations. Returns an object with `id`, `reservationIds`. Use to make a new reservation from a chosen offer. Fetch offers first with list_offers.
Inputs
bookerobjectrequired- The booker of the request. Required fields: lastName. Example: {"lastName":"Schmidt"}
reservationsarrayrequired- List of reservations to create. Each item needs: adults, arrival, channelCode, departure, timeSlices. Example: [{"arrival":"2026-11-01","departure":"2026-11-01","adults":2,"channelCode":"Direct","timeSlices":[{"ratePlanId":"MUC-FLEX-DBL"}]}]
bookerCommentstring- Additional information and comments by the booker.
commentstring- Additional information and comments.
paymentAccountobject- The payment account of the request. Example: {"accountNumber":"example","accountHolder":"example"}
registeredCardobject- Use registered card when you need to show details about a card you intend to add to the booking/reservation in the future as a real payment account. It is NOT a replacement of the deprecated PaymentAccount field. Example: {"cardNumber":"example","cardHolder":"example"}
transactionReferencestring- The reference of a payment transaction. This should be set when a payment transaction has been initiated and should be used to complete the transaction upon reservation creation. When set, the payment transaction completion is always triggered regardless of the reservation guarantee type and payment automation settings.
apaleo_create_companyCreate a company profile for a property.WriteCreate Company
Create a company profile for a property. Returns an object with `id`. Use to register a corporate customer before attaching reservations.
Inputs
addressobjectrequired- The address of the request. Required fields: addressLine1, city, countryCode, postalCode. Example: {"addressLine1":"example","postalCode":"example","city":"example","countryCode":"DE"}
canCheckOutOnArbooleanrequired- Whether or not the company is allowed to check out on AR / invoice.
codestringrequired- The code for the company.
namestringrequired- The name of the company.
propertyIdstringrequired- The ID of the property.
additionalTaxIdstring- The additional tax ID of the company (e.g. SIRET in France, Codice Destinatario in Italy, SST in Malaysia).
additionalTaxId2string- The additional tax ID of the company (e.g. Codice Fiscale in Italy, BRN in Malaysia).
invoiceNetworkIdentityobject- The invoice network identity of the request. Required fields: id, network. Example: {"network":"Peppol","id":"MUC-ABC123-1"}
invoicingEmailstring- The email address for invoicing purposes.
phonestring- The company's phone.
ratePlansarray- Rate plans that can be booked by this company. Each item needs: id. Example: [{"id":"MUC-ABC123-1"}]
taxIdstring- The tax ID of the company.
apaleo_create_folioCreate an additional folio for a reservation or company.WriteCreate Folio
Create an additional folio for a reservation or company. Returns an object with `id`. Use to split charges across bills.
Inputs
debitorobjectrequired- The debitor of the request. Example: {"type":"Booker","title":"Mr"}
codestring- Optional code for external folios. If present, the id of the folio will be propertyId-code (MUC-SOMETHING); If no code is provided, the id of the folio will be propertyId-ext-number (MUC-EXT-282).
companyIdstring- The ID of the company for which a folio should be created.
propertyIdstring- The ID of the property for which an external folio should be created.
reservationIdstring- The ID of the reservation for which a guest folio should be created.
typestring- The type of the folio to create. Default is the guest folio. This field will become required 01.11.2019.one of
GuestExternal
apaleo_create_folio_paymentPost a payment to a folio.WriteCreate Folio Payment
Post a payment to a folio. Returns an object with `id`. Use to record a payment received outside Apaleo Pay.
Inputs
amountobjectrequired- The amount of the request. Required fields: amount, currency. Example: {"amount":99.5,"currency":"example"}
folioIdstringrequired- Id of the folio.
methodstringrequired- The payment method. Use 'CreditCard', if none of the specific credit cards types matches. 'Booking.com' only makes sense, if the property (hotel) configured Booking.com > Finance to be 'Payments by Booking.com'.one of
CashBankTransferCreditCardAmexVisaCreditVisaDebitMasterCardMasterCardDebitMaestroGiroCardDiscoverCardDinersJcbBookingComVPayPayPalPostcardRekaTwintLunchcheckVoucherChinaUnionPayOtherChequeAirbnbHolidayCheckRepresentationIDeal businessDatestring- The business date of the payment. Defaults to the current date. In some cases you might want to post the payments to the previous business date, this is only possible until 6 AM of the current day.
paidChargesarray- List of charges and amount being covered by this payment. Each item needs: amount, chargeId. Example: [{"chargeId":"MUC-ABC123-1","amount":99.5}]
receiptstring- The optional receipt you want to store for the payment. It defaults to the reservation or external folio id. This field is required if you are adding payment to the house account.
apaleo_create_invoiceCreate an invoice from a closed folio.WriteCreate Invoice
Create an invoice from a closed folio. Returns an object with `id`. Use after close_folio.
Inputs
folioIdstringrequired- The ID of the folio for which the invoice should be created.
languageCodestringrequired- The language in which the invoice should be produced.
apaleo_create_maintenanceCreate a maintenance task for a unit.WriteCreate Maintenance
Create a maintenance task for a unit. Returns an object with `id`. Use to take a room out of service for a period.
Inputs
fromstringrequired- Date and time the maintenance begins. Has to be today or on a day in the future A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004.
tostringrequired- Date and time the maintenance ends. Has to be later than from A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004.
typestringrequired- The type of maintenance that is planned for the unit. A small repair (OutOfService), a bigger disfunction that does not allow to sell the unit (OutOfOrder) or is it under construction (OutOfInventory).one of
OutOfServiceOutOfOrderOutOfInventory unitIdstringrequired- The id of the unit.
descriptionstring- Description of the maintenance.
apaleo_create_rate_planCreate a rate plan in a property.WriteCreate Rate Plan
Create a rate plan in a property. Returns an object with `id`. Use to add a new price plan with its policies and unit groups.
Inputs
cancellationPolicyIdstringrequired- The id of the cancellation policy valid for this rate plan.
channelCodesarrayrequired- The channel codes the rate plan is sold through.
codestringrequired- The code for the rate plan that can be shown in reports and table views.
descriptionobjectrequired- The description for the rate plan. Provide a map of two-letter language code to text. Example: {"en":"Spacious double room"}
minGuaranteeTypestringrequired- The minimum guarantee to be provided when this rate plan is booked so the reservation will be guaranteed to the guest.one of
PM6HoldCreditCardPrepaymentCompany nameobjectrequired- The name for the rate plan. Provide a map of two-letter language code to text. Example: {"en":"Deluxe Double"}
propertyIdstringrequired- The id of the property for which the rate plan will be created.
timeSliceDefinitionIdstringrequired- Defines the time periods for which the unit group related to this rate plan is rented out.
unitGroupIdstringrequired- The id of the unit group offered with this rate plan.
accountingConfigsarray- The collection of accounting configs with validity periods. This is a temporary field, avoid using it. Each item needs: serviceType, validFrom, vatType. Example: [{"vatType":"Null","serviceType":"Other","validFrom":"2026-11-01"}]
ageCategoriesarray- Additional charges per age category. Each item needs: id, surcharges. Example: [{"id":"MUC-ABC123-1","surcharges":[{"adults":2,"value":99.5}]}]
bookingPeriodsarray- Time periods when the rate plan is bookable. Each item needs: from, to. Example: [{"from":"2026-11-01T00:00:00Z","to":"2026-11-01T00:00:00Z"}]
companiesarray- Companies that can use this rate plan. Each item needs: id. Example: [{"id":"MUC-ABC123-1"}]
includedServicesarray- Services that are included in the rate plan. Each item needs: grossPrice, serviceId. Example: [{"serviceId":"BRK","grossPrice":{"amount":99.5,"currency":"example"}}]
isSubjectToCityTaxboolean- Whether the rate plan is subject to city tax or not. Default value is `true`.
marketSegmentIdstring- The id of the market segment for this rate plan.
noShowPolicyIdstring- The id of the no-show policy valid for this rate plan.
priceCalculationModestring- The calculation mode is used when calculating the adults' surcharges and derived rates. Defaults to Truncate. Example: for a rate of 125.99 and a surcharge of +10%, when Truncate is selected, the result would be 125.99 + 12 = 137.99 When Round is selected, the result would be 125.99 + 12.60 = 138.59.one of
TruncateRound pricingRuleobject- The pricing rule of the request. Required fields: baseRatePlanId, type, value. Example: {"baseRatePlanId":"MUC-ABC123-1","type":"Absolute","value":99.5}
promoCodesarray- The rate codes for promotional and hidden rates. If at least one code is set the rate will be not publicly visible anymore and only be offered when one of the promo codes is given in the offer request. For backward compatibility it is still not possible to set multiple promo codes.
restrictionsobject- The restrictions of the request.
surchargesarray- Additional charges for more than single occupancy. The percent or absolute value will be added to the manually defined or calculated derived rates. The values for 'adults' must be unique within the list and starting from occupancy of 2 adults. Values higher than the maximum unit group occupancy will be silently ignored. The surcharges are required for all possible occupancies defined by the 'MaxPersons' of the unit group. Each item needs: adults, type, value. Example: [{"adults":2,"type":"Absolute","value":99.5}]
apaleo_create_unitCreate a single unit in a property and unit group.WriteCreate Unit
Create a single unit in a property and unit group. Returns an object with `id`. Use for one unit. Use create_units_bulk for many.
Inputs
descriptionobjectrequired- The description for the unit. Provide a map of two-letter language code to text. Example: {"en":"Spacious double room"}
maxPersonsintegerrequired- Maximum number of persons for the unit.
namestringrequired- The name for the unit.
propertyIdstringrequired- The id of the property where the unit will be created.
attributesarray- Collection of user defined attributes of unit. Each item needs: id. Example: [{"id":"MUC-ABC123-1"}]
conditionstring- Condition of the unit.one of
CleanCleanToBeInspectedDirty connectedUnitsarray- The list of units this unit is composed of. Each item needs: unitId. Example: [{"unitId":"101"}]
unitGroupIdstring- The id of the unit group.
apaleo_create_unit_groupCreate a unit group (room type) in a property.WriteCreate Unit Group
Create a unit group (room type) in a property. Returns an object with `id`. Use to define a new room type before adding units to it.
Inputs
codestringrequired- The code for the unit group that can be shown in reports and table views.
descriptionobjectrequired- The description for the unit group. Provide a map of two-letter language code to text. Example: {"en":"Spacious double room"}
maxPersonsintegerrequired- Maximum number of persons for the unit group.
nameobjectrequired- The name for the unit group. Provide a map of two-letter language code to text. Example: {"en":"Deluxe Double"}
propertyIdstringrequired- The id of the property where unit group will be created.
connectedUnitGroupsarray- The list of connected unit groups this unit group is composed of. Each item needs: memberCount, unitGroupId. Example: [{"unitGroupId":"MUC-DBL","memberCount":1}]
rankinteger- The unit group rank Restrictions: - Should be greater or equal to one.
typestring- The unit group type.one of
BedRoomMeetingRoomEventSpaceParkingLot
apaleo_create_units_bulkCreate several units at once with a shared name prefix and numbering.WriteCreate Units In Bulk
Create several units at once with a shared name prefix and numbering. Returns an object with `ids`. Use to add many similar units quickly. Use create_unit for a single named unit.
Inputs
unitsarrayrequired- The units of the request. Each item needs: description, maxPersons, name, propertyId. Example: [{"propertyId":"MUC","name":"Deluxe Double","description":{},"maxPersons":1}]
apaleo_mark_no_showMark a reservation as a no-show.WriteMark Reservation No-Show
Mark a reservation as a no-show. Returns no response body on success (HTTP 204). Use after the arrival date passed without check-in.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation that should be processed.
apaleo_post_folio_chargePost a charge to an open folio.WritePost Folio Charge
Post a charge to an open folio. Returns an object with `id`, `feeChargeIds`. Use to bill an extra to a guest.
Inputs
amountobjectrequired- The amount of the request. Required fields: amount, currency. Example: {"amount":99.5,"currency":"example"}
folioIdstringrequired- The folio ID
namestringrequired- The name, article number, or other description of this charge.
serviceTypestringrequired- The service type, used by accounting to determine the correct revenue account.one of
OtherAccommodationFoodAndBeveragesCityTaxSecondCityTax vatTypestringrequired- The VAT type, used by accounting to determine the correct vat amount and account.one of
NullVeryReducedReducedNormalWithoutSpecialSpecial1Special2ReducedCovid19NormalCovid19Mixed businessDatestring- The business date of the charge. Defaults to the current date. In some cases you might want to post the charges to the previous business date, this is only possible until 6 AM of the current day.
quantityinteger- The count of services provided. Defaults to 1. NOTE: this field will become required 07.05.2020.
receiptstring- Receipt for this transaction.
subAccountIdstring- ID of the custom sub-account to post the charge to, used by accounting to determine the correct revenue account.
apaleo_reopen_folioReopen a closed folio.WriteReopen Folio
Reopen a closed folio. Returns no response body on success (HTTP 204). Use to correct a folio that was closed.
- Idempotent
Inputs
folioIdstringrequired- The folio ID.
apaleo_set_units_conditionSet the housekeeping condition of one or more units.WriteSet Units Condition
Set the housekeeping condition of one or more units. Returns no response body on success (HTTP 204). Use to mark rooms clean, dirty or inspected.
- Idempotent
Inputs
unitsConditionsarrayrequired- The units conditions of the request. Each item needs: condition, id. Example: [{"id":"MUC-ABC123-1","condition":"Clean"}]
apaleo_unassign_unitsRemove the assigned units from a reservation.WriteUnassign Units
Remove the assigned units from a reservation. Returns no response body on success (HTTP 204). Use to free a room before reassigning.
- Idempotent
Inputs
reservationIdstringrequired- Id of the reservation the unit should be unassigned for.
apaleo_update_bookingModify a booking with a list of JSON Patch operations.WriteUpdate Booking
Modify a booking with a list of JSON Patch operations. Returns no response body on success (HTTP 204). Use to change booking-level data such as comments.
Inputs
bookingIdstringrequired- Id of the booking to be modified.
operationsarrayrequired- List of JSON Patch operations (RFC 6902) to apply, in order. Each operation has `op` (add, remove, replace, move, copy or test), `path` (JSON pointer such as /comment) and, for add and replace, a `value`. Example: [{"op":"replace","path":"/comment","value":"Late arrival expected"}].
apaleo_update_companyModify a company with a list of JSON Patch operations.WriteUpdate Company
Modify a company with a list of JSON Patch operations. Returns no response body on success (HTTP 204). Use to change a company's contact or billing details.
Inputs
companyIdstringrequired- The ID of the company to be modified.
operationsarrayrequired- List of JSON Patch operations (RFC 6902) to apply, in order. Each operation has `op` (add, remove, replace, move, copy or test), `path` (JSON pointer such as /comment) and, for add and replace, a `value`. Example: [{"op":"replace","path":"/comment","value":"Late arrival expected"}].
apaleo_update_maintenanceModify a maintenance task with a list of JSON Patch operations.WriteUpdate Maintenance
Modify a maintenance task with a list of JSON Patch operations. Returns no response body on success (HTTP 204). Use to adjust the period or description.
Inputs
maintenanceIdstringrequired- The ID of the maintenance.
operationsarrayrequired- List of JSON Patch operations (RFC 6902) to apply, in order. Each operation has `op` (add, remove, replace, move, copy or test), `path` (JSON pointer such as /comment) and, for add and replace, a `value`. Example: [{"op":"replace","path":"/comment","value":"Late arrival expected"}].
apaleo_update_propertyModify a property with a list of JSON Patch operations.WriteUpdate Property
Modify a property with a list of JSON Patch operations. Returns no response body on success (HTTP 204). Use to change property fields such as name or description. Read the property first with get_property.
Inputs
operationsarrayrequired- List of JSON Patch operations (RFC 6902) to apply, in order. Each operation has `op` (add, remove, replace, move, copy or test), `path` (JSON pointer such as /comment) and, for add and replace, a `value`. Example: [{"op":"replace","path":"/comment","value":"Late arrival expected"}].
propertyIdstringrequired- The id of the property.
apaleo_update_rate_planReplace a rate plan's definition.WriteUpdate Rate Plan
Replace a rate plan's definition. Returns no response body on success (HTTP 204). Use to change an existing rate plan. Send the full definition.
- Idempotent
Inputs
cancellationPolicyIdstringrequired- The id of the cancellation policy valid for this rate plan.
channelCodesarrayrequired- The channel codes the rate plan is sold through.
descriptionobjectrequired- The description for the rate plan. Provide a map of two-letter language code to text. Example: {"en":"Spacious double room"}
minGuaranteeTypestringrequired- The minimum guarantee to be provided when this rate plan is booked so the reservation will be guaranteed to the guest.one of
PM6HoldCreditCardPrepaymentCompany nameobjectrequired- The name for the rate plan. Provide a map of two-letter language code to text. Example: {"en":"Deluxe Double"}
ratePlanIdstringrequired- The id of the rate plan.
accountingConfigsarray- The collection of accounting configs with validity periods. Each item needs: serviceType, validFrom, vatType. Example: [{"vatType":"Null","serviceType":"Other","validFrom":"2026-11-01"}]
ageCategoriesarray- Additional charges per age category. Each item needs: id, surcharges. Example: [{"id":"MUC-ABC123-1","surcharges":[{"adults":2,"value":99.5}]}]
bookingPeriodsarray- Time periods when the rate plan is bookable. Each item needs: from, to. Example: [{"from":"2026-11-01T00:00:00Z","to":"2026-11-01T00:00:00Z"}]
companiesarray- Companies that can use this rate plan. Each item needs: id. Example: [{"id":"MUC-ABC123-1"}]
includedServicesarray- Services that are included in the rate plan. Each item needs: grossPrice, serviceId. Example: [{"serviceId":"BRK","grossPrice":{"amount":99.5,"currency":"example"}}]
isSubjectToCityTaxboolean- Whether the rate plan is subject to city tax or not. Default value is `true`.
marketSegmentIdstring- The id of the market segment for this rate plan.
noShowPolicyIdstring- The id of the no-show policy valid for this rate plan.
priceCalculationModestring- The calculation mode is used when calculating the adults' surcharges and derived rates. Defaults to Truncate. Example: for a rate of 125.99 and a surcharge of +10%, when Truncate is selected, the result would be 125.99 + 12 = 137.99 When Round is selected, the result would be 125.99 + 12.60 = 138.59.one of
TruncateRound pricingRuleobject- The pricing rule of the request. Required fields: baseRatePlanId, type, value. Example: {"baseRatePlanId":"MUC-ABC123-1","type":"Absolute","value":99.5}
promoCodesarray- The rate codes for promotional and hidden rates. If at least one code is set the rate will be not publicly visible anymore and only be offered when one of the promo codes is given in the offer request. For backward compatibility it is still not possible to set multiple promo codes.
restrictionsobject- The restrictions of the request.
surchargesarray- Additional charges for more than single occupancy. The percent or absolute value will be added to the manually defined or calculated derived rates. The values for 'adults' must be unique within the list and starting from occupancy of 2 adults. Values higher than the maximum unit group occupancy will be silently ignored. The surcharges are required for all possible occupancies defined by the 'MaxPersons' of the unit group. Each item needs: adults, type, value. Example: [{"adults":2,"type":"Absolute","value":99.5}]
apaleo_update_ratesSet the rates of a rate plan for given time slices, replacing existing values.WriteUpdate Rates
Set the rates of a rate plan for given time slices, replacing existing values. Returns no response body on success (HTTP 204). Use to push new prices for a rate plan and unit group.
- Idempotent
Inputs
ratePlanIdstringrequired- The id of the rate plan.
ratesarrayrequired- List of rates. Each item needs: from, to. Example: [{"from":"2026-11-01T00:00:00Z","to":"2026-11-01T00:00:00Z"}]
apaleo_update_reservationModify a reservation with a list of JSON Patch operations.WriteUpdate Reservation
Modify a reservation with a list of JSON Patch operations. Returns no response body on success (HTTP 204). Use to change guest details, comments or other fields. Use amend_reservation for dates, rooms or rates.
Inputs
operationsarrayrequired- List of JSON Patch operations (RFC 6902) to apply, in order. Each operation has `op` (add, remove, replace, move, copy or test), `path` (JSON pointer such as /comment) and, for add and replace, a `value`. Example: [{"op":"replace","path":"/comment","value":"Late arrival expected"}].
reservationIdstringrequired- Id of the reservation to be modified.
apaleo_update_unitModify a unit with a list of JSON Patch operations.WriteUpdate Unit
Modify a unit with a list of JSON Patch operations. Returns no response body on success (HTTP 204). Use to rename a unit or change its description or attributes.
Inputs
operationsarrayrequired- List of JSON Patch operations (RFC 6902) to apply, in order. Each operation has `op` (add, remove, replace, move, copy or test), `path` (JSON pointer such as /comment) and, for add and replace, a `value`. Example: [{"op":"replace","path":"/comment","value":"Late arrival expected"}].
unitIdstringrequired- The id of the unit.
apaleo_update_unit_groupReplace a unit group's definition.WriteUpdate Unit Group
Replace a unit group's definition. Returns no response body on success (HTTP 204). Use to change a room type's name, capacity or description. Send the full definition.
- Idempotent
Inputs
descriptionobjectrequired- The description for the unit group. Provide a map of two-letter language code to text. Example: {"en":"Spacious double room"}
nameobjectrequired- The name for the unit group. Provide a map of two-letter language code to text. Example: {"en":"Deluxe Double"}
unitGroupIdstringrequired- The id of the unit group.
connectedUnitGroupsarray- The list of connected unit groups this unit group is composed of. Each item needs: memberCount, unitGroupId. Example: [{"unitGroupId":"MUC-DBL","memberCount":1}]
maxPersonsinteger- Maximum number of persons for the unit group. If this value is increased, the surcharges for the related rate plans must be specified in order for the rate plans to be sellable for the new possible occupancies.
rankinteger- The unit group rank Restrictions: - Should be greater or equal to one.
apaleo_delete_maintenanceDelete a maintenance task.DestructiveDelete Maintenance
Delete a maintenance task. Returns no response body on success (HTTP 204). Use when the work is cancelled.
- Idempotent
Inputs
maintenanceIdstringrequired- The ID of the maintenance.
apaleo_delete_rate_planPermanently delete a rate plan.DestructiveDelete Rate Plan
Permanently delete a rate plan. Returns no response body on success (HTTP 204). Use only for rate plans without reservations.
- Idempotent
Inputs
ratePlanIdstringrequired- The id of the rate plan.
apaleo_delete_unitPermanently delete a unit.DestructiveDelete Unit
Permanently delete a unit. Returns no response body on success (HTTP 204). Use only for units that were created by mistake. Archived or in-use units cannot be removed.
- Idempotent
Inputs
unitIdstringrequired- The id of the unit.
apaleo_delete_unit_groupPermanently delete a unit group.DestructiveDelete Unit Group
Permanently delete a unit group. Returns no response body on success (HTTP 204). Use only for room types with no units or reservations.
- Idempotent
Inputs
unitGroupIdstringrequired- The id of the unit group.
No tools match.