Actions6
- Collection Actions
- Bill Actions
Overview
This node integrates with the Billplz payment gateway API to manage collections and bills. Specifically, for the "Create a Collection" operation under the "Collection" resource, it allows users to create a new collection by specifying a title. Collections serve as containers or groups for bills, and the created collection's ID is essential for creating bills within that collection.
Common scenarios where this node is beneficial include:
- Organizing multiple payment requests under a single collection for easier management.
- Automating the creation of collections before generating bills for customers.
- Integrating payment collection workflows into automated processes.
For example, a business could use this node to programmatically create a collection named "January Invoices" and then generate individual bills linked to this collection for each customer.
Properties
| Name | Meaning |
|---|---|
| Title | The collection title. This string will be displayed on the bill template. |
Output
The output is a JSON array containing the response from the Billplz API after creating the collection. This response includes details such as the collection ID, split rule information, and other metadata related to the newly created collection. This collection ID is crucial for subsequent operations like creating bills within this collection.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Billplz API.
- The node makes HTTP requests to
https://www.billplz.com/api/v3/collections. - Proper configuration of the API credentials (username and password) in n8n is necessary.
- Network access to the Billplz API endpoint must be available.
Troubleshooting
- Authentication errors: If the API credentials are incorrect or missing, the node will fail to authenticate. Ensure the API key credential is correctly set up.
- Invalid input: The "Title" property is required. Omitting it or providing an empty string may cause the API to reject the request.
- API rate limits or downtime: Temporary failures might occur if the Billplz service is down or rate limits are exceeded. Retry after some time or check the service status.
- Unexpected API responses: If the API changes or returns unexpected data, the node might not handle it properly. Verify the API documentation and update the node accordingly.