Apaleo

Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses

accountingscheduling & booking

Tools (29)

Archive a property
Use this endpoint to archive an existing live property This operation set the IsArchived flag to true You must have at least one of these scopes: 'properties.manage, setup.manage'.
Inputs: id
Check if a property exists
Check if a property exists by id. You need to be authorized (no particular scope required)
Inputs: id
Check if a unit attribute exists
Check if a unit attribute exists You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Inputs: id
Check if a unit exists
Check if a unit exists by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Inputs: id
Check if a unit group exists
Check if a unit group exists by id. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Inputs: id
Clones a property
Use this call to clone a specific property. This operation creates a new property with inventory and rate plans from the specified property. You must have at least one of these scopes: 'properties.create, setup.manage'.
Inputs: id, code, name, taxId, timeZone, companyName, description, currencyCode, paymentTerms, location__city, bankAccount__bic, bankAccount__bank, bankAccount__iban, managingDirectors, defaultCheckInTime, defaultCheckOutTime, location__postalCode, location__regionCode, location__countryCode, location__addressLine1, location__addressLine2, commercialRegisterEntry
Create a unit
Use this call to create a new unit. You must have at least one of these scopes: 'units.create, setup.manage'.
Inputs: name, condition, attributes, maxPersons, propertyId, description, unitGroupId, connectedUnits
Create a unit attribute
Use this call to create a new unit attribute. You must have at least one of these scopes: 'unitattributes.create, setup.manage'.
Inputs: name, description
Create a unit group
Use this call to create a new unit group. You must have at least one of these scopes: 'unitgroups.create, setup.manage'.
Inputs: code, name, rank, type, maxPersons, propertyId, description, connectedUnitGroups
Create multiple units
Use this call to create multiple units, following a naming rule. You must have at least one of these scopes: 'units.create, setup.manage'.
Inputs: units
Creates a property
Use this call to create a new property. You must have at least one of these scopes: 'properties.create, setup.manage'.
Inputs: code, name, taxId, timeZone, companyName, description, currencyCode, paymentTerms, location__city, bankAccount__bic, bankAccount__bank, bankAccount__iban, managingDirectors, defaultCheckInTime, defaultCheckOutTime, location__postalCode, location__regionCode, location__countryCode, location__addressLine1, location__addressLine2, commercialRegisterEntry
Delete a unit
Use this call to delete a unit. You must have at least one of these scopes: 'units.delete, setup.manage'.
Inputs: id
Delete a unit group
Use this call to delete a unit group. You must have at least one of these scopes: 'unitgroups.delete, setup.manage'.
Inputs: id
Deletes unit attribute
Deletes unit attribute You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
Inputs: id
Get a properties list
Get the list of properties. You need to be authorized (no particular scope required)
Inputs: expand, status, pageSize, pageNumber, countryCode, includeArchived
Get a property
Get a property by id. You need to be authorized (no particular scope required)
Inputs: id, expand, languages
Get a unit
Get a unit by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Inputs: id, expand, languages
Get a unit group
Get a unit group by id. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Inputs: id, expand, languages
Get a units list
Get the list of units. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Inputs: expand, pageSize, condition, isOccupied, pageNumber, propertyId, textSearch, unitGroupId, unitGroupIds, maintenanceType, unitAttributeIds
Get unit attribute by id
Get unit attribute by id You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Inputs: id
Get unit attribute list
Get unit attribute list You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Inputs: pageSize, pageNumber
List Unit Groups
Get the list of unit groups. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Inputs: expand, pageSize, pageNumber, propertyId, unitGroupTypes
Move property to live
Use this endpoint to move an existing test property to live This operation changes the property status to 'Live' You must have at least one of these scopes: 'properties.manage, setup.manage'.
Inputs: id
Replace a unit group
Use this call to modify a unit group. You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.
Inputs: id, name, rank, maxPersons, description, connectedUnitGroups
Reset Property Data
This endpoint deletes transactional data for a property in 'Test' status. Requires 'properties.manage' or 'setup.manage' scopes.
Inputs: id
Returns a list of supported countries
Returns a list of ISO country codes that could be used to create properties. You need to be authorized (no particular scope required)
Returns number of unit groups
Returns number of unit groups matching the filter criteria You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Inputs: propertyId, unitGroupTypes
Returns number of units
Returns number of units matching the filter criteria You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Inputs: condition, isOccupied, propertyId, textSearch, unitGroupId, unitGroupIds, maintenanceType, unitAttributeIds
Return total count of properties
Return total count of properties You need to be authorized (no particular scope required)