Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Prepay History → Get One Prepay History

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific Prepay History record. It is designed to fetch one particular prepay history entry by its unique identifier, optionally including additional details.

Common scenarios for this node include:

  • Retrieving financial or transaction history related to prepaid services in a PSA (Professional Services Automation) system.
  • Automating reporting or auditing workflows that require fetching historical prepayment data.
  • Integrating prepay history data into other systems or dashboards for analysis.

For example, a user might use this node to get the prepay history of a client by specifying the record ID and decide whether to include extended details about the transaction.

Properties

Name Meaning
Id The unique numeric identifier of the Prepay History record to retrieve.
Includedetails Optional flag to specify if additional detailed information should be included in output.

Output

The node outputs a JSON object representing the requested Prepay History record. This includes all standard fields returned by the Halo PSA API for that record. If the Includedetails property is set, the output will contain extended details related to the prepay history entry.

The output structure corresponds directly to the API response for a single Prepay History item, typically including fields such as transaction date, amount, status, and any associated metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API via an API key credential.
  • The node expects configuration of credentials containing the base URL, tenant identifier, client ID, and client secret for authentication.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • Missing Credentials: The node will throw an error if no valid API credentials are provided. Ensure that the API key credential is configured correctly in n8n.
  • Invalid Id: Providing an invalid or non-existent Id may result in an API error or empty response. Verify the ID before execution.
  • API Errors: Network issues or incorrect tenant/client credentials can cause request failures. Check connectivity and credential validity.
  • JSON Parsing Issues: If additional query parameters or JSON bodies are malformed, the node may fail. Use valid JSON syntax when providing such inputs.
  • Continue On Fail: If enabled, the node will return error messages in the output JSON instead of stopping execution, useful for batch processing.

Links and References

Discussion