Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Order Head → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations on various resources. Specifically, for the Order Head resource with the Post Undefined operation, it sends a POST request to create or update an order head entity in the Halo PSA system using a detailed JSON body.

Typical use cases include automating order creation or updates within a service management workflow, such as:

  • Creating new sales orders with complex line items and custom fields.
  • Updating existing orders with additional lines, delivery addresses, or external links.
  • Integrating order data from other systems into Halo PSA automatically.

For example, a user might send a fully structured order JSON containing lines, custom fields, delivery addresses, and related metadata to create an order in Halo PSA without manual entry.

Properties

Name Meaning
Body A JSON object representing the full order head data to be sent. This includes nested arrays and objects such as customfields, lines (with assets, charge rates, budgets, etc.), add_lines, _create_invoice_lines, delivery_address, originaddress, custombuttons, extratabs, external_links, and new_external_link. The structure supports detailed customization of the order including validation data, visibility conditions, access control, and database lookup triggers.

The property expects a JSON string that will be parsed and sent as the request body.

Output

The node outputs the JSON response received from the Halo PSA API after performing the POST request. The output is structured as:

{
  "json": { /* response data from Halo PSA API */ },
  "pairedItem": { "item": <index> }
}
  • The json field contains the API's response, which typically includes details about the created or updated order head.
  • If the operation fails and "Continue On Fail" is enabled, the output will contain an error message in the json.error field.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses credentials providing:
    • Base URL of the Halo PSA instance.
    • Tenant identifier.
    • Client ID and Client Secret for authentication headers.
  • The node depends on n8n's HTTP request helper to send requests.
  • No additional external dependencies beyond the Halo PSA API and n8n environment are required.

Troubleshooting

  • No credentials returned!
    Occurs if the API key credential is not configured or missing. Ensure the Halo PSA API credentials are set up correctly in n8n.

  • Resource or Operation not found
    Happens if the specified resource or operation does not exist in the node configuration. Verify that "Order Head" and "Post Undefined" are valid selections.

  • JSON parsing errors
    Since the body is expected as a JSON string, malformed JSON will cause errors. Validate the JSON syntax before running the node.

  • API request failures
    Errors from the Halo PSA API (e.g., authentication failure, invalid data) will be thrown unless "Continue On Fail" is enabled, in which case the error message will appear in the output JSON.

  • Missing path parameters
    If the endpoint URL contains placeholders (not applicable here), ensure all required parameters are provided.

Links and References

This summary is based solely on static analysis of the provided source code and input properties definition.

Discussion