Package Information
Documentation
n8n-nodes-artsoft-cloud
n8n community node for ARTSOFT Cloud Invoice (by ARTSOFT Business Software). It lets workflows list, read, create, update and delete customers, suppliers, products, salespersons, documents, document lines and current account entries through the ARTSOFT Cloud Invoice REST API.
- Installation
- Prerequisites
- Credentials
- Operations
- Example workflow
- Response format
- Compatibility and limitations
- Resources
- Version history
Installation
Follow the n8n community nodes installation guide and install the package n8n-nodes-artsoft-cloud.
For a self-hosted instance you can also install it from the command line in your n8n user folder:
npm install n8n-nodes-artsoft-cloud
Prerequisites
- An ARTSOFT Cloud Invoice subscription. Your tax ID (NIF) identifies your instance (
https://{nif}.artsoft.cloud). - An ARTSOFT Cloud Invoice API key.
Credentials
Create an ARTSOFT Cloud Invoice API credential with:
| Field | Description |
|---|---|
| NIF | Tax ID of your ARTSOFT Cloud Invoice instance, used to build the URL, e.g. 123456789 |
| API Key | API key, sent in the x-api-key header |
| Development | Use the development environment instead of production. Leave off unless you work against a local ARTSOFT Cloud Invoice |
Generated base URLs:
| Environment | URL |
|---|---|
| Production | https://{nif}.artsoft.cloud/api |
| Development | https://{nif}.local.artsoft.cloud:3000/api (local use only; TLS certificate validation is skipped in this mode, so local CAs such as mkcert work without extra setup) |
The credential test calls GET /customers/?$size=1, so it also requires read access to customers.
Operations
| Resource | Operations |
|---|---|
| Customer | List, Get, Create, Update, Delete |
| Supplier | List, Get, Create, Update, Delete |
| Product | List, Get, Create, Update, Delete |
| Salesperson | List, Get, Create, Update, Delete |
| Document | List Invoices, List Invoices by SAFT Type, List Purchases, List Purchases by SAFT Type, Get, Create Header, Update, Delete |
| Document Line | List, Get, Create, Update, Delete |
| Current Account | List Customers, List Suppliers, Get, Create Debit, Create Credit, Update, Delete |
List operations accept the API paging and filtering parameters: $search, $filter, $sort, $direction, $size, $cursor and $navigate.
Detailed field reference per module (currently in Portuguese): docs/modules/.
Example workflow
Create a customer and then a document header for it:
- ARTSOFT node: Customer → Create, with the customer data. The response contains the new customer.
- ARTSOFT node: Document → Create Header, using an expression to pass the customer ID from step 1.
- ARTSOFT node: Document Line → Create, to add lines to the document.
Enable Continue On Fail on any step if you want the workflow to keep going when the API rejects an item.
Response format
The node returns the JSON answer of the ARTSOFT Cloud Invoice API as the item json. It sends one request per input item.
When the API answers with an error, the item fails with a NodeApiError that includes the API error code and message (or it is returned as an error item when Continue On Fail is on).
Compatibility and limitations
- Requires an n8n version that supports community nodes with
n8nNodesApiVersion1. - The node is usable as an AI agent tool (
usableAsTool). - The UI labels are in English. Some field descriptions mirror ARTSOFT terminology (for example Third Party, SAFT, MB References).
- Parameter names and option values are kept stable between versions, so saved workflows keep working. Labels may change.
Resources
Version history
See CHANGELOG.md.