Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Invoice Payment → List Of Invoice Payment

AI-generated

Overview

This node integrates with the Halo PSA API to list invoice payments. It allows users to retrieve a filtered and paginated list of payments made against invoices, supporting various query parameters for refined searches and ordering.

Common scenarios include:

  • Fetching all payments related to a specific client or invoice.
  • Retrieving payments with pagination to handle large datasets.
  • Sorting payments by different fields using multiple order parameters.
  • Searching payments based on keywords or identifiers.

Practical example:

  • A finance team wants to generate a report of all payments received for a particular invoice or client within a date range, sorted by payment date descending, and paginated to process in batches.

Properties

Name Meaning
Client Id Filter payments by the client's unique identifier.
Count Limit the number of payments returned in the response.
Intent Id Filter payments by a specific intent identifier (string).
Invoice Id Filter payments associated with a specific invoice.
Order Primary field to sort the results by (string).
Order 2 Secondary field to sort the results by (string).
Order 3 Tertiary field to sort the results by (string).
Order 4 Fourth-level field to sort the results by (string).
Order 5 Fifth-level field to sort the results by (string).
Orderdesc Boolean or flag indicating if the primary order should be descending (nullable).
Orderdesc 2 Descending flag for the secondary order (nullable).
Orderdesc 3 Descending flag for the tertiary order (nullable).
Orderdesc 4 Descending flag for the fourth-level order (nullable).
Orderdesc 5 Descending flag for the fifth-level order (nullable).
Page No The page number to retrieve for paginated results.
Page Size Number of items per page in the paginated response.
Pageinate Flag or parameter controlling pagination behavior (exact meaning depends on API).
Search Text string to search/filter payments by keyword or other searchable fields.

Output

The node outputs an array of JSON objects representing invoice payments matching the specified filters and pagination. Each item in the output corresponds to one payment record as returned by the Halo PSA API.

The json output field contains the full payment data structure from the API response, which typically includes details such as payment amount, date, client info, invoice reference, and status.

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 credentials providing base URL, tenant ID, client ID, and client secret for authentication.
  • Network access to the Halo PSA API endpoint must be configured in n8n environment.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API credentials. Ensure that the required API authentication token and related settings are correctly set up in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that "Invoice Payment" and "List Of Invoice Payment" are correctly selected.

  • Invalid query parameters
    Passing unsupported or incorrectly typed parameters may cause API errors. Double-check property values, especially for pagination and ordering fields.

  • API request failures
    Network issues, invalid credentials, or API rate limits can cause request errors. Review error messages for hints and ensure connectivity and valid credentials.

  • JSON parsing errors
    If using advanced JSON parameters, ensure they are well-formed JSON strings.

Links and References

Discussion