Book a demo

Run Report

erpnext.run_report
ActionCRM & salesconnection required

Calls the ERPNext API with the connection's credentials.

Run a saved ERPNext report by name and return its columns and rows.

Ask about ERPNextAll ERPNext nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
ERPNext
Secret shape
{"api_key": "…", "api_secret": "…"}
Config it needs
base_url, doctype
Resolved by
config.connection_id, else node.connection_id

Configuration

3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
report_name
The report's name as it appears in ERPNext.
stringYes——Accounts Receivable
filters
The report's own filters as an object, e.g. {"company": "Acme Ltd", "report_date": "2026-01-31"}.
objectNo——{"company":"Acme Ltd","report_date":"2026-01-31"}
ignore_prepared_report
Run the report now instead of returning the last background-prepared result. Slower, but never stale.
booleanNofalse——

Example configuration

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

{
  "filters": {
    "company": "Acme Ltd",
    "report_date": "2026-01-31"
  },
  "ignore_prepared_report": false,
  "report_name": "Accounts Receivable"
}

Output

One shape.

result

FieldTypeExample
report_name
The report that was run.
string—
columns
The report's column definitions, in order.
array—
result
The report's rows.
array—
row_count
How many rows the report returned.
number—
chart
The report's chart definition, when it declares one.
object—
report_summary
The summary tiles ERPNext shows above the rows.
array—
execution_time
How long ERPNext took to run it, in seconds.
number—
message
The report's own message, when it sets one.
string—
{
  "chart": {},
  "columns": [],
  "execution_time": 0,
  "message": "",
  "report_name": "",
  "report_summary": [],
  "result": [],
  "row_count": 0
}

Related ERPNext nodes

See Run Report run in a workflow.

In a technical demo we add the ERPNext connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales