Cancel Document
erpnext.cancel_document
ActionCRM & salesconnection required
Calls the ERPNext API with the connection's credentials.
Cancel a submitted document, moving it to docstatus 2 and reversing its ledger entries.
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
2 fields, 1 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 |
|---|---|---|---|---|---|
doctype The DocType to act on, spelled as ERPNext spells it (e.g. 'Sales Order'). Overrides the default DocType on the connection. | string | No | — | — | Customer |
name The document's name — its primary key in ERPNext (e.g. 'ACC-SINV-2025-00001'). | string | Yes | — | — | CUST-0001 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"doctype": "Customer",
"name": "CUST-0001"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
doctype The DocType that was acted on. | string | — |
name The document's name in ERPNext. | string | — |
docstatus 0 for draft, 1 for submitted, 2 for cancelled. | number | — |
document The whole document as ERPNext stored it. | object | — |
{
"docstatus": 0,
"doctype": "",
"document": {},
"name": ""
}See Cancel Document 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.