Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node interacts with the Apaleo API to retrieve folio data based on various filtering criteria. Specifically, the "GET folios" operation fetches a list of folios, which are records typically representing charges and payments associated with bookings or guests in hospitality management systems.

Common scenarios for using this node include:

  • Retrieving folios related to specific properties, companies, reservations, or bookings.
  • Filtering folios by their status (e.g., excluding closed folios, only empty folios).
  • Searching folios by text fields such as debitor names or folio IDs.
  • Paginating through large sets of folios.
  • Filtering folios by creation or update timestamps.
  • Selecting folios by type (House, Guest, External, Booking).

Practical examples:

  • A hotel system integration that pulls all open guest folios updated within the last day to synchronize financial data.
  • Generating reports on folios that have invoices issued.
  • Fetching only main folios for reconciliation purposes.

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 folios that have no unmoved charges, no unmoved payments, and 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 issued.
Created From Inclusive start datetime filter for the folio creation date.
Created To Exclusive end datetime filter for the folio creation date.
Updated From Inclusive start datetime filter for the folio last update date.
Updated To Exclusive end datetime filter for the folio last update date.
Only Main If true, only main folios are returned.
Type The type of the folio. Options: House, Guest, External, Booking.
External Folio Code Filter external folios by their code.
Text Search Filter folios by debitor first/last name, company name, or folio ID.
Balance Filter Filter folios based on their balance using expressions like eq_5 (equal to 5), lte_7 (less than or equal to 7).
Page Number Page number for pagination (1-based).
Page Size Number of items per page for pagination.

Output

The node outputs an array of folio objects in the json field of the output data. Each folio object contains detailed information about individual folios retrieved from the Apaleo API, including identifiers, status, balances, types, and related entities such as bookings or reservations.

If binary data were involved (not indicated here), it would represent file attachments or documents related to folios, but this operation focuses on JSON data.

Dependencies

  • Requires an active connection to the Apaleo API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for API requests is https://api.apaleo.com.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Authentication errors: Ensure the API key or token credential is correctly set up and has not expired.
  • Empty results: Verify that the filter parameters are correct and match existing folios; overly restrictive filters may yield no data.
  • Pagination issues: If expecting more results, check that Page Number and Page Size are set appropriately.
  • Invalid filter format: For filters like Balance Filter, ensure the syntax matches expected patterns (e.g., eq_5, lte_7).
  • API rate limits: If many requests are made rapidly, the API might throttle; implement retry logic or reduce request frequency.

Links and References

Discussion