apaleo

apaleo integration (Productivity, Finance). Imported from open-connector.

OAuth29 toolshttps://api.apaleo.com

GET

apaleo_list_properties

List properties accessible to the connected apaleo account, with optional status, archive, country, and expansion filters.

/inventory/v1/properties

6 parameters

Param	Type	Required	Description
status	array	optional	Filter results by one or more property statuses.
includeArchived	boolean	optional	Whether archived properties should be included.
countryCode	array	optional	Filter results by ISO country code.
pageNumber	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of items to return per page.
expand	array	optional	Embedded resources to expand in the property response.

GET

apaleo_count_properties

Return the total number of properties accessible to the connected apaleo account.

/inventory/v1/properties/$count

GET

apaleo_get_property

Get one property by ID, including optional localized fields and expanded actions.

/inventory/v1/properties/{id}

3 parameters

Param	Type	Required	Description
id	string	required	The apaleo resource ID.
languages	array	optional	Return all languages or the listed ISO Alpha-2 language codes.
expand	array	optional	Embedded resources to expand in the property response.

GET

apaleo_check_property_exists

Check whether a property exists by ID.

/inventory/v1/properties/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

POST

apaleo_create_property

Create a new property in apaleo.

/inventory/v1/properties

15 parameters

Param	Type	Required	Description
code	string	required	Property code shown in reports and table views.
name	object	required	Localized property name.
companyName	string	required	Legal company name for the property.
managingDirectors	string	optional	Managing directors shown on invoices.
commercialRegisterEntry	string	required	Commercial register entry shown on invoices.
taxId	string	required	Tax identification number shown on invoices.
description	object	optional	Localized property description.
location	object	required	Property address used during creation.
bankAccount	object	optional	Property bank account details.
paymentTerms	object	required	Localized payment terms used by the property.
timeZone	string	required	IANA time zone name.
defaultCheckInTime	string	required	Default check-in time in ISO 8601 time format.
defaultCheckOutTime	string	required	Default check-out time in ISO 8601 time format.
currencyCode	string	required	ISO 4217 currency code.
idempotencyKey	string	optional	Optional idempotency key used to safely retry the request.

POST

apaleo_clone_property

Clone an existing property into a new property with inventory and rate plans.

/inventory/v1/property-actions/{id}/clone

16 parameters

Param	Type	Required	Description
code	string	required	Property code shown in reports and table views.
name	object	required	Localized property name.
companyName	string	required	Legal company name for the property.
managingDirectors	string	optional	Managing directors shown on invoices.
commercialRegisterEntry	string	required	Commercial register entry shown on invoices.
taxId	string	required	Tax identification number shown on invoices.
description	object	optional	Localized property description.
location	object	required	Property address used during creation.
bankAccount	object	optional	Property bank account details.
paymentTerms	object	required	Localized payment terms used by the property.
timeZone	string	required	IANA time zone name.
defaultCheckInTime	string	required	Default check-in time in ISO 8601 time format.
defaultCheckOutTime	string	required	Default check-out time in ISO 8601 time format.
currencyCode	string	required	ISO 4217 currency code.
id	string	required	The apaleo resource ID.
idempotencyKey	string	optional	Optional idempotency key used to safely retry the request.

PUT

apaleo_archive_property

Archive a live property by ID.

/inventory/v1/property-actions/{id}/archive

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

PUT

apaleo_move_property_to_live

Move a test property to live status.

/inventory/v1/property-actions/{id}/set-live

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

PUT

apaleo_reset_property_data

Delete all transactional data for a test property.

/inventory/v1/property-actions/{id}/reset

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

GET

apaleo_list_supported_countries

List ISO country codes supported by apaleo property creation.

/inventory/v1/types/countries

GET

apaleo_list_units

List units with filters for property, unit group, attributes, occupancy, maintenance state, archive state, and expansions.

/inventory/v1/units

12 parameters

Param	Type	Required	Description
propertyId	string	optional	Return units for the specified property ID.
unitGroupId	string	optional	Deprecated single unit group filter kept for compatibility.
unitGroupIds	array	optional	Return units for the specified unit group IDs.
unitAttributeIds	array	optional	Return units that have the specified unit attribute IDs.
isOccupied	boolean	optional	Filter by occupied or vacant units.
maintenanceType	string	optional	Type of scheduled maintenance.
condition	string	optional	Current cleanliness state of the unit.
textSearch	string	optional	Case-insensitive search term matched against the unit name.
status	string	optional	Whether to return active units, archived units, or both.
pageNumber	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of items to return per page.
expand	array	optional	Embedded resources to expand in the unit response.

GET

apaleo_count_units

Return the total number of units matching the provided filters.

/inventory/v1/units/$count

9 parameters

Param	Type	Required	Description
propertyId	string	optional	Return units for the specified property ID.
unitGroupId	string	optional	Deprecated single unit group filter kept for compatibility.
unitGroupIds	array	optional	Return units for the specified unit group IDs.
unitAttributeIds	array	optional	Return units that have the specified unit attribute IDs.
isOccupied	boolean	optional	Filter by occupied or vacant units.
maintenanceType	string	optional	Type of scheduled maintenance.
condition	string	optional	Current cleanliness state of the unit.
textSearch	string	optional	Case-insensitive search term matched against the unit name.
status	string	optional	Whether to return active units, archived units, or both.

GET

apaleo_get_unit

Get one unit by ID, including optional localized fields and expansions.

/inventory/v1/units/{id}

3 parameters

Param	Type	Required	Description
id	string	required	The apaleo resource ID.
languages	array	optional	Return all languages or the listed ISO Alpha-2 language codes.
expand	array	optional	Embedded resources to expand in the unit response.

GET

apaleo_check_unit_exists

Check whether a unit exists by ID.

/inventory/v1/units/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

POST

apaleo_create_unit

Create a new unit.

/inventory/v1/units

9 parameters

Param	Type	Required	Description
propertyId	string	required	Property ID where the unit should be created.
name	string	required	Unit name.
description	object	required	Localized unit description.
unitGroupId	string	optional	Unit group ID for the new unit.
maxPersons	integer	required	Maximum occupancy of the unit.
condition	string	optional	Current cleanliness state of the unit.
attributes	array	optional	Unit attributes assigned to the unit.
connectedUnits	array	optional	Units used to compose this combined unit.
idempotencyKey	string	optional	Optional idempotency key used to safely retry the request.

POST

apaleo_create_multiple_units

Create multiple units in a single bulk request.

/inventory/v1/units/bulk

2 parameters

Param	Type	Required	Description
units	array	required	Units to create in bulk.
idempotencyKey	string	optional	Optional idempotency key used to safely retry the request.

DELETE

apaleo_delete_unit

Delete a unit by ID.

/inventory/v1/units/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

GET

apaleo_list_unit_groups

List unit groups with filters for property, unit group type, pagination, and embedded resources.

/inventory/v1/unit-groups

5 parameters

Param	Type	Required	Description
propertyId	string	optional	Return unit groups for the specified property ID.
unitGroupTypes	array	optional	Filter results by one or more unit group types.
pageNumber	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of items to return per page.
expand	array	optional	Embedded resources to expand in the unit group response.

GET

apaleo_count_unit_groups

Return the total number of unit groups matching the provided filters.

/inventory/v1/unit-groups/$count

2 parameters

Param	Type	Required	Description
propertyId	string	optional	Return unit groups for the specified property ID.
unitGroupTypes	array	optional	Filter results by one or more unit group types.

GET

apaleo_get_unit_group

Get one unit group by ID, including optional localized fields and expansions.

/inventory/v1/unit-groups/{id}

3 parameters

Param	Type	Required	Description
id	string	required	The apaleo resource ID.
languages	array	optional	Return all languages or the listed ISO Alpha-2 language codes.
expand	array	optional	Embedded resources to expand in the unit group response.

GET

apaleo_check_unit_group_exists

Check whether a unit group exists by ID.

/inventory/v1/unit-groups/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

POST

apaleo_create_unit_group

Create a new unit group.

/inventory/v1/unit-groups

9 parameters

Param	Type	Required	Description
code	string	required	Unit group code shown in reports and table views.
propertyId	string	required	Property ID where the unit group should be created.
name	object	required	Localized unit group name.
description	object	required	Localized unit group description.
maxPersons	integer	required	Maximum occupancy of the unit group.
rank	integer	optional	Sort rank of the unit group.
type	string	optional	Type of the unit group to create.
connectedUnitGroups	array	optional	Connected unit groups used by the new unit group.
idempotencyKey	string	optional	Optional idempotency key used to safely retry the request.

PUT

apaleo_replace_unit_group

Completely replace the mutable fields of an existing unit group.

/inventory/v1/unit-groups/{id}

6 parameters

Param	Type	Required	Description
name	object	required	Localized unit group name.
description	object	required	Localized unit group description.
maxPersons	integer	optional	Maximum occupancy of the unit group.
rank	integer	optional	Sort rank of the unit group.
connectedUnitGroups	array	optional	Connected unit groups used by the replaced unit group.
id	string	required	The apaleo resource ID.

DELETE

apaleo_delete_unit_group

Delete a unit group by ID.

/inventory/v1/unit-groups/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

GET

apaleo_list_unit_attributes

List unit attribute definitions for the current account.

/inventory/v1/unit-attributes

2 parameters

Param	Type	Required	Description
pageNumber	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of items to return per page.

GET

apaleo_get_unit_attribute

Get one unit attribute definition by ID.

/inventory/v1/unit-attributes/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

GET

apaleo_check_unit_attribute_exists

Check whether a unit attribute definition exists by ID.

/inventory/v1/unit-attributes/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.

POST

apaleo_create_unit_attribute

Create a new unit attribute definition.

/inventory/v1/unit-attributes

3 parameters

Param	Type	Required	Description
name	string	required	Name of the unit attribute definition.
description	string	optional	Description of the unit attribute definition.
idempotencyKey	string	optional	Optional idempotency key used to safely retry the request.

DELETE

apaleo_delete_unit_attribute

Delete a unit attribute definition by ID.

/inventory/v1/unit-attributes/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The apaleo resource ID.