← Tools Reference

ERPNext

ERPNext integration (Productivity, Finance). Imported from open-connector.

API key6 tools{base_url}
GET
erpnext_get_logged_user
Get the currently authenticated ERPNext user for the configured connection.

/api/method/{erpnextLoggedUserMethod}

1 parameter
ParamTypeRequiredDescription
erpnextLoggedUserMethodstringrequiredPath parameter: erpnextLoggedUserMethod
GET
erpnext_list_documents
List ERPNext documents for a DocType with optional field selection, filters, sorting, and pagination.

/api/resource/{doctype}

6 parameters
ParamTypeRequiredDescription
doctypestringrequiredThe ERPNext DocType name to operate on.
fieldsarrayoptionalThe ERPNext document fields to include in the response.
filtersobjectoptionalFilters passed through to ERPNext as JSON.
order_bystringoptionalThe ERPNext order_by expression such as modified desc.
startintegeroptionalThe zero-based ERPNext list offset.
page_lengthintegeroptionalThe maximum number of ERPNext documents to return.
POST
erpnext_create_document
Create one ERPNext document for the specified DocType.

/api/resource/{doctype}

2 parameters
ParamTypeRequiredDescription
doctypestringrequiredThe ERPNext DocType name to operate on.
dataobjectoptionalThe document fields to create or update in ERPNext.
GET
erpnext_get_document_count
Get the count of ERPNext documents that match an optional filter.

/api/method/{erpnextGetCountMethod}

3 parameters
ParamTypeRequiredDescription
doctypestringrequiredThe ERPNext DocType name to operate on.
filtersobjectoptionalFilters passed through to ERPNext as JSON.
erpnextGetCountMethodstringrequiredPath parameter: erpnextGetCountMethod
GET
erpnext_get_document_value
Get one ERPNext field value or a group of field values without loading the full document.

/api/method/{erpnextGetValueMethod}

5 parameters
ParamTypeRequiredDescription
doctypestringrequiredThe ERPNext DocType name to operate on.
namestringoptionalThe unique name of the ERPNext document.
filtersobjectoptionalFilters passed through to ERPNext as JSON.
fieldnamestringrequiredOne field name or an array of field names to request from ERPNext.
erpnextGetValueMethodstringrequiredPath parameter: erpnextGetValueMethod
POST
erpnext_set_document_value
Set one field value on an ERPNext document and return the updated document.

/api/method/{erpnextSetValueMethod}

5 parameters
ParamTypeRequiredDescription
doctypestringoptionalThe ERPNext DocType name to operate on.
namestringoptionalThe unique name of the ERPNext document.
fieldnamestringoptionalThe ERPNext field name to update.
valuestringoptionalThe field value or object returned by ERPNext.
erpnextSetValueMethodstringrequiredPath parameter: erpnextSetValueMethod