Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node interacts with the Apaleo API to retrieve information about folios, specifically supporting an operation to get the count of folios matching certain criteria. It is useful in scenarios where you need to quickly determine how many folios exist that meet specific filters 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 (not closed).

Properties

Name Meaning
Property IDs Filter folios by one or more property IDs (comma-separated string).
Company IDs Filter folios by one or more company IDs (comma-separated string).
Reservation IDs Filter folios by one or more reservation IDs (comma-separated string).
Booking IDs Filter folios by one or more booking IDs (comma-separated string).
Is Empty If true, only return folios that have no unmoved charges, payments, or allowances (empty folios).
Checked Out On Accounts Receivable If true, only return folios that have been checked out on accounts receivables.
Exclude Closed If true, exclude folios that are closed from the results.
Has Invoices If true, only return folios that have associated 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 folios.
Updated To Exclusive end datetime filter for last update date of folios.
Only Main If true, only main folios are returned.
Type The type of folio to filter by. Options: House, Guest, External, Booking.
External Folio Code Filter external folios by their code.
Text Search Filter folios by debtor 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), etc.

Output

The node outputs a JSON object containing the count of folios that match the specified filters. The exact structure is not detailed in the source but typically would be something like:

{
  "count": <number>
}

There is no indication that the node outputs binary data.

Dependencies

  • Requires an API authentication token (access token) for the Apaleo API.
  • The node uses the base URL https://api.apaleo.com and expects JSON content.
  • Proper credentials must be configured in n8n to authenticate requests to Apaleo.

Troubleshooting

  • Common issues:
    • Invalid or expired API token will cause authentication errors.
    • Incorrectly formatted filter strings (e.g., property IDs) may result in API errors or empty results.
    • Date filters must be valid ISO date-time strings; invalid formats can cause request failures.
  • Error messages:
    • Authentication errors usually indicate missing or invalid API credentials.
    • Validation errors from the API may indicate unsupported filter values or malformed parameters.
  • Resolution:
    • Ensure API credentials are correctly set up and valid.
    • Validate input parameters before running the node.
    • Use the API documentation to confirm supported filter formats.

Links and References

Discussion