Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Invoice Header → List Of Invoice Header

AI-generated

Overview

This node integrates with the Halo PSA API to list invoice headers based on various filtering and sorting criteria. It is designed to retrieve detailed or summarized information about invoices, supporting advanced search capabilities and pagination.

Common scenarios where this node is beneficial include:

  • Fetching a filtered list of invoices for reporting or auditing.
  • Retrieving invoices related to specific clients, assets, contracts, or billing categories.
  • Obtaining invoice data ready for further processing or approval workflows.
  • Paginating through large sets of invoice data efficiently.

Practical examples:

  • List all invoices awaiting approval for a particular client.
  • Retrieve invoice headers filtered by billing date range and sorted by invoice date descending.
  • Get only invoice IDs for quick reference or cross-checking.
  • Include invoice lines and credits in the response for detailed financial analysis.

Properties

Name Meaning
Advanced Search A string for advanced query filtering on invoice headers.
Asset Id Integer filter to return invoices related to a specific asset.
Awaiting Approval Boolean or flag to filter 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 related 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 invoices to return.
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 flag (meaning not explicitly described) likely to include purchase order invoices.
Invoicedateend Boolean to include the field invoicedateend in the response.
Invoicedatestart Boolean to include the field invoicedatestart in the response.
My Approvals Boolean or flag to filter invoices related to the current user's approvals.
Notpostedonly Boolean to filter invoices that have not been posted.
Order String specifying the first field name to order results by.
Order 2 String specifying the second field name to order results by.
Order 3 String specifying the third field name to order results by.
Order 4 String specifying the fourth field name to order results by.
Order 5 String specifying the fifth field name to order results by.
Orderdesc Boolean indicating ascending or descending order for the first order field.
Orderdesc 2 Boolean indicating ascending or descending order for the second order field.
Orderdesc 3 Boolean indicating ascending or descending order for the third order field.
Orderdesc 4 Boolean indicating ascending or descending order for the fourth order field.
Orderdesc 5 Boolean indicating ascending or 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 to enable or disable pagination in the response.
Paymentstatuses Array of integers (comma separated) to filter by invoice payment status.
Postedonly Boolean to filter 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 for invoices ready for invoicing.
Recurringinvoice Id Integer filter for contracts' recurring invoice ID.
Reviewrequired Boolean or flag to filter invoices requiring review.
Rinvoice Type String filter on invoice type; possible values: 'contracts', 'invoices', 'both'.
Salesorder Id Integer filter for contracts' sales order ID.
Search String filter to search invoice headers based on a search string.
Sent Status Filter based on sent status of invoices (type not explicitly defined).
Site Id Integer filter for invoices related to a specific site.
Stripeautopaymentrequired Boolean or flag related to Stripe auto payment requirement (exact meaning unclear).
Ticket Id Integer filter to return contracts assigned to a particular ticket.
Toplevel Id Filter by top-level identifier (exact meaning unclear).
User Id Integer filter for invoices related to a specific user.

Output

The node outputs an array of JSON objects representing invoice header data retrieved from the Halo PSA API. Each item corresponds to one invoice header record matching the applied filters and parameters.

  • The structure of each JSON object depends on the requested fields and options such as including invoice lines, credits, or limiting to IDs only.
  • If idonly is true, the output contains only invoice IDs.
  • Pagination parameters control how many records and which page of results are returned.
  • The output does not include binary data.

Dependencies

  • Requires connection to the Halo PSA API.
  • Needs an API authentication credential containing base URL, tenant identifier, client ID, and client secret.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • No credentials returned!
    This error occurs if the required API authentication credentials are missing or invalid. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    Indicates that the specified resource or operation name is incorrect or not supported. Verify the resource is "Invoice Header" and operation is "List Of Invoice Header".

  • API request errors
    Network issues, invalid query parameters, or server errors may cause request failures. Check the parameter values for correctness and ensure the API endpoint is reachable.

  • JSON parsing errors
    If using JSON parameters or request bodies, ensure the JSON syntax is valid.

  • Pagination issues
    When using pagination, ensure page_no and page_size are set correctly and that pageinate is enabled.

Links and References

Discussion