Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Order Head → Get One Order Head

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific "Order Head" entity. The "Get One Order Head" operation fetches a single order's header data by its unique identifier, optionally including additional details such as consignable lines, invoiceable lines, pending purchase order lines, and more.

Typical use cases include:

  • Fetching order summary information for processing or reporting.
  • Retrieving enriched order data with related line items or statuses.
  • Integrating order data into workflows that require up-to-date order status or details.

For example, a user might use this node to get an order by its ID and include detailed line items to generate an invoice or update inventory systems.

Properties

Name Meaning
Id The unique numeric identifier of the order to retrieve.
Consignablelines Optional query parameter to include consignable lines in the response (true/false or value).
Includedetails Optional query parameter to include detailed information in the response.
Invoiceablelines Optional query parameter to include invoiceable lines in the response.
Oneline Optional query parameter to return the order as a single line summary.
Pendingpolines Optional query parameter to include pending purchase order lines in the response.

Note: The optional parameters are sent as query parameters to the API if provided.

Output

The node outputs JSON data representing the retrieved order head information. The structure corresponds directly to the API response for the requested order, potentially including nested details depending on the optional parameters used.

  • json: Contains the full order head data object returned by the Halo PSA API.
  • If errors occur during the request, the output JSON will contain an error field with the error message.

No binary data is produced by this operation.

Dependencies

  • Requires connection credentials to the Halo PSA API, including:
    • Base URL of the API.
    • Tenant identifier.
    • Client ID.
    • Client Secret.

These credentials must be configured in n8n prior to using the node.

Troubleshooting

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

  • Resource or Operation not found
    Occurs if the specified resource or operation name does not match the expected values. Verify that "Order Head" and "Get One Order Head" are selected correctly.

  • API request errors
    Network issues, invalid IDs, or permission problems may cause API request failures. The node will output an error message in the JSON response if continueOnFail is enabled; otherwise, it will throw an error.

  • Invalid ID parameter
    The "Id" property is required and must be a valid number. Providing an invalid or missing ID will result in an error.

Links and References

Discussion