Actions27
- Public Administration Actions
- Public Actions
- Public Transactions Actions
- Get Indexes Account
- Post Indexes Account
- Get Indexes Categories
- Post Indexes Categories
- Get Indexes Customer
- Post Indexes Customer
- Get Invoices
- Patch Invoices
- Get Orders
- Post Orders
- Get Payments
- Patch Payments
- Get Indexes Status
- Post Indexes Status
- Get Indexes Tax Rate
- Post Indexes Tax Rate
- Get Indexes Vendor
- Post Indexes Vendor
Overview
This node allows users to update metadata of a document in the "Public" resource of the Dokka API by patching specific fields. It is useful when you want to modify attributes such as tags, notes, note colors, or category of an existing document without replacing the entire document data.
Common scenarios include:
- Adding or updating tags on a document for better categorization.
- Changing the notes or annotations associated with a document.
- Updating the color coding of notes to reflect priority or status.
- Moving documents between categories like Inbox, Working, Done, or Archive.
For example, you might use this node to add a new tag to a document and change its category from "Inbox" to "Working" as part of a workflow that processes incoming documents.
Properties
| Name | Meaning |
|---|---|
| Document Id | The unique identifier of the document to update (required). |
| Company ID | The company identifier within Dokka (required). |
| X Fields | Optional header to specify a fields mask, controlling which fields are returned or affected. |
| Tags | A JSON array or single tag to assign to the document. |
| Notes | Text notes or comments about the document. |
| Notes Color | Color of the notes; options: Yellow, Green, Light Pink, Dark Pink, Orange. |
| Category Id | Category to assign the document to; options: Inbox, Working, Done, Archive. |
Output
The node outputs the response from the Dokka API after patching the document metadata. The json output field contains the updated document metadata reflecting the changes made. This typically includes the document's ID, updated tags, notes, note color, category, and any other relevant metadata fields returned by the API.
No binary data output is indicated for this operation.
Dependencies
- Requires an active connection to the Dokka API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The base URL for the Dokka API must be set in the node credentials.
- The node uses HTTP PATCH requests with JSON payloads to update document metadata.
Troubleshooting
- Missing Required Fields: Ensure that both "Document Id" and "Company ID" are provided; otherwise, the API will reject the request.
- Invalid Tags Format: The "Tags" property expects valid JSON; malformed JSON will cause errors.
- Unauthorized Access: If the API key or token is invalid or missing, the node will fail with authentication errors.
- Invalid Category or Note Color: Using values outside the predefined options may result in API validation errors.
- Network Issues: Connectivity problems to the Dokka API endpoint will cause request failures.
To resolve these issues:
- Double-check required inputs and their formats.
- Verify API credentials and permissions.
- Use only allowed option values for enumerated properties.
- Confirm network connectivity and API availability.
Links and References
- Dokka API Documentation (for Public resource and document metadata patching) — consult your Dokka API docs for detailed field descriptions and examples.
- n8n HTTP Request Node documentation (for understanding PATCH requests and routing).