Get Record

invoiceninja.get_record
ActionBusiness appsconnection required

Calls the Invoice Ninja API with the connection's credentials.

Fetch one client, invoice, payment, quote, task or expense by its id, optionally with its related records embedded.

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.

FieldTypeRequiredDefaultConstraintsExample
resource
Which Invoice Ninja entity to act on.
stringYes—one of "clients", "invoices", "payments", "quotes", "tasks", "expenses"—
record_id
The record's Invoice Ninja id, which is a hashed string and not a number.
stringYes——Opnel5aKBz
include
Comma-separated relationships to embed in the response, such as contacts.
stringNo——contacts

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "include": "contacts",
  "record_id": "Opnel5aKBz"
}

Output

One shape.

result

The provider's response object, as returned.

Extra keys beyond the ones listed can appear.

{}

See Get Record 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.