Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node interacts with the Apaleo API to retrieve folio data. Specifically, the "GET folios" operation fetches a list of folios filtered by various criteria such as property IDs, company IDs, reservation IDs, booking IDs, date ranges, and other folio attributes.

Use cases include:

  • Retrieving folios related to specific properties or companies for reporting or reconciliation.
  • Filtering folios based on their status (e.g., excluding closed folios or only returning empty folios).
  • Searching folios by text fields like debitor name or folio ID.
  • Paginating through large sets of folios to process them in batches.

Practical example:

  • A hotel management system could use this node to pull all guest folios created within a certain date range that have outstanding balances, enabling automated follow-up on payments.

Properties

Name Meaning
Property IDs Filter folio list by one or more property IDs (string)
Company IDs Filter folio list by one or more company IDs (string)
Reservation IDs Filter folio list by one or more reservation IDs (string)
Booking IDs Filter folio list by one or more booking IDs (string)
Is Empty If true, only return folios with no unmoved charges, payments, or allowances (boolean)
Checked Out On Accounts Receivable If true, only return folios checked out on accounts receivables (boolean)
Exclude Closed If true, exclude closed folios from the results (boolean)
Has Invoices If true, only return folios that have been invoiced (boolean)
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 folio update
Updated To Exclusive end datetime filter for last folio update
Only Main If true, only main folios are returned (boolean)
Type The type of folio; options: House, Guest, External, Booking
External Folio Code Filter external folios by their code (string)
Text Search Filter folios by debitor first/last name, company name, or folio ID (string)
Balance Filter Filter folios based on balance conditions (e.g., eq_5, lte_7) (string)
Page Number Page number for pagination (1-based) (number)
Page Size Number of items per page for pagination (number)

Output

The node outputs an array of folio objects in the json field of each item. Each folio object contains detailed information about the folio matching the specified filters, including identifiers, status, balances, and related metadata.

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

Dependencies

  • Requires an active connection to the Apaleo API using an API authentication token.
  • The node expects the user to configure credentials providing access tokens for the Apaleo API.
  • Network connectivity to https://api.apaleo.com is necessary.

Troubleshooting

  • Common issues:

    • Invalid or expired API token: The node will fail to authenticate. Refresh or reconfigure the API credentials.
    • Incorrect filter formats: For example, malformed date strings or invalid balance filter syntax may cause errors or empty results.
    • Pagination parameters out of range: Using page numbers or sizes that exceed available data may return empty arrays.

  • Error messages:

    • Authentication errors usually indicate problems with the API key or token.
    • Validation errors may occur if input parameters do not conform to expected formats.
    • Network errors can happen if the API endpoint is unreachable.

To resolve these:

  • Verify API credentials and refresh tokens if needed.
  • Double-check input parameter formats, especially dates and filter strings.
  • Ensure network access to the Apaleo API endpoint.

Links and References

Discussion