Actions39
- Client Actions
- Client Contact Actions
- Invoice Actions
- Order Actions
- Account Actions
- Service Actions
- Domain Actions
Overview
The HostBill node for n8n allows you to interact with the HostBill API, specifically to retrieve a list of invoices using the "Get All" operation. This is useful for automating billing workflows, synchronizing invoice data with other systems, or generating reports. For example, you might use this node to fetch all unpaid invoices and trigger reminders, or to export all invoices for accounting purposes.
Properties
Name | Type | Meaning |
---|---|---|
Additional Fields | Collection | A group of optional parameters to refine the invoice query. |
└─ Page | Number | Specifies which page of results to return (for pagination). Default is 1. |
└─ Status of invoices to list | Options | Filters invoices by status: All, Paid, Unpaid, or Cancelled. Default is "All". |
Output
- The output is an array of JSON objects, each representing an invoice retrieved from the HostBill API.
- Each object contains invoice details as returned by the API. The exact structure depends on the API response but typically includes fields such as invoice ID, status, amount, client information, etc.
- If an error occurs and "Continue On Fail" is enabled, the output will include objects with an
error
field containing the error message.
Dependencies
- External Service: Requires access to a HostBill instance with API enabled.
- API Credentials: You must configure valid HostBill API credentials in n8n under the name
hostBillApi
. - n8n Configuration: No special environment variables are required beyond standard credential setup.
Troubleshooting
- Invalid Credentials: If your API credentials are incorrect or missing, the node will throw an authentication error. Double-check your HostBill API key and connection settings.
- API Errors: If the HostBill API returns an error (e.g., invalid parameters, server issues), the node will either throw an error or, if "Continue On Fail" is enabled, include the error message in the output.
- Pagination Issues: If you request a page number that does not exist, the result may be empty or an error may be returned.
- Common Error Messages:
Invalid credentials
: Check your API key and permissions.Resource not found
: Ensure the resource and operation names are correct.Parameter error
: Verify that input properties like "Page" and "Status" are set correctly.