NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Apaleo connects to a Nagent workspace with OAuth sign-in. Once it is connected, agents can call 29 Apaleo actions, such as "Create a unit", "Create a unit attribute" and "Create a unit group". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Apaleo, with input parameters and output schema.
APALEO_ARCHIVE_A_PROPERTYUse 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'.
Input parameters
The id of the property
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CHECK_IF_A_PROPERTY_EXISTSCheck if a property exists by id.<br>You need to be authorized (no particular scope required)
Input parameters
The id of the property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTSCheck if a unit attribute exists<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Input parameters
The id of the unit attribute.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CHECK_IF_A_UNIT_EXISTSCheck if a unit exists by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Input parameters
The id of the unit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CHECK_IF_A_UNIT_GROUP_EXISTSCheck if a unit group exists by id.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Input parameters
The id of the unit group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CLONES_A_PROPERTYUse 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'.
Input parameters
The id of the property.
The code for the property that can be shown in reports and table views
The name for the property
The Tax-ID of the company running the property, as it should appear on invoices
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)
The legal name of the company running the property.
The description for the property
The currency a property works with.
The payment terms used for all rate plans
City
Bic
Bank
Iban
The managing director(s) of the company, as they should appear on invoices
The default check-in time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
The default check-out time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
Postalcode
The ISO 3166-2 code
The country code, in ISO 3166-1 alpha-2 code
Addressline1
Addressline2
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CREATE_A_UNITUse this call to create a new unit.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
Input parameters
The name for the unit
Condition of the unit
Collection of user defined attributes of unit
Maximum number of persons for the unit
The id of the property where the unit will be created
The description for the unit
The id of the unit group
The list of units this unit is composed of
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CREATE_A_UNIT_ATTRIBUTEUse this call to create a new unit attribute.<br>You must have at least one of these scopes: 'unitattributes.create, setup.manage'.
Input parameters
The name of the unit attribute
The description of the unit attribute
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CREATE_A_UNIT_GROUPUse this call to create a new unit group.<br>You must have at least one of these scopes: 'unitgroups.create, setup.manage'.
Input parameters
The code for the unit group that can be shown in reports and table views
The name for the unit group
The unit group rank Restrictions: - Should be greater or equal to one
The unit group type
Maximum number of persons for the unit group
The id of the property where unit group will be created
The description for the unit group
The list of connected unit groups this unit group is composed of
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CREATE_MULTIPLE_UNITSUse this call to create multiple units, following a naming rule.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
Input parameters
Units
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_CREATES_A_PROPERTYUse this call to create a new property.<br>You must have at least one of these scopes: 'properties.create, setup.manage'.
Input parameters
The code for the property that can be shown in reports and table views
The name for the property
The Tax-ID of the company running the property, as it should appear on invoices
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)
The legal name of the company running the property.
The description for the property
The currency a property works with.
The payment terms used for all rate plans
City
Bic
Bank
Iban
The managing director(s) of the company, as they should appear on invoices
The default check-in time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
The default check-out time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
Postalcode
The ISO 3166-2 code
The country code, in ISO 3166-1 alpha-2 code
Addressline1
Addressline2
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_DELETE_A_UNITUse this call to delete a unit.<br>You must have at least one of these scopes: 'units.delete, setup.manage'.
Input parameters
The id of the unit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_DELETE_A_UNIT_GROUPUse this call to delete a unit group.<br>You must have at least one of these scopes: 'unitgroups.delete, setup.manage'.
Input parameters
The id of the unit group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_DELETES_UNIT_ATTRIBUTEDeletes unit attribute<br>You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
Input parameters
Id of unit attribute
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_A_PROPERTIES_LISTGet the list of properties.<br>You need to be authorized (no particular scope required)
Input parameters
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
Filter result by property status
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
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.
Filter result by country code
Include archived properties in the result. If not set, or set to false, it only returns non-archived properties
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_A_PROPERTYGet a property by id.<br>You need to be authorized (no particular scope required)
Input parameters
The id of the property.
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
"all" or comma separated list of two-letter language codes (ISO Alpha-2)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_A_UNITGet a unit by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Input parameters
The id of the unit.
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.
"all" or comma separated list of two-letter language codes (ISO Alpha-2)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_A_UNIT_GROUPGet a unit group by id.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Input parameters
The id of the unit group.
List of all embedded resources that should be expanded in the response. Possible values are: property, connectedUnitGroups. All other values will be silently ignored.
"all" or comma separated list of two-letter language codes (ISO Alpha-2)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_A_UNITS_LISTGet the list of units.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Input parameters
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.
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
Return units with a specific condition
Return only occupied or vacant units
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.
Return units for specific property
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use `UnitGroupIds` instead</b>
Return units with the specific unit groups
Return units with the specific maintenance type
Return units with the specific unit attributes
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_UNIT_ATTRIBUTE_BY_IDGet unit attribute by id<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Input parameters
The id of the unit attribute
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_GET_UNIT_ATTRIBUTE_LISTGet unit attribute list<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Input parameters
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_LIST_UNIT_GROUPSGet the list of unit groups.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Input parameters
List of all embedded resources that should be expanded in the response. Possible values are: property, connectedUnitGroups. All other values will be silently ignored.
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
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.
Return unit groups for specific property
Unitgrouptypes
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_MOVE_PROPERTY_TO_LIVEUse this endpoint to move an existing test property to live This operation changes the property status to 'Live'<br>You must have at least one of these scopes: 'properties.manage, setup.manage'.
Input parameters
The id of the property
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_REPLACE_A_UNIT_GROUPUse this call to modify a unit group.<br>You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.
Input parameters
The id of the unit group.
The name for the unit group
The unit group rank Restrictions: - Should be greater or equal to one
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.
The description for the unit group
The list of connected unit groups this unit group is composed of
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_RESET_PROPERTY_DATAThis endpoint deletes transactional data for a property in 'Test' status. Requires 'properties.manage' or 'setup.manage' scopes.
Input parameters
The id of the property
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_RETURNS_A_LIST_OF_SUPPORTED_COUNTRIESReturns a list of ISO country codes that could be used to create properties.<br>You need to be authorized (no particular scope required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_RETURNS_NUMBER_OF_UNIT_GROUPSReturns number of unit groups matching the filter criteria<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Input parameters
Return unit groups for specific property
Unitgrouptypes
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_RETURNS_NUMBER_OF_UNITSReturns number of units matching the filter criteria<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Input parameters
Return units with a specific condition
Return only occupied or vacant units
Return units for specific property
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use `UnitGroupIds` instead</b>
Return units with the specific unit groups
Return units with the specific maintenance type
Return units with the specific unit attributes
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIESReturn total count of properties<br>You need to be authorized (no particular scope required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 29 Apaleo actions on Nagent, including "Create a unit", "Create a unit attribute" and "Create a unit group". 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'. Each action is listed on this page with its input parameters and its output.
Apaleo connects with OAuth sign-in, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create a unit takes 4 required inputs: name, maxPersons, propertyId and description. It also takes 4 optional inputs: condition, attributes, unitGroupId and connectedUnits. It returns data, error and successful.