Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Order Head → List Of Order Head

AI-generated

Overview

This node integrates with the Halo PSA API to list order head records based on various filtering and sorting criteria. It is useful for retrieving summarized order information from a PSA (Professional Services Automation) system, enabling workflows that require order data extraction, reporting, or further processing.

Typical use cases include:

  • Fetching orders filtered by client, billing date, status, or other attributes.
  • Paginating through large sets of orders.
  • Sorting orders by multiple fields in ascending or descending order.
  • Searching orders using advanced search queries.

For example, you could use this node to get all open orders for a specific client within a date range, or to retrieve a paginated list of orders ready for invoicing.

Properties

Name Meaning
Advanced Search A string query for advanced filtering of orders.
Billing Date Filter orders by their billing date.
Client Id Filter orders by a single client identifier.
Client Ids Filter orders by multiple client identifiers (comma-separated).
Closed Filter orders by closed status (true/false).
Count Limit the number of orders returned.
Idonly Return only order IDs instead of full order details.
Needsconsigning Filter orders that need consignment.
Needsinvoicing Filter orders that need invoicing.
Needsordering Filter orders that need ordering.
Open Filter orders by open status (true/false).
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 flag to indicate descending order for primary sort field.
Orderdesc 2 Boolean flag to indicate descending order for secondary sort field.
Orderdesc 3 Boolean flag to indicate descending order for tertiary sort field.
Orderdesc 4 Boolean flag to indicate descending order for fourth-level sort field.
Orderdesc 5 Boolean flag to indicate descending order for fifth-level sort field.
Page No The page number to retrieve (for pagination).
Page Size Number of orders per page (for pagination).
Pageinate Enable or disable pagination (boolean).
Quote Status Filter orders by quote status (string).
Ready For Invoicing Filter orders that are ready for invoicing (boolean).
Search General search string to filter orders.
Site Id Filter orders by site identifier.
Ticket Id Filter orders by associated ticket identifier.
Toplevel Id Filter orders by top-level identifier.
User Id Filter orders by user identifier.

Output

The node outputs an array of JSON objects representing the order head records retrieved from the Halo PSA API. Each item corresponds to one order head entry with its properties as returned by the API.

If the idonly property is set, the output will contain only the order IDs instead of full order details.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to the Halo PSA API.
  • Requires an API key credential with tenant, client ID, and client secret for authentication.
  • The base URL of the Halo PSA API must be configured in the credentials.
  • The node uses HTTP requests with appropriate headers for authentication.

Troubleshooting

  • No credentials returned!: Ensure that valid API credentials are configured and selected in the node.
  • Resource or Operation not found: Verify that the resource is set to "Order Head" and operation to "List Of Order Head".
  • API request errors: Check network connectivity and API permissions. Review error messages returned in the output JSON under the error field if "Continue On Fail" is enabled.
  • Invalid query parameters: Make sure input properties conform to expected types and formats (e.g., dates, booleans).
  • Pagination issues: If no results appear, verify that page_no, page_size, and pageinate are set correctly.

Links and References

Discussion