Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node interacts with the Apaleo API to retrieve the count of folios based on various filtering criteria. It is useful in scenarios where you need to quickly determine how many folios meet specific conditions without retrieving full folio details. For example, a hotel management system might use this node to count all guest folios created within a date range or to find how many folios are currently open and have invoices.

Properties

Name Meaning
Property IDs Filter folio list by one or more property IDs (comma-separated string).
Company IDs Filter folio list by one or more company IDs (comma-separated string).
Reservation IDs Filter folio list by one or more reservation IDs (comma-separated string).
Booking IDs Filter folio list by one or more booking IDs (comma-separated string).
Is Empty If true, only return empty folios (no unmoved charges, no unmoved payments, no allowances).
Checked Out On Accounts Receivable If true, only return folios that have been checked out on accounts receivables.
Exclude Closed If true, closed folios are filtered out from the result collection.
Has Invoices If true, only return folios that have invoices.
Created From Inclusive start datetime filter for folio creation date.
Created To Exclusive end datetime filter for folio creation date.
Updated From Inclusive start datetime filter for last update date of folio.
Updated To Exclusive end datetime filter for last update date of folio.
Only Main If true, only main folios are returned.
Type The type of the folio. Options: House, Guest, External, Booking.
External Folio Code Allows filtering external folios by their code.
Text Search Filter folios by debitor first/last name, company name, or folio ID using text search.
Balance Filter Filter folios based on their balance using expressions like eq_5 (equal 5), lte_7 (less than or equal 7).

Output

The node outputs a JSON object containing the count of folios matching the specified filters. The output structure typically includes a field representing the total count number. There is no binary data output for this operation.

Example output JSON:

{
  "count": 123
}

Dependencies

  • Requires an API key credential for authenticating with the Apaleo API.
  • The node uses the base URL https://api.apaleo.com for requests.
  • Proper configuration of the API authentication token is necessary in n8n credentials.

Troubleshooting

  • Common issues:

    • Invalid or expired API token may cause authentication errors.
    • Incorrect filter formats (e.g., malformed date strings or invalid balance filter syntax) can lead to request failures.
    • Network connectivity problems may prevent reaching the Apaleo API endpoint.

  • Error messages:

    • Authentication errors usually indicate missing or invalid API credentials; verify and update the API key.
    • Validation errors on input parameters suggest checking the format and allowed values for each filter.
    • Rate limiting or quota exceeded errors require waiting or adjusting API usage limits.

Links and References

Discussion