Actions66
- Block Actions
- Block Action Actions
- Booking Actions
- Group Actions
- Offer Actions
- Payment Account Actions
- Payment Account Action Actions
- Reservation Actions
- Reservation Action Actions
- Types Actions
- Folio Actions
- Folio Action Actions
Folio → GET folio
AI-generatedOverview
This node interacts with the Apaleo API to retrieve details of a specific folio by its ID. It is useful in scenarios where you need to fetch financial or billing information related to a booking or reservation in the Apaleo system. For example, it can be used to get the folio details for generating invoices or reviewing charges associated with a guest's stay.
Use Case Examples
- Retrieve folio details by providing the folio ID to integrate billing information into a hotel management workflow.
- Fetch folio data to display financial summaries in a custom dashboard for hotel staff.
Properties
| Name | Meaning |
|---|---|
| Folio ID | The ID of the folio to retrieve. This is a required string input used to specify which folio's details to fetch from the Apaleo API. |
Output
JSON
id- The unique identifier of the folio.status- The current status of the folio.totalAmount- The total amount charged in the folio.currency- The currency used in the folio.items- An array of line items or charges included in the folio.
Dependencies
- Requires an API key credential for Apaleo API access, specifically an access token for authentication.
Troubleshooting
- Ensure the Folio ID provided is valid and exists in the Apaleo system to avoid 'not found' errors.
- Check that the API credentials (access token) are correctly configured and have the necessary permissions to access folio data.
- If the node fails, verify network connectivity to the Apaleo API endpoint and that the base URL is correct.
Links
- Apaleo API Folio Documentation - Official documentation for the Apaleo API folio endpoints, detailing how to retrieve folio information.