Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Recurring Invoice Header → Delete One Invoice Header

AI-generated

Overview

This node integrates with the Halo PSA API to manage recurring invoice headers, specifically allowing users to delete a single recurring invoice header by its ID. It is useful in scenarios where automated cleanup or management of recurring invoices is needed, such as removing outdated or incorrect invoice templates from the system.

For example, a finance team could use this node in an automation workflow to delete a recurring invoice header when a contract ends or a client relationship is terminated, ensuring that no further invoices are generated for that client.

Properties

Name Meaning
Id The unique identifier (number) of the recurring invoice header to delete.
Bypass Accounts Sync Optional query parameter to bypass synchronization with accounts during deletion.

Output

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

No binary data output is produced by this node.

Example output JSON structure might look like:

{
  "success": true,
  "message": "Recurring invoice header deleted successfully."
}

or in case of failure:

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

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of the base URL, tenant identifier, client ID, and client secret for the Halo PSA service.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • Common Issues:

    • Invalid or missing Id property will cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity issues can prevent communication with the Halo PSA API.

  • Error Messages:

    • "No credentials returned!": Indicates that the required API authentication credentials were not provided or could not be retrieved. Ensure credentials are configured correctly in n8n.
    • "Resource Recurring Invoice Header not found" or "Operation Delete One Invoice Header not found for resource Recurring Invoice Header": Suggests a misconfiguration in the node parameters; verify that the correct resource and operation are selected.
    • API error responses included in the output JSON under the error field should be reviewed to understand specific failures (e.g., invalid ID, permission denied).

  • Resolution Tips:

    • Double-check the Id value to ensure it corresponds to an existing recurring invoice header.
    • Verify API credentials and permissions.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully within workflows.

Links and References

Discussion