Actions39
- Account Actions
- Client Actions
- Document Actions
- Product Actions
- Receipt Actions
- Store Actions
- Supplier Actions
Document → Get Document by ID
AI-generatedOverview
This node integrates with the Vendus API, a platform for invoicing and business management. Specifically, the "Get Document by ID" operation under the "Document" resource allows users to retrieve detailed information about a specific document (such as an invoice, receipt, or credit note) by providing its unique identifier.
Common scenarios where this node is beneficial include:
- Fetching invoice details for review or processing in automated workflows.
- Retrieving receipts or credit notes for accounting reconciliation.
- Accessing document metadata to trigger further actions like notifications or data exports.
For example, a user might automate the retrieval of an invoice by its ID after a sale is completed, then use the returned data to update their CRM or send a confirmation email.
Properties
| Name | Meaning |
|---|---|
| Document Name or ID | The unique identifier or name of the document to retrieve. Can be selected from a list or specified via an expression. Required. |
| Options | Additional optional settings: |
| Enable Debug Logging | When enabled, provides detailed debug logs for troubleshooting API calls. Defaults to false. |
Output
The node outputs a JSON object representing the full details of the requested document as returned by the Vendus API. This includes all available fields such as document type, client info, amounts, dates, and line items depending on the document.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"id": "12345",
"type": "FT",
"client": {
"id": "6789",
"name": "Client Name"
},
"date": "2024-01-01",
"total": 150.00,
"items": [
{
"id": "1",
"description": "Product A",
"quantity": 2,
"unit_price": 50.00
}
],
...
}
Dependencies
- Requires an API key credential configured in n8n to authenticate with the Vendus API.
- The node uses the base URL provided in the credentials to make HTTP requests.
- Optional debug logging depends on the node's internal logger.
Troubleshooting
- Missing or invalid Document ID: If the "Document Name or ID" property is empty or incorrect, the node will throw an error indicating the parameter is required or that the document was not found.
- API authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
- Network or connectivity issues: Check network access to the Vendus API endpoint.
- Debug logging: Enable the "Enable Debug Logging" option to get detailed logs which can help identify request formatting or response issues.
- No routing configuration error: This indicates an internal misconfiguration if the node cannot find the API route for the given resource-operation pair.
Links and References
- Vendus API Documentation (as referenced in the node description)
- n8n Expressions Documentation - for using expressions in input properties