Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Invoice Header → Delete One Invoice Header

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations on various resources. Specifically, for the Invoice Header resource, it supports deleting a single invoice header by its ID. This operation is useful in scenarios where an invoice needs to be removed from the system, such as correcting billing errors or cleaning up test data.

Practical examples include:

  • Automatically deleting outdated or canceled invoices during a cleanup workflow.
  • Removing invoices that were created erroneously before generating new ones.
  • Integrating with other systems to synchronize invoice deletions.

Properties

Name Meaning
Id The unique numeric identifier of the invoice header to delete.
Bypass Accounts Sync Optional flag to bypass account synchronization when deleting the invoice header.

Output

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

No binary data output is produced by this operation.

Example output JSON might look like:

{
  "success": true,
  "message": "Invoice header deleted successfully"
}

or in case of failure:

{
  "error": "Invoice header not found"
}

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate API requests.
  • No additional external dependencies are required beyond the configured API access.

Troubleshooting

  • Common Issues:

    • Missing or invalid credentials will cause the node to throw an error indicating no credentials were returned.
    • Providing an invalid or non-existent invoice header ID will result in an API error, typically indicating the resource was not found.
    • Network connectivity issues can cause request failures.

  • Error Messages:

    • "No credentials returned!": Ensure that the API credentials are correctly configured and available.
    • "Resource Invoice Header not found" or "Operation Delete One Invoice Header not found": Verify that the resource and operation names are correct.
    • API error messages returned in the JSON output under the error field should be reviewed to understand specific issues (e.g., permission denied, invalid ID).

  • Resolution Tips:

    • Double-check the invoice header ID exists before attempting deletion.
    • Confirm API credentials have sufficient permissions to delete invoice headers.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully within workflows.

Links and References

Discussion