Apaleo

apaleo

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

Scheduling & Booking Accounting Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (29)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Archive a propertyAPALEO_ARCHIVE_A_PROPERTYAcción

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

Parámetros de entrada

idstringObligatorio
The id of the property

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check if a property existsAPALEO_CHECK_IF_A_PROPERTY_EXISTSAcción

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

Parámetros de entrada

idstringObligatorio
The id of the property.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check if a unit attribute existsAPALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTSAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit attribute.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check if a unit existsAPALEO_CHECK_IF_A_UNIT_EXISTSAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check if a unit group existsAPALEO_CHECK_IF_A_UNIT_GROUP_EXISTSAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Clones a propertyAPALEO_CLONES_A_PROPERTYAcción

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

Parámetros de entrada

idstringObligatorio
The id of the property.
codestringObligatorio
The code for the property that can be shown in reports and table views
nameobjectObligatorio
The name for the property
taxIdstringObligatorio
The Tax-ID of the company running the property, as it should appear on invoices
timeZonestringObligatorio
The time zone name of the property from the IANA Time Zone Database. (see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
companyNamestringObligatorio
The legal name of the company running the property.
descriptionobject
The description for the property
currencyCodestringObligatorio
The currency a property works with.
paymentTermsobjectObligatorio
The payment terms used for all rate plans
location__citystring
City
bankAccount__bicstring
Bic
bankAccount__bankstring
Bank
bankAccount__ibanstring
Iban
managingDirectorsstring
The managing director(s) of the company, as they should appear on invoices
defaultCheckInTimestringObligatorio
The default check-in time A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
defaultCheckOutTimestringObligatorio
The default check-out time A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
location__postalCodestring
Postalcode
location__regionCodestring
The ISO 3166-2 code
location__countryCodestring
The country code, in ISO 3166-1 alpha-2 code
location__addressLine1string
Addressline1
location__addressLine2string
Addressline2
commercialRegisterEntrystringObligatorio
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a unitAPALEO_CREATE_A_UNITAcción

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

Parámetros de entrada

namestringObligatorio
The name for the unit
conditionstringenum
Condition of the unit
CleanCleanToBeInspectedDirty
attributesobject[]
Collection of user defined attributes of unit
maxPersonsintegerObligatorio
Maximum number of persons for the unit
propertyIdstringObligatorio
The id of the property where the unit will be created
descriptionobjectObligatorio
The description for the unit
unitGroupIdstring
The id of the unit group
connectedUnitsobject[]
The list of units this unit is composed of

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a unit attributeAPALEO_CREATE_A_UNIT_ATTRIBUTEAcción

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

Parámetros de entrada

namestringObligatorio
The name of the unit attribute
descriptionstring
The description of the unit attribute

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a unit groupAPALEO_CREATE_A_UNIT_GROUPAcción

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

Parámetros de entrada

codestringObligatorio
The code for the unit group that can be shown in reports and table views
nameobjectObligatorio
The name for the unit group
rankinteger
The unit group rank Restrictions: - Should be greater or equal to one
typestringenum
The unit group type
BedRoomMeetingRoomEventSpaceParkingLot
maxPersonsintegerObligatorio
Maximum number of persons for the unit group
propertyIdstringObligatorio
The id of the property where unit group will be created
descriptionobjectObligatorio
The description for the unit group
connectedUnitGroupsobject[]
The list of connected unit groups this unit group is composed of

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create multiple unitsAPALEO_CREATE_MULTIPLE_UNITSAcción

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

Parámetros de entrada

unitsobject[]Obligatorio
Units

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Creates a propertyAPALEO_CREATES_A_PROPERTYAcción

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

Parámetros de entrada

codestringObligatorio
The code for the property that can be shown in reports and table views
nameobjectObligatorio
The name for the property
taxIdstringObligatorio
The Tax-ID of the company running the property, as it should appear on invoices
timeZonestringObligatorio
The time zone name of the property from the IANA Time Zone Database. (see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
companyNamestringObligatorio
The legal name of the company running the property.
descriptionobject
The description for the property
currencyCodestringObligatorio
The currency a property works with.
paymentTermsobjectObligatorio
The payment terms used for all rate plans
location__citystring
City
bankAccount__bicstring
Bic
bankAccount__bankstring
Bank
bankAccount__ibanstring
Iban
managingDirectorsstring
The managing director(s) of the company, as they should appear on invoices
defaultCheckInTimestringObligatorio
The default check-in time A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
defaultCheckOutTimestringObligatorio
The default check-out time A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
location__postalCodestring
Postalcode
location__regionCodestring
The ISO 3166-2 code
location__countryCodestring
The country code, in ISO 3166-1 alpha-2 code
location__addressLine1string
Addressline1
location__addressLine2string
Addressline2
commercialRegisterEntrystringObligatorio
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a unitAPALEO_DELETE_A_UNITAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a unit groupAPALEO_DELETE_A_UNIT_GROUPAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Deletes unit attributeAPALEO_DELETES_UNIT_ATTRIBUTEAcción

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

Parámetros de entrada

idstringObligatorio
Id of unit attribute

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a properties listAPALEO_GET_A_PROPERTIES_LISTAcción

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

Parámetros de entrada

expandstring[]
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
statusstring[]
Filter result by property status
pageSizeinteger
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
pageNumberinteger
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
countryCodestring[]
Filter result by country code
includeArchivedboolean
Include archived properties in the result. If not set, or set to false, it only returns non-archived properties

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a propertyAPALEO_GET_A_PROPERTYAcción

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

Parámetros de entrada

idstringObligatorio
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.
languagesstring[]
"all" or comma separated list of two-letter language codes (ISO Alpha-2)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a unitAPALEO_GET_A_UNITAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit.
expandstring[]
List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits. All other values will be silently ignored.
languagesstring[]
"all" or comma separated list of two-letter language codes (ISO Alpha-2)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a unit groupAPALEO_GET_A_UNIT_GROUPAcción

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

Parámetros de entrada

idstringObligatorio
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.
languagesstring[]
"all" or comma separated list of two-letter language codes (ISO Alpha-2)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a units listAPALEO_GET_A_UNITS_LISTAcción

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

Parámetros de entrada

expandstring[]
List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits. All other values will be silently ignored.
pageSizeinteger
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
conditionstringenum
Return units with a specific condition
CleanCleanToBeInspectedDirty
isOccupiedboolean
Return only occupied or vacant units
pageNumberinteger
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
propertyIdstring
Return units for specific property
textSearchstring
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
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
maintenanceTypestringenum
Return units with the specific maintenance type
OutOfServiceOutOfOrderOutOfInventory
unitAttributeIdsstring[]
Return units with the specific unit attributes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get unit attribute by idAPALEO_GET_UNIT_ATTRIBUTE_BY_IDAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit attribute

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get unit attribute listAPALEO_GET_UNIT_ATTRIBUTE_LISTAcción

Get unit attribute list you must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.

Parámetros de entrada

pageSizeinteger
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
pageNumberinteger
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Unit GroupsAPALEO_LIST_UNIT_GROUPSAcción

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

Parámetros de entrada

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.
pageSizeinteger
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
pageNumberinteger
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
propertyIdstring
Return unit groups for specific property
unitGroupTypesstring[]
Unitgrouptypes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move property to liveAPALEO_MOVE_PROPERTY_TO_LIVEAcción

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

Parámetros de entrada

idstringObligatorio
The id of the property

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replace a unit groupAPALEO_REPLACE_A_UNIT_GROUPAcción

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

Parámetros de entrada

idstringObligatorio
The id of the unit group.
nameobjectObligatorio
The name for the unit group
rankinteger
The unit group rank Restrictions: - Should be greater or equal to one
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.
descriptionobjectObligatorio
The description for the unit group
connectedUnitGroupsobject[]
The list of connected unit groups this unit group is composed of

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reset Property DataAPALEO_RESET_PROPERTY_DATAAcción

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

Parámetros de entrada

idstringObligatorio
The id of the property

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns a list of supported countriesAPALEO_RETURNS_A_LIST_OF_SUPPORTED_COUNTRIESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns number of unit groupsAPALEO_RETURNS_NUMBER_OF_UNIT_GROUPSAcción

Returns number of unit groups matching the filter criteria you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.

Parámetros de entrada

propertyIdstring
Return unit groups for specific property
unitGroupTypesstring[]
Unitgrouptypes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns number of unitsAPALEO_RETURNS_NUMBER_OF_UNITSAcción

Returns number of units matching the filter criteria you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

Parámetros de entrada

conditionstringenum
Return units with a specific condition
CleanCleanToBeInspectedDirty
isOccupiedboolean
Return only occupied or vacant units
propertyIdstring
Return units for specific property
textSearchstring
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
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
maintenanceTypestringenum
Return units with the specific maintenance type
OutOfServiceOutOfOrderOutOfInventory
unitAttributeIdsstring[]
Return units with the specific unit attributes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Return total count of propertiesAPALEO_RETURN_TOTAL_COUNT_OF_PROPERTIESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not