Apaleo | Composio Docs

Overview

SLUG

APALEO

Description

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

Authentication Details

OAuth2

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

bearer_token

string

Tools

Creates a property

SLUG: APALEO_CREATES_A_PROPERTY

Use this call to create a new property.<br />you must have at least one of these scopes: 'properties.create, setup.manage'.

Action Parameters

bankAccount__bank

string

bankAccount__bic

string

bankAccount__iban

string

code

stringRequired

commercialRegisterEntry

stringRequired

companyName

stringRequired

currencyCode

stringRequired

defaultCheckInTime

stringRequired

defaultCheckOutTime

stringRequired

description

object

location__addressLine1

string

location__addressLine2

string

location__city

string

location__countryCode

string

location__postalCode

string

location__regionCode

string

managingDirectors

string

name

objectRequired

paymentTerms

objectRequired

taxId

stringRequired

timeZone

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create a unit

SLUG: APALEO_CREATE_A_UNIT

Use this call to create a new unit.<br />you must have at least one of these scopes: 'units.create, setup.manage'.

Action Parameters

attributes

array

condition

string

connectedUnits

array

description

objectRequired

maxPersons

integerRequired

name

stringRequired

propertyId

stringRequired

unitGroupId

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get a properties list

SLUG: APALEO_GET_A_PROPERTIES_LIST

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

Action Parameters

countryCode

array

expand

array

includeArchived

boolean

pageNumber

integerDefaults to 1

pageSize

integer

status

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get a unit

SLUG: APALEO_GET_A_UNIT

Get a unit by id.<br />you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

Action Parameters

expand

array

stringRequired

languages

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive a property

SLUG: APALEO_ARCHIVE_A_PROPERTY

Use this endpoint to archive an existing live property this operation set the isarchived flag to true<br />you must have at least one of these scopes: 'properties.manage, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Check if a property exists

SLUG: APALEO_CHECK_IF_A_PROPERTY_EXISTS

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

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Check if a unit attribute exists

SLUG: APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTS

Check if a unit attribute exists<br />you must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Check if a unit exists

SLUG: APALEO_CHECK_IF_A_UNIT_EXISTS

Check if a unit exists by id.<br />you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Check if a unit group exists

SLUG: APALEO_CHECK_IF_A_UNIT_GROUP_EXISTS

Check if a unit group exists by id.<br />you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Clones a property

SLUG: APALEO_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.<br />you must have at least one of these scopes: 'properties.create, setup.manage'.

Action Parameters

bankAccount__bank

string

bankAccount__bic

string

bankAccount__iban

string

code

stringRequired

commercialRegisterEntry

stringRequired

companyName

stringRequired

currencyCode

stringRequired

defaultCheckInTime

stringRequired

defaultCheckOutTime

stringRequired

description

object

stringRequired

location__addressLine1

string

location__addressLine2

string

location__city

string

location__countryCode

string

location__postalCode

string

location__regionCode

string

managingDirectors

string

name

objectRequired

paymentTerms

objectRequired

taxId

stringRequired

timeZone

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create a unit attribute

SLUG: APALEO_CREATE_A_UNIT_ATTRIBUTE

Use this call to create a new unit attribute.<br />you must have at least one of these scopes: 'unitattributes.create, setup.manage'.

Action Parameters

description

string

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create a unit group

SLUG: APALEO_CREATE_A_UNIT_GROUP

Use this call to create a new unit group.<br />you must have at least one of these scopes: 'unitgroups.create, setup.manage'.

Action Parameters

code

stringRequired

connectedUnitGroups

array

description

objectRequired

maxPersons

integerRequired

name

objectRequired

propertyId

stringRequired

rank

integer

type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create multiple units

SLUG: APALEO_CREATE_MULTIPLE_UNITS

Use this call to create multiple units, following a naming rule.<br />you must have at least one of these scopes: 'units.create, setup.manage'.

Action Parameters

units

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Deletes unit attribute

SLUG: APALEO_DELETES_UNIT_ATTRIBUTE

Deletes unit attribute<br />you must have at least one of these scopes: 'unitattributes.delete, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete a unit

SLUG: APALEO_DELETE_A_UNIT

Use this call to delete a unit.<br />you must have at least one of these scopes: 'units.delete, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete a unit group

SLUG: APALEO_DELETE_A_UNIT_GROUP

Use this call to delete a unit group.<br />you must have at least one of these scopes: 'unitgroups.delete, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get a property

SLUG: APALEO_GET_A_PROPERTY

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

Action Parameters

expand

array

stringRequired

languages

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get a units list

SLUG: APALEO_GET_A_UNITS_LIST

Get the list of units.<br />you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

Action Parameters

condition

string

expand

array

isOccupied

boolean

maintenanceType

string

pageNumber

integerDefaults to 1

pageSize

integer

propertyId

string

textSearch

string

unitAttributeIds

array

unitGroupId

string

unitGroupIds

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get a unit group

SLUG: APALEO_GET_A_UNIT_GROUP

Get a unit group by id.<br />you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.

Action Parameters

expand

array

stringRequired

languages

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get unit attribute by id

SLUG: APALEO_GET_UNIT_ATTRIBUTE_BY_ID

Get unit attribute by id<br />you must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired