Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Invoice Payment → Get One Invoice Payment

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a single invoice payment. Specifically, the "Get One Invoice Payment" operation fetches data for an invoice payment identified by its unique ID. This is useful in scenarios where you need to verify payment details, audit transactions, or synchronize payment data from Halo PSA into other systems.

Practical examples:

  • Fetching payment details to confirm receipt before proceeding with order fulfillment.
  • Retrieving payment metadata for reporting or reconciliation purposes.
  • Integrating payment status checks into automated workflows.

Properties

Name Meaning
Id The unique numeric identifier of the invoice payment to retrieve.
Includedetails Optional flag to include additional related details in the response (e.g., line items).

Output

The node outputs a JSON object representing the invoice payment retrieved from the Halo PSA API. This includes all standard fields provided by the API for that payment, such as amount, date, payer information, and potentially extended details if requested.

If the Includedetails property is set, the output may contain nested objects or arrays with more granular information related to the payment.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API are required.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent invoice payment ID will result in an error from the API.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "No credentials returned!": Indicates that the node could not find or access the required API credentials. Ensure credentials are configured correctly.
    • "Resource Invoice Payment not found" or "Operation Get One Invoice Payment not found for resource Invoice Payment": Suggests misconfiguration of resource or operation parameters.
    • API errors returned from Halo PSA (e.g., 404 Not Found) typically mean the specified payment ID does not exist.

  • Resolution tips:

    • Double-check the API credentials and their permissions.
    • Verify the invoice payment ID exists in Halo PSA.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch processing.

Links and References

Discussion