API_KEY
erpnext_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Base URLfull · stringRequired
- API Keygeneric_api_key · stringRequired
- API Secretgeneric_token · stringRequired
ERPNEXT
Free and open-source integrated Enterprise Resource Planning software built on Frappe Framework
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
50
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–30 of 50 actions
ERPNEXT_ADD_COMMENT
Tool to add a comment to a document in ERPNext/Frappe. Use when you need to add comments or notes to any document type like ToDo, Issue, Task, or custom DocTypes.
Untrusted display-only summary
ERPNEXT_ADD_TAG
Tool to add a tag to a document in ERPNext. Use when you need to categorize or label documents for organization and filtering purposes.
Untrusted display-only summary
ERPNEXT_APPLY_WORKFLOW
Tool to apply a workflow action to a document in ERPNext/Frappe. Use when you need to transition a document through workflow states (e.g., approve, reject, submit). The document must have a workflow configured for its doctype.
Untrusted display-only summary
ERPNEXT_CANCEL_DOCUMENT
Cancel a submitted document in ERPNext/Frappe to change its status from Submitted to Cancelled. Use for submittable DocTypes when you need to reverse or cancel a submitted transaction. Document must be in Submitted state (docstatus=1) before cancellation.
Untrusted display-only summary
ERPNEXT_CREATE_DOCUMENT
Tool to create a new document of a specific DocType in ERPNext. Use when you need to create records like ToDo, Customer, Lead, Sales Invoice, etc. The document data should include all required fields for the specific DocType. Standard fields like creation, modified, and owner are automatically set by ERPNext.
Untrusted display-only summary
ERPNEXT_CREATE_TIMESHEET
Tool to create a new Timesheet record in ERPNext. Use when you need to log time entries for employees or projects.
Untrusted display-only summary
ERPNEXT_DELETE_DOCUMENT
Tool to delete a specific document by DocType and name. Use when you need to remove a document from ERPNext. Requires delete permissions for the specified DocType.
Untrusted display-only summary
ERPNEXT_DOWNLOAD_FILE
Tool to download a file from ERPNext by its URL. Use when you need to retrieve file content from the ERPNext instance using the file's URL path.
Untrusted display-only summary
ERPNEXT_DOWNLOAD_PDF
Tool to download a document as PDF from ERPNext with optional print format. Use when you need to retrieve a document in PDF format, optionally specifying a custom print format or excluding letterhead.
Untrusted display-only summary
ERPNEXT_GET_ALL_LANGUAGES
Tool to get a list of all available languages in the ERPNext/Frappe system. Use when you need to retrieve supported languages for translation or localization purposes.
Untrusted display-only summary
ERPNEXT_GET_ALL_ROLES
Tool to get a list of all roles available in the ERPNext system. Use when you need to retrieve all available roles for assignment or reference.
Untrusted display-only summary
ERPNEXT_GET_CLIENT
Tool to get a single document by DocType and name or filters from Frappe/ERPNext. Use when you need to retrieve a specific document's complete details.
Untrusted display-only summary
ERPNEXT_GET_COUNT
Tool to get the count of documents matching specified filters in ERPNext/Frappe. Use when you need to know how many records exist for a specific DocType, optionally filtered by conditions.
Untrusted display-only summary
ERPNEXT_GET_DOCTYPE_META
Tool to retrieve complete DocType metadata/schema including field definitions, field types, permissions, and configurations. Use when you need to understand the structure of a DocType, its fields, validation rules, or permissions before creating or querying documents.
Untrusted display-only summary
ERPNEXT_GET_DOCUMENT
Tool to retrieve a specific document by its DocType and name (ID). Returns the complete document with all fields. Use when you need to fetch details of a specific ERPNext document like Customer, Employee, Account, Sales Invoice, etc.
Untrusted display-only summary
ERPNEXT_GET_DOC_WITH_META
Tool to retrieve a document with full metadata including attachments, comments, activity logs, and related information. Use when you need complete document details beyond the basic fields returned by standard GET requests.
Untrusted display-only summary
ERPNEXT_GET_EXCHANGE_RATE
Tool to get the currency exchange rate between two currencies in ERPNext. Use when you need to convert amounts between different currencies or check current exchange rates.
Untrusted display-only summary
ERPNEXT_GET_FISCAL_YEAR
Tool to get fiscal year information for a given date in ERPNext. Use when you need to determine which fiscal year a specific date falls into or retrieve fiscal year boundaries.
Untrusted display-only summary
ERPNEXT_GET_FRAMEWORK_VERSION
Tool to get the Frappe framework version and all installed app versions. Use when you need to check the ERPNext/Frappe system version for compatibility or debugging purposes.
Untrusted display-only summary
ERPNEXT_GET_ITEM_DETAILS
Tool to get detailed item information including pricing, taxes, and stock details from ERPNext. Use when you need comprehensive item data for transactions like Sales Orders, Purchase Orders, or Invoices. This action retrieves item-specific information based on the provided context including customer, price list, wareh…
Untrusted display-only summary
ERPNEXT_GET_LIST
Tool to retrieve a list of documents from ERPNext/Frappe with filtering, field selection, and pagination. Use when you need to query documents of a specific DocType with optional filters, sorting, and field selection. The response contains an array of document objects with the requested fields.
Untrusted display-only summary
ERPNEXT_GET_LOGGED_USER
Tool to get the email/ID of the currently authenticated user. Use to verify authentication is working.
Untrusted display-only summary
ERPNEXT_GET_PARTY_DETAILS
Tool to get comprehensive customer or supplier details including addresses, contacts, and default financial settings. Use when creating transactions or updating party information in ERPNext.
Untrusted display-only summary
ERPNEXT_GET_PAYMENT_ENTRY
Tool to get payment entry details for an invoice or order from ERPNext. Use when you need to retrieve payment information for a Sales Invoice, Purchase Invoice, Sales Order, or Purchase Order. This returns a Payment Entry document with party details, payment amounts, accounts, exchange rates, and reference information.
Untrusted display-only summary
ERPNEXT_GET_STOCK_BALANCE
Tool to retrieve the current stock balance for a specific item in a warehouse. Use when you need to check inventory levels or available quantity.
Untrusted display-only summary
ERPNEXT_GET_TIMEZONES
Tool to get a list of all available timezones in the ERPNext system. Use when you need to retrieve timezone options for user configuration or scheduling.
Untrusted display-only summary
ERPNEXT_GET_USER_ROLES
Tool to get roles assigned to a user. Use when you need to check user permissions or access levels in ERPNext/Frappe.
Untrusted display-only summary
ERPNEXT_GET_VALUE
Tool to get specific field value(s) from a document in ERPNext. Use when you need to retrieve one or more field values without loading the entire document.
Untrusted display-only summary
ERPNEXT_GET_WORKFLOW_TRANSITIONS
Tool to get available workflow transitions for a document. Use when you need to check what workflow actions are available for a specific document based on its current state and user permissions.
Untrusted display-only summary
ERPNEXT_INSERT_DOCUMENT
Tool to insert a new document in ERPNext/Frappe using the client API. Use when you need to create any type of document (ToDo, Customer, Item, etc.) by providing the doctype and required fields.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.