# Erpnext

Free and open-source integrated Enterprise Resource Planning software built on Frappe Framework

- **Category:** accounting
- **Auth:** API_KEY
- **Tools:** 52
- **Triggers:** 0
- **Slug:** `ERPNEXT`
- **Version:** 00000000_00

## Tools

### Add Comment

**Slug:** `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.

### Add Tag

**Slug:** `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.

### Apply Workflow

**Slug:** `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.

### Cancel Document

**Slug:** `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.

### Create Document

**Slug:** `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.

### Create Timesheet

**Slug:** `ERPNEXT_CREATE_TIMESHEET`

Tool to create a new Timesheet record in ERPNext. Use when you need to log time entries for employees or projects.

### Create Webhook

**Slug:** `ERPNEXT_CREATE_WEBHOOK`

Tool to create a new webhook configuration in ERPNext. Use when you need to set up automated callbacks for DocType events like creation, updates, or submissions.

### Delete Document

**Slug:** `ERPNEXT_DELETE_CLIENT`

Tool to delete a document using the Frappe client API. Use when you need to remove a specific document by its doctype and name.

### Delete Document

**Slug:** `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.

### Download file from ERPNext

**Slug:** `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.

### Download PDF Document

**Slug:** `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.

### Get All Languages

**Slug:** `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.

### Get All Roles

**Slug:** `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.

### Get Document

**Slug:** `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.

### Get Document Count

**Slug:** `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.

### Get DocType Metadata

**Slug:** `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.

### Get Document

**Slug:** `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.

### Get Document with Metadata

**Slug:** `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.

### Get Exchange Rate

**Slug:** `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.

### Get Fiscal Year

**Slug:** `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.

### Get Framework Version

**Slug:** `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.

### Get Item Details

**Slug:** `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, warehouse, and currency.

### Get List of Documents

**Slug:** `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.

### Get Logged User

**Slug:** `ERPNEXT_GET_LOGGED_USER`

Tool to get the email/ID of the currently authenticated user. Use to verify authentication is working.

### Get Party Details

**Slug:** `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.

### Get Payment Entry

**Slug:** `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.

### Get Stock Balance

**Slug:** `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.

### Get Timezones

**Slug:** `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.

### Get User Roles

**Slug:** `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.

### Get Field Value

**Slug:** `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.

### Get Workflow Transitions

**Slug:** `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.

### Insert Document

**Slug:** `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.

### Insert Multiple Documents

**Slug:** `ERPNEXT_INSERT_MANY`

Tool to insert multiple documents at once into ERPNext/Frappe. Use when you need to create multiple records (Notes, Customers, Items, etc.) in a single API call for better efficiency.

### List DocTypes

**Slug:** `ERPNEXT_LIST_DOCTYPES`

Tool to get a list of all DocTypes available in the ERPNext system. Use when you need to retrieve available DocTypes with optional filtering and pagination.

### List ERPNext Documents

**Slug:** `ERPNEXT_LIST_DOCUMENTS`

Tool to list documents of a specific DocType from ERPNext. Returns paginated results (default 20 items). Use when you need to retrieve multiple documents, with support for filtering, field selection, and pagination.

### List Employees

**Slug:** `ERPNEXT_LIST_EMPLOYEES`

Tool to retrieve a list of Employee records from ERPNext. Use when you need to fetch employee information with optional filtering and pagination.

### List Projects

**Slug:** `ERPNEXT_LIST_PROJECTS`

Tool to retrieve a list of Project records from ERPNext. Use when you need to get projects, optionally filtered and paginated.

### List Timesheets

**Slug:** `ERPNEXT_LIST_TIMESHEETS`

Tool to get a list of Timesheet records from ERPNext. Use when you need to retrieve, search, or filter timesheets. Supports pagination and flexible field selection.

### List Webhooks

**Slug:** `ERPNEXT_LIST_WEBHOOKS`

Tool to list webhook configurations in ERPNext. Use when you need to retrieve all configured webhooks or search for specific webhooks using filters.

### Make Delivery Note

**Slug:** `ERPNEXT_MAKE_DELIVERY_NOTE`

Create a draft Delivery Note from an existing Sales Order in ERPNext. Use when you need to initiate shipment/delivery of items from a confirmed sales order. The created Delivery Note will be in draft state and can be modified before submission.

### Make Purchase Order

**Slug:** `ERPNEXT_MAKE_PURCHASE_ORDER`

Create a draft Purchase Order from an existing Material Request in ERPNext. Use when you need to initiate procurement of items from an approved material request. The created Purchase Order will be in draft state and can be modified before submission.

### Make Sales Invoice

**Slug:** `ERPNEXT_MAKE_SALES_INVOICE`

Tool to create a Sales Invoice from an existing Sales Order in ERPNext. Use when you need to generate an invoice for a confirmed sales order. The created invoice will be in draft state and can be submitted separately if needed.

### Make Stock Entry

**Slug:** `ERPNEXT_MAKE_STOCK_ENTRY`

Tool to create a Stock Entry for material transfer, receipt, or issue in ERPNext. Use when you need to record inventory movements between warehouses or add/remove stock. For Material Receipt, include target warehouse and basic_rate. For Material Issue, include source warehouse. For Material Transfer, include both source and target warehouses.

### Ping API

**Slug:** `ERPNEXT_PING`

Tool to check if the ERPNext/Frappe API is reachable. Use when you need to verify API connectivity or test authentication.

### Rename Document

**Slug:** `ERPNEXT_RENAME_DOC`

Tool to rename an ERPNext document by changing its unique ID/name. Use when you need to change a document's primary identifier, optionally merging with an existing document.

### Save Document with Action

**Slug:** `ERPNEXT_SAVE_DOCS`

Tool to save, submit, cancel, or update a document in ERPNext. Use when you need to create or modify documents in ERPNext. The doc parameter must be a JSON-serializable dictionary containing the document fields.

### Save Document

**Slug:** `ERPNEXT_SAVE_DOCUMENT`

Tool to save an existing ERPNext/Frappe document with changes. Use when you need to update an existing document in the system. Requires the complete document object including all system fields and the fields being updated.

### Global Search

**Slug:** `ERPNEXT_SEARCH_GLOBAL`

Tool to perform global text search across ERPNext documents. Use when you need to find documents, pages, or records by searching for keywords across the system. Results are ranked by relevance and include document type, name, content preview, and navigation route.

### Search Link Field Documents

**Slug:** `ERPNEXT_SEARCH_LINK`

Tool to search for documents to link in ERPNext/Frappe Link fields. Use when you need autocomplete suggestions for Link fields or to find documents by name/text.

### Set Value

**Slug:** `ERPNEXT_SET_VALUE`

Tool to set a specific field value on a document in ERPNext. Use when you need to update a single field without retrieving or modifying the entire document.

### Submit Document

**Slug:** `ERPNEXT_SUBMIT_DOCUMENT`

Submit a draft document in ERPNext/Frappe to change its status from Draft to Submitted. Use for submittable DocTypes like Sales Invoice, Purchase Order, Journal Entry, etc. Document must exist in draft state (docstatus=0) before submission.

### Update ERPNext document

**Slug:** `ERPNEXT_UPDATE_DOCUMENT`

Tool to update a specific ERPNext document. Acts like a PATCH request - only send the fields you want to change, not the whole document. Use when you need to modify specific fields of an existing document.
