Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Consignment Header → Delete Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations on various resources. Specifically, for the Consignment Header resource and the Delete Undefined operation, it sends a request to delete a consignment header identified by its ID. This operation optionally allows deleting the associated order as well.

Common scenarios where this node is useful include automating cleanup tasks in Halo PSA, such as removing obsolete or undefined consignment headers and optionally their linked orders, helping maintain data integrity and reduce clutter.

Practical example: Automatically deleting consignment headers that are no longer valid or were created erroneously, triggered by an external event or scheduled workflow.

Properties

Name Meaning
Id The numeric identifier of the consignment header to delete.
Delete Order Boolean flag indicating whether to also delete the associated order (true or false).

Output

The node outputs JSON objects representing the response from the Halo PSA API for each deletion request. Each output item corresponds to one input item and contains either:

  • The successful API response confirming deletion.
  • An error object with an error property describing the failure message if the operation failed and "Continue On Fail" is enabled.

No binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs configuration of base URL, tenant identifier, client ID, and client secret via credentials.
  • Uses HTTP requests to communicate with the Halo PSA REST endpoints.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot retrieve the required API authentication credentials. Ensure that the API key credential is properly configured and connected to the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the resource name is exactly "Consignment Header" and the operation is "Delete Undefined".

  • API request errors
    Errors returned from the Halo PSA API (e.g., invalid ID, permission denied) will be included in the output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check the error messages for details and ensure the ID exists and the API user has sufficient permissions.

  • Malformed input parameters
    Make sure the Id is a valid number and Delete Order is a boolean value.

Links and References

Discussion