Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Recurring Invoice Header → List Of Invoice Header

AI-generated

Overview

This node interacts with the "Recurring Invoice Header" resource of the Halo PSA API to retrieve a list of invoice headers based on various filtering and sorting criteria. It is designed to fetch detailed or summarized information about recurring invoices, which can be useful for financial reporting, auditing, or integration with other business systems.

Typical use cases include:

  • Retrieving all recurring invoice headers for a specific client or asset.
  • Filtering invoices by billing date, approval status, or payment status.
  • Paginating through large sets of invoice headers.
  • Including or excluding invoice lines, credits, or posted/unposted invoices.
  • Sorting the results by multiple fields in ascending or descending order.

For example, a user might want to list all invoices awaiting approval for a particular client within a certain billing period, or fetch only the invoice IDs for quick reference.

Properties

Name Meaning
Advanced Search A string query for advanced filtering of invoice headers.
Asset Id Integer filter to return invoices related to a specific asset.
Awaiting Approval Boolean filter to include only invoices that are awaiting approval.
Billing Date String filter on the billing date of invoices.
Billingcategory Ids Comma-separated string of billing category IDs to filter invoices.
Client Id Integer filter for invoices belonging to a specific client.
Client Ids Comma-separated string of client IDs to filter invoices.
Contract Id Integer filter for invoices related to a specific contract.
Count Integer specifying the number of contracts to return in the response.
Idonly Boolean to include only the invoice ID in the response.
Includecredits Boolean to include invoice type credits in the response.
Includeinvoices Boolean to include invoice type invoices in the response.
Includelines Boolean to include invoice lines in the response.
Includepoinvoices Boolean filter (meaning not explicitly described).
Invoicedateend Boolean to include the field invoicedateend in the response.
Invoicedatestart Boolean to include the field invoicedatestart in the response.
My Approvals Boolean filter (meaning not explicitly described).
Notpostedonly Boolean filter to include only invoices that have not been posted.
Order String specifying the first field to order by.
Order 2 String specifying the second field to order by.
Order 3 String specifying the third field to order by.
Order 4 String specifying the fourth field to order by.
Order 5 String specifying the fifth field to order by.
Orderdesc Boolean indicating ascending (false) or descending (true) order for the first order field.
Orderdesc 2 Boolean indicating ascending/descending order for the second order field.
Orderdesc 3 Boolean indicating ascending/descending order for the third order field.
Orderdesc 4 Boolean indicating ascending/descending order for the fourth order field.
Orderdesc 5 Boolean indicating ascending/descending order for the fifth order field.
Page No Integer specifying the page number when using pagination.
Page Size Integer specifying the size of each page when using pagination.
Pageinate Boolean indicating whether to use pagination in the response.
Paymentstatuses Array of integers (comma separated) to filter on invoice payment statuses.
Postedonly Boolean filter to include only invoices that have been posted.
Purchaseorder Id Integer filter for invoices related to a specific purchase order.
Quote Status Comma-separated string to filter by quote statuses.
Ready For Invoicing Boolean filter to include invoices ready for invoicing.
Recurringinvoice Id Integer filter by contract's recurring invoice ID.
Reviewrequired Boolean filter (meaning not explicitly described).
Rinvoice Type String filter on invoice type; possible values: 'contracts', 'invoices', 'both'.
Salesorder Id Integer filter by contract's sales order ID.
Search String filter to search invoice headers based on a search string.
Sent Status Boolean filter (meaning not explicitly described).
Site Id Integer filter by site.
Stripeautopaymentrequired Boolean filter (meaning not explicitly described).
Ticket Id Integer filter to return contracts assigned to a particular ticket.
Toplevel Id Integer filter (meaning not explicitly described).
User Id Integer filter by user.

Output

The node outputs an array of JSON objects representing the recurring invoice headers retrieved from the API. Each item corresponds to one invoice header and contains all fields returned by the API according to the filters and options set.

If the idonly property is set, the output will contain only the invoice IDs.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant identifier, client ID, and client secret from the credentials to authenticate requests.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API authentication credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation is invalid or misspelled, the node will throw an error. Verify that "Recurring Invoice Header" and "List Of Invoice Header" are correctly selected.

  • Invalid filter values
    Passing incorrect types (e.g., strings instead of integers) for filters like client_id or asset_id may cause API errors. Validate input types before execution.

  • Pagination issues
    When using pagination properties (page_no, page_size, pageinate), ensure that values are consistent and valid to avoid empty or incomplete responses.

  • API request failures
    Network issues, invalid credentials, or API limits may cause request failures. Check the error message returned in the node output for details.

Links and References

Discussion