Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node integrates with the Apaleo API, specifically allowing users to update folio records using JSON Patch operations. The PATCH folio operation enables partial updates to a folio by applying a list of changes defined in JSON Patch format. This is useful for scenarios where you want to modify specific fields of a folio without replacing the entire resource, such as updating billing details, adding charges, or correcting information.

Practical examples include:

  • Adjusting the amount or description of a charge on a folio.
  • Adding or removing line items from a folio.
  • Correcting errors in folio metadata without affecting other data.

Properties

Name Meaning
Folio ID The unique identifier of the folio to be updated.
Update Operations A JSON array defining the list of patch operations to apply to the folio (JSON Patch format).

The "Update Operations" property expects a JSON Patch document, which is an array of objects each specifying an operation (add, remove, replace, etc.), a path to the field to modify, and optionally a value.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON object contains the updated folio data returned from the Apaleo API after applying the patch operations.

If the node supports binary data output, it would typically represent attachments or documents related to the folio, but based on the provided code and properties, this node focuses on JSON data only.

Dependencies

  • Requires an active connection to the Apaleo API.
  • Needs an API authentication token (access token) configured in the node credentials.
  • The base URL for API requests is https://api.apaleo.com.
  • The node depends on internal modules handling folio operations, which perform the actual API calls.

Troubleshooting

  • Invalid JSON Patch format: If the "Update Operations" JSON is malformed or does not conform to JSON Patch standards, the API will reject the request. Ensure the JSON is valid and follows the correct structure.
  • Folio ID not found: Providing an incorrect or non-existent folio ID will result in an error. Verify the folio ID before running the node.
  • Authentication errors: Missing or expired API tokens will cause authorization failures. Refresh or reconfigure the API credentials.
  • Partial update conflicts: Attempting to patch fields that are immutable or restricted may cause errors. Review the API documentation for allowed patchable fields.

Links and References

Discussion