Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Prepay History → List Of Prepay History

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of prepay history records. It is designed to query and fetch detailed historical data related to prepaid billing or payments within the Halo PSA system. This functionality is useful for financial reporting, auditing prepaid transactions, or synchronizing prepay history data with other systems.

Typical use cases include:

  • Extracting filtered lists of prepay history entries based on client, contract, billing date, or other criteria.
  • Paginating through large datasets of prepay history.
  • Sorting and ordering results by various fields.
  • Using advanced search queries to refine the returned data.

For example, a user might configure this node to list all prepay history records for a specific client within a certain billing period, ordered by date descending, to generate a report or trigger follow-up actions.

Properties

Name Meaning
Advanced Search A string to perform an advanced search query filtering the prepay history records.
Billing Date Filter records by a specific billing date.
Client Id Filter records for a single client identified by their ID.
Client Ids Filter records for multiple clients specified as a string (likely comma-separated IDs).
Contract Id Filter records associated with a specific contract ID.
Count Limit the number of records returned.
Idonly Option to return only IDs instead of full record details.
Order Primary field name to order the results by.
Order 2 Secondary field name for ordering results.
Order 3 Tertiary field name for ordering results.
Order 4 Fourth-level field name for ordering results.
Order 5 Fifth-level field name for ordering results.
Orderdesc Boolean or flag indicating descending order for the primary order field.
Orderdesc 2 Descending order flag for the secondary order field.
Orderdesc 3 Descending order flag for the tertiary order field.
Orderdesc 4 Descending order flag for the fourth order field.
Orderdesc 5 Descending order flag for the fifth order field.
Page No The page number to retrieve in paginated results.
Page Size Number of records per page in paginated results.
Pageinate Flag or parameter controlling pagination behavior.
Ready For Invoicing Filter records that are marked as ready for invoicing.
Search A general search string to filter prepay history records.

Output

The node outputs JSON data containing the list of prepay history records retrieved from the Halo PSA API. Each item in the output corresponds to one prepay history entry, including all fields returned by the API according to the applied filters and parameters.

If the "Idonly" property is used, the output may contain only the IDs of the records rather than full details.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials providing base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests to communicate with the Halo PSA API endpoints.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • No credentials returned!: Ensure that the API credentials are correctly configured and available in n8n.
  • Resource or Operation not found: Verify that the resource "Prepay History" and operation "List Of Prepay History" are correctly selected.
  • API request errors: Network issues, invalid parameters, or authentication failures can cause errors. Check the error message for details.
  • Invalid JSON in parameters: If using JSON parameters (e.g., in advanced search), ensure the JSON syntax is correct.
  • Pagination issues: Incorrect page number or size may result in empty responses; verify these values.
  • To handle errors gracefully, enable "Continue On Fail" in the node settings to allow processing of subsequent items even if some fail.

Links and References

Discussion