Apaleo

Learn how to use Apaleo with Composio

Overview

Enum

APALEO

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to offline_access,account.manage,account.suspend,accounting.read,authorizations.manage,authorizations.read,availability.manage,availability.read,charges.delete,companies.manage,companies.read,depositItems.manage,deposits.manage,deposits.read,folios.manage,folios.payment-with-charges,folios.read,invoices.manage,invoices.read,logs.read,maintenances.manage,maintenances.read,offer-index.read,offers.read,operations.change-room-state,operations.trigger-night-audit,payment-accounts.manage,payment-accounts.read,payments.manage,payments.read,prepayment-notices.read,rateplans.read-corporate,rateplans.read-negotiated,rates.manage,rates.read,reports.read,reservations.force-manage,reservations.manage,reservations.read,routings.create,routings.manage,routings.read,servicegroups.create,servicegroups.manage,servicegroups.read,setup.manage,setup.read

Actions

Get a unit by id.you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Action Parameters

id
stringRequired
languages
array
expand
array

Action Response

data
object
successful
boolean
error

Use this call to create a new property.you must have at least one of these scopes: ‘properties.create, setup.manage’.

Action Parameters

description
object
code
stringRequired
name
objectRequired
companyName
stringRequired
managingDirectors
string
commercialRegisterEntry
stringRequired
taxId
stringRequired
location__addressLine1
string
location__addressLine2
string
location__postalCode
string
location__city
string
location__regionCode
string
location__countryCode
string
bankAccount__iban
string
bankAccount__bic
string
bankAccount__bank
string
paymentTerms
objectRequired
timeZone
stringRequired
defaultCheckInTime
stringRequired
defaultCheckOutTime
stringRequired
currencyCode
stringRequired

Action Response

data
object
successful
boolean
error

Get unit attribute listyou must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Action Parameters

pageNumber
integerDefaults to 1
pageSize
integer

Action Response

data
object
successful
boolean
error

This endpoint deletes transactional data for a property in ‘test’ status. requires ‘properties.manage’ or ‘setup.manage’ scopes.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Use this call to delete a unit group.you must have at least one of these scopes: ‘unitgroups.delete, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Get a property by id.you need to be authorized (no particular scope required)

Action Parameters

id
stringRequired
languages
array
expand
array

Action Response

data
object
successful
boolean
error

Check if a unit attribute existsyou must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Use this call to create a new unit attribute.you must have at least one of these scopes: ‘unitattributes.create, setup.manage’.

Action Parameters

description
string
name
stringRequired

Action Response

data
object
successful
boolean
error

Use this call to modify a unit group.you must have at least one of these scopes: ‘unitgroups.manage, setup.manage’.

Action Parameters

id
stringRequired
description
objectRequired
name
objectRequired
maxPersons
integer
rank
integer
connectedUnitGroups
array

Action Response

data
object
successful
boolean
error

Check if a unit group exists by id.you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Use this call to create multiple units, following a naming rule.you must have at least one of these scopes: ‘units.create, setup.manage’.

Action Parameters

units
arrayRequired

Action Response

data
object
successful
boolean
error

Get unit attribute by idyou must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Return total count of propertiesyou need to be authorized (no particular scope required)

Action Parameters

Action Response

data
object
successful
boolean
error

Returns a list of iso country codes that could be used to create properties.you need to be authorized (no particular scope required)

Action Parameters

Action Response

data
object
successful
boolean
error

Use this call to create a new unit group.you must have at least one of these scopes: ‘unitgroups.create, setup.manage’.

Action Parameters

description
objectRequired
code
stringRequired
propertyId
stringRequired
name
objectRequired
maxPersons
integerRequired
rank
integer
type
string
connectedUnitGroups
array

Action Response

data
object
successful
boolean
error

Check if a unit exists by id.you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Use this call to create a new unit.you must have at least one of these scopes: ‘units.create, setup.manage’.

Action Parameters

description
objectRequired
propertyId
stringRequired
name
stringRequired
unitGroupId
string
maxPersons
integerRequired
condition
string
attributes
array
connectedUnits
array

Action Response

data
object
successful
boolean
error

Use this call to delete a unit.you must have at least one of these scopes: ‘units.delete, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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’.

Action Parameters

id
stringRequired
description
object
code
stringRequired
name
objectRequired
companyName
stringRequired
managingDirectors
string
commercialRegisterEntry
stringRequired
taxId
stringRequired
location__addressLine1
string
location__addressLine2
string
location__postalCode
string
location__city
string
location__regionCode
string
location__countryCode
string
bankAccount__iban
string
bankAccount__bic
string
bankAccount__bank
string
paymentTerms
objectRequired
timeZone
stringRequired
defaultCheckInTime
stringRequired
defaultCheckOutTime
stringRequired
currencyCode
stringRequired

Action Response

data
object
successful
boolean
error

Get a unit group by id.you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Action Parameters

id
stringRequired
languages
array
expand
array

Action Response

data
object
successful
boolean
error

Get the list of unit groups.you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Action Parameters

propertyId
string
unitGroupTypes
array
pageNumber
integerDefaults to 1
pageSize
integer
expand
array

Action Response

data
object
successful
boolean
error

Use this endpoint to archive an existing live property this operation set the isarchived flag to trueyou must have at least one of these scopes: ‘properties.manage, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Deletes unit attributeyou must have at least one of these scopes: ‘unitattributes.delete, setup.manage’.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Get the list of properties.you need to be authorized (no particular scope required)

Action Parameters

status
array
includeArchived
boolean
countryCode
array
pageNumber
integerDefaults to 1
pageSize
integer
expand
array

Action Response

data
object
successful
boolean
error

Get the list of units.you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Action Parameters

propertyId
string
unitGroupId
string
unitGroupIds
array
unitAttributeIds
array
isOccupied
boolean
maintenanceType
string
condition
string
textSearch
string
pageNumber
integerDefaults to 1
pageSize
integer
expand
array

Action Response

data
object
successful
boolean
error

Returns number of units matching the filter criteriayou must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Action Parameters

propertyId
string
unitGroupId
string
unitGroupIds
array
unitAttributeIds
array
isOccupied
boolean
maintenanceType
string
condition
string
textSearch
string

Action Response

data
object
successful
boolean
error

Returns number of unit groups matching the filter criteriayou must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Action Parameters

propertyId
string
unitGroupTypes
array

Action Response

data
object
successful
boolean
error

Check if a property exists by id.you need to be authorized (no particular scope required)

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error