Get Field Values

erpnext.get_value
ActionCRM & salesconnection required

Calls the ERPNext API with the connection's credentials.

Read named fields off the first document that matches, without fetching the rest of it.

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

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

FieldTypeRequiredDefaultConstraintsExample
doctype
The DocType to act on, spelled as ERPNext spells it (e.g. 'Sales Order'). Overrides the default DocType on the connection.
stringNo——Customer
fieldname
The fields to read, e.g. ["status", "grand_total"]. A single field name on its own works too.
arrayYes—≥ 1 characters; array of string["status","grand_total"]
name
The document to read from. Use this or filters, not both.
stringNo——CUST-0001
filters
Pick the document by filters instead of by name, e.g. [["email_id", "=", "a@acme.com"]]. The first match wins.
arrayNo———
parent
The parent DocType, required only when reading a child-table field.
stringNo———
  • At least one of name, filters must be set.

Example configuration

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

{
  "doctype": "Customer",
  "fieldname": [
    "status",
    "grand_total"
  ],
  "name": "CUST-0001"
}

Output

One shape.

result

FieldTypeExample
doctype
The DocType that was read.
string—
values
The requested fields and their values.
object—
found
False when nothing matched, so values is empty.
boolean—
{
  "doctype": "",
  "found": false,
  "values": {}
}

See Get Field Values 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.