Billwerk

Overview

The Billwerk node for n8n allows you to automate interactions with the Billwerk subscription management platform. Specifically, when using the Contract resource with the Get All operation, this node retrieves a list of contracts from your Billwerk account. This is useful for scenarios such as synchronizing contract data with other systems, generating reports, or monitoring contract statuses.

Practical examples:

• Fetch all contracts to update a CRM system.
• Retrieve contracts filtered by an external ID for reconciliation.
• Paginate through large sets of contracts for analytics or auditing.

Properties

Output

The node outputs an array of objects in the json field, each representing a contract retrieved from Billwerk. The structure of each object typically includes contract details such as IDs, status, customer information, and other relevant fields as provided by the Billwerk API.

Example output:

[
  {
    "id": "contract_123",
    "externalId": "ext_456",
    "status": "active",
    "customerId": "cust_789",
    // ...other contract fields
  },
  ...
]

Note: The exact fields depend on the Billwerk API response.

Dependencies

• External Service: Requires access to the Billwerk API.
• API Credentials: You must configure the billwerkApi credentials in n8n for authentication.
• n8n Configuration: No additional environment variables are required beyond standard credential setup.

Troubleshooting

Common issues:

• Invalid Credentials: If the API key or credentials are incorrect, the node will throw an authentication error. Ensure your billwerkApi credentials are valid and have sufficient permissions.
• Pagination Limits: If you set the "Take" property above 500, the API may reject the request or only return up to 500 items.
• Missing Required Fields: If required properties are missing or incorrectly formatted, the node may fail with a descriptive error message.
• Error Handling: If an error occurs during execution and "Continue On Fail" is enabled, the node will output an object with an error field containing the error message.

Example error output:

{
  "error": "Invalid API key"
}

Links and References

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