Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node integrates with the Apaleo API to add a no-show fee to a specific folio. It is useful in hospitality or property management scenarios where guests who fail to show up for their booking are charged a penalty fee. By automating this process, businesses can ensure consistent application of no-show fees and streamline financial operations related to guest folios.

Practical examples:

  • Automatically charging a no-show fee when a guest does not arrive by the check-in time.
  • Adding penalties to folios for missed reservations without manual intervention.

Properties

Name Meaning
Folio ID The unique identifier of the folio to which the no-show fee will be added (required).
Amount The monetary amount of the no-show fee to be applied (required).
Currency The currency code (e.g., USD, EUR) for the no-show fee amount (required).
Idempotency Key An optional unique key to safely retry requests without creating duplicate charges.

Output

The node outputs an array of JSON objects representing the result of adding the no-show fee to the specified folio. Each output item corresponds to one input item processed.

  • The json field contains details about the operation's success, including confirmation of the fee addition and any relevant metadata returned by the Apaleo API.
  • This node does not output binary data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Folio ID: Ensure the Folio ID provided exists and is correctly formatted.
    • Insufficient permissions: Verify that the API token has rights to modify folios.
    • Currency mismatch or unsupported currency codes may cause errors.
    • Duplicate requests without idempotency keys might create multiple fees.
  • Error messages:

    • Errors from the API such as "Unauthorized" indicate credential problems; recheck API token validity.
    • "Folio not found" suggests the Folio ID does not exist or is inaccessible.
    • Validation errors on amount or currency require checking input values.
  • To resolve errors, verify all required properties, confirm API credentials, and optionally use the idempotency key to prevent duplicate charges on retries.

Links and References

Discussion