Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Header → Delete Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations on various resources, including "Contract Header". Specifically, for the "Delete Undefined" operation on the "Contract Header" resource, it deletes a contract header identified by its unique ID. This is useful in scenarios where you need to programmatically remove obsolete or incorrect contract headers from your system.

Practical examples include:

  • Automating cleanup of contract headers that are no longer valid.
  • Integrating contract management workflows where contracts are deleted based on external triggers or conditions.
  • Maintaining data integrity by removing undefined or placeholder contract headers.

Properties

Name Meaning
Id The unique identifier (number) of the contract header to delete. This property is required.

Output

The node outputs JSON data representing the response from the Halo PSA API after attempting to delete the specified contract header. The output JSON typically contains confirmation of deletion or error details if the operation failed.

If the operation encounters an error and the node is configured to continue on failure, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of the following credentials parameters:
    • Base URL of the Halo PSA API.
    • Tenant identifier.
    • Client ID.
    • Client Secret.

These must be set up in n8n's credential manager before using the node.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause the node to throw an error "No credentials returned!".
    • Providing an invalid or non-existent contract header ID may result in an API error indicating the resource was not found.
    • Network connectivity issues can cause request failures.

  • Error messages:

    • "Resource Contract Header not found": Indicates the resource name is incorrect or unsupported.
    • "Operation Delete Undefined not found for resource Contract Header": Indicates the operation name is incorrect or unsupported.
    • API errors returned from the Halo PSA service will be included in the output JSON under the error field if "Continue On Fail" is enabled.

  • Resolution tips:

    • Verify that the correct resource and operation names are used.
    • Ensure the contract header ID exists and is valid.
    • Confirm that credentials are correctly configured and have necessary permissions.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion