Billwerk

Overview

The Billwerk node for n8n automates interactions with the Billwerk subscription management platform. Specifically, when using the Metered Usage resource and the Delete operation, this node allows users to delete a specific metered usage record associated with a contract. This is useful in scenarios where incorrect or obsolete usage data needs to be removed from a customer's billing history.

Practical Example:
Suppose you have mistakenly logged an extra usage event for a customer’s contract. Using this node, you can automate the removal of that erroneous usage entry by specifying the relevant Contract ID and Usage ID.

Properties

Output

• The output will be a JSON object reflecting the result of the deletion operation.
• If successful, it typically returns confirmation details about the deleted usage record.
• If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

[
  {
    "success": true,
    "message": "Metered usage deleted successfully.",
    "usageId": "12345"
  }
]

Or, on error (with Continue On Fail):

[
  {
    "error": "Usage ID not found."
  }
]

Dependencies

• External Service: Requires access to the Billwerk API.
• Credentials: You must configure the billwerkApi credential in n8n with appropriate API keys or authentication details.

Troubleshooting

• Common Issues:

  • Invalid Contract ID or Usage ID: If either ID is incorrect or does not exist, the node will return an error.
  • Missing Credentials: If the billwerkApi credential is not set up, the node will fail to authenticate.
  • Insufficient Permissions: The API key used may lack permission to delete metered usage records.

• Error Messages:

  • "Usage ID not found." – Ensure the Usage ID exists and is correct.
  • "Contract ID not found." – Verify the Contract ID is valid.
  • "Authentication failed." – Check your Billwerk API credentials in n8n.

Links and References

• Billwerk API Documentation
• n8n Documentation: Creating Credentials
• n8n Documentation: Error Handling