Invoice Action
invoiceninja.invoice_action
ActionBusiness appsconnection required
Calls the Invoice Ninja API with the connection's credentials.
Run one action over a list of invoices — mark them sent or paid, email them, cancel, archive, restore or delete them, or clone them to quotes.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Invoice Ninja
- Secret shape
- the API token, or {"api_token": "…", "api_secret": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
action What to do to each invoice in the list. | string | Yes | — | one of "mark_sent", "mark_paid", "email", "send_email", "cancel", "archive", "restore", "delete", "auto_bill", "clone_to_invoice", "clone_to_quote", "download", "bulk_download", "bulk_print" | — |
ids The invoices to act on, as a list of their Invoice Ninja ids. | array | Yes | — | ≥ 1 characters; array of string | ["D2J234DFA"] |
email_type Which template the send_email action uses; ignored by every other action. | string | No | — | one of "invoice", "quote", "credit", "payment", "payment_partial", "statement", "reminder1", "reminder2", "reminder3", "reminder_endless", "custom1", "custom2", "custom3", "purchase_order" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"ids": [
"D2J234DFA"
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
action The action that was run. | string | — |
requested How many invoice ids were sent. | number | — |
data The invoices Invoice Ninja returned after the action. | array | — |
count How many invoices came back. | number | — |
{
"action": "",
"count": 0,
"data": [],
"requested": 0
}Related Invoice Ninja nodes
See Invoice Action run in a workflow.
In a technical demo we add the Invoice Ninja connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.