Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Folio → GET folios

AI-generated

Overview

This node operation retrieves a list of folios from the Apaleo API based on various filtering criteria. It is useful for scenarios where users need to fetch folio data related to properties, companies, reservations, or bookings, and apply filters such as date ranges, folio types, and status flags. For example, a hotel management system could use this operation to get all guest folios created within a specific date range or to find folios that have invoices.

Use Case Examples

  1. Fetch all guest folios created between two dates.
  2. Retrieve folios filtered by property IDs and exclude closed folios.
  3. Get only main folios that have been checked out on accounts receivable.

Properties

Name Meaning
Property IDs Filter folio list by property IDs.
Company IDs Filter folio list by company IDs.
Reservation IDs Filter folio list by reservation IDs.
Booking IDs Filter folio list by booking IDs.
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 been invoiced.
Created From The inclusive start time of the date of creation to filter folios.
Created To The exclusive end time of the date of creation to filter folios.
Updated From The inclusive start time of the date of the last update to filter folios.
Updated To The exclusive end time of the date of the last update to filter folios.
Only Main If true, only main folios are returned.
Type The type of the folio to filter by.
External Folio Code Allows filtering external folios by code.
Text Search Filter folios by debitor first/last name, company name, or folio ID.
Balance Filter Filter folios based on their balance (e.g., eq_5, lte_7).
Page Number Page number for pagination (1-based).
Page Size Number of items per page for pagination.

Output

JSON

  • folioId - Unique identifier of the folio.
  • propertyId - Identifier of the property associated with the folio.
  • companyId - Identifier of the company associated with the folio.
  • reservationId - Identifier of the reservation linked to the folio.
  • bookingId - Identifier of the booking linked to the folio.
  • isEmpty - Indicates if the folio is empty (no unmoved charges, payments, or allowances).
  • checkedOutOnAccountsReceivable - Indicates if the folio has been checked out on accounts receivable.
  • isClosed - Indicates if the folio is closed.
  • hasInvoices - Indicates if the folio has associated invoices.
  • createdDate - Date and time when the folio was created.
  • updatedDate - Date and time when the folio was last updated.
  • type - Type of the folio (House, Guest, External, Booking).
  • externalFolioCode - Code for external folios, if applicable.
  • balance - Current balance of the folio.

Dependencies

  • Apaleo API access token credential

Troubleshooting

  • Ensure the API access token credential is correctly configured and valid to avoid authentication errors.
  • Check that the filter parameters are correctly formatted, especially date-time fields, to prevent request failures.
  • If no folios are returned, verify that the filter criteria are not too restrictive or conflicting.
  • Pagination parameters (page number and page size) should be set appropriately to retrieve the desired amount of data without overwhelming the API.

Links

  • Apaleo API - Folio Resource - Official documentation for the Apaleo Folio API resource, detailing available endpoints and parameters.

Discussion