Carbone

Node for the Carbone API

Actions5

Overview

This n8n node provides integration with the Carbone API, enabling users to manage templates and generate reports. The node supports operations such as adding, deleting, retrieving templates, rendering reports, and downloading rendered reports. It is particularly useful for automating document generation workflows, such as creating invoices, certificates, or any templated documents based on dynamic data.

Practical examples:

Automatically generate PDF invoices from JSON data.
Upload and manage report templates in Carbone.
Download generated reports for archival or further processing.

Properties

Name	Type	Meaning
ID	String	ID of resource to Get, Edit, Delete, or add data to. Required for most operations except "Add Template".

Output

For most operations, the output contains a json field with the response data from the Carbone API.
For file-related operations (addTemplate, getTemplate, downloadReport), the output may also include a binary field:
- The binary field contains the uploaded template, downloaded template, or rendered report file, keyed by the specified "Binary Property" name.
Example output structure:

{
  "json": { /* API response data */ },
  "binary": {
    "data": { /* Binary file data (e.g., PDF, template) */ }
  }
}

Dependencies

External Service: Requires access to the Carbone API.
API Key: You must configure Carbone API credentials in n8n under the credential type carboneApi.
n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common Issues:

Missing Binary Data:
Error: No binary data exists on item!
Resolution: Ensure that the input item includes the expected binary property when uploading a template.
Invalid Binary Property Name:
Error: No binary data property "<name>" does not exists on item!
Resolution: Double-check the "Binary Property" value matches the key in your item's binary data.
Malformed JSON Input:
If the "Body" parameter for rendering a report is not valid JSON, an error will be thrown.
Resolution: Validate your JSON before submitting.
Array Field Parsing Errors:
When using "Per Field" body type, ensure that array values are valid JSON strings.
Missing or Invalid ID:
Operations like "Get", "Delete", or "Download" require a valid ID.
Resolution: Provide the correct resource/report/template ID.