- Category: accounting
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 50
- Triggers: 0
- Slug:
ERPNEXT - Version: 20261101_00
Tools
Add Comment
Add Comment
Add Tag
Add Tag
ERPNEXT_ADD_TAGTool to add a tag to a document in ERPNext. Use when you need to categorize or label documents for organization and filtering purposes.Input Parameters
Output
Apply Workflow
Apply Workflow
ERPNEXT_APPLY_WORKFLOWTool 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.Input Parameters
Output
Cancel Document
Cancel Document
ERPNEXT_CANCEL_DOCUMENTCancel 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.Input Parameters
Output
Create Document
Create Document
ERPNEXT_CREATE_DOCUMENTCreate a document of a specified ERPNext DocType using scalar field values. Document data should include the required fields for that DocType; standard fields such as creation, modified, and owner are set by ERPNext.Input Parameters
Output
Create Timesheet
Create Timesheet
Delete Document
Delete Document
ERPNEXT_DELETE_DOCUMENTTool 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.Input Parameters
Output
Download file from ERPNext
Download file from ERPNext
ERPNEXT_DOWNLOAD_FILETool 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.Input Parameters
Output
Download PDF Document
Download PDF Document
ERPNEXT_DOWNLOAD_PDFTool 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.Input Parameters
Output
Get All Languages
Get All Languages
ERPNEXT_GET_ALL_LANGUAGESTool 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.Input Parameters
Output
Get All Roles
Get All Roles
Get Document
Get Document
ERPNEXT_GET_CLIENTTool 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.Input Parameters
Output
Get Document Count
Get Document Count
ERPNEXT_GET_COUNTTool 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.Input Parameters
Output
Get DocType Metadata
Get DocType Metadata
ERPNEXT_GET_DOCTYPE_METATool 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.Input Parameters
Output
Get Document
Get Document
ERPNEXT_GET_DOCUMENTTool 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.Input Parameters
[["Customer", "country", "=", "India"]]Output
Get Document with Metadata
Get Document with Metadata
Get Exchange Rate
Get Exchange Rate
ERPNEXT_GET_EXCHANGE_RATETool 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.Input Parameters
Output
Get Fiscal Year
Get Fiscal Year
ERPNEXT_GET_FISCAL_YEARTool 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.Input Parameters
Output
Get Framework Version
Get Framework Version
Get Item Details
Get Item Details
ERPNEXT_GET_ITEM_DETAILSTool 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.Input Parameters
Output
Get List of Documents
Get List of Documents
ERPNEXT_GET_LISTTool 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.Input Parameters
Output
Get Logged User
Get Logged User
Get Party Details
Get Party Details
Get Payment Entry
Get Payment Entry
ERPNEXT_GET_PAYMENT_ENTRYTool 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.Input Parameters
Output
Get Stock Balance
Get Stock Balance
Get Timezones
Get Timezones
Get User Roles
Get User Roles
Get Field Value
Get Field Value
ERPNEXT_GET_VALUETool 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.Input Parameters
Output
Get Workflow Transitions
Get Workflow Transitions
ERPNEXT_GET_WORKFLOW_TRANSITIONSGet available workflow transitions for a specific document based on its current state and user permissions. An HTTP 404 is returned as an empty transition list, so an empty result does not necessarily mean there are no available transitions.Input Parameters
Output
Insert Document
Insert Document
ERPNEXT_INSERT_DOCUMENTTool 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.Input Parameters
Output
Insert Multiple Documents
Insert Multiple Documents
ERPNEXT_INSERT_MANYTool 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.Input Parameters
Output
List DocTypes
List DocTypes
ERPNEXT_LIST_DOCTYPESTool 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.Input Parameters
[["DocType", "module", "=", "Core"]] to filter DocTypes by module.Output
List ERPNext Documents
List ERPNext Documents
ERPNEXT_LIST_DOCUMENTSTool 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.Input Parameters
[['Customer', 'country', '=', 'India']]Output
List Employees
List Employees
ERPNEXT_LIST_EMPLOYEESTool to retrieve a list of Employee records from ERPNext. Use when you need to fetch employee information with optional filtering and pagination.Input Parameters
[['Employee', 'status', '=', 'Active']] to filter active employees only.Output
List Projects
List Projects
ERPNEXT_LIST_PROJECTSTool to retrieve a list of Project records from ERPNext. Use when you need to get projects, optionally filtered and paginated.Input Parameters
[["Project", "status", "=", "Open"]]Output
List Timesheets
List Timesheets
ERPNEXT_LIST_TIMESHEETSTool 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.Input Parameters
[['Timesheet', 'status', '=', 'Submitted']] to get only submitted timesheets. Multiple filters can be combined: [['Timesheet', 'employee', '=', 'EMP-001'], ['Timesheet', 'status', '=', 'Draft']]Output
List Webhooks
List Webhooks
ERPNEXT_LIST_WEBHOOKSList ERPNext webhook configurations, optionally filtering results and selecting fields. Results are paginated; request successive pages to retrieve all configurations.Input Parameters
[['Webhook', 'enabled', '=', 1]]Output
Make Delivery Note
Make Delivery Note
ERPNEXT_MAKE_DELIVERY_NOTECreate 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.Input Parameters
Output
Make Purchase Order
Make Purchase Order
ERPNEXT_MAKE_PURCHASE_ORDERCreate 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.Input Parameters
Output
Make Sales Invoice
Make Sales Invoice
ERPNEXT_MAKE_SALES_INVOICETool 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.Input Parameters
Output
Make Stock Entry
Make Stock Entry
ERPNEXT_MAKE_STOCK_ENTRYTool 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.Input Parameters
Output
Ping API
Ping API
Rename Document
Rename Document
ERPNEXT_RENAME_DOCTool 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.Input Parameters
Output
Save Document with Action
Save Document with Action
ERPNEXT_SAVE_DOCSTool 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.Input Parameters
Output
Save Document
Save Document
ERPNEXT_SAVE_DOCUMENTTool 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.Input Parameters
Output
Global Search
Global Search
ERPNEXT_SEARCH_GLOBALTool 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.Input Parameters
Output
Search Link Field Documents
Search Link Field Documents
Set Value
Set Value
Submit Document
Submit Document
ERPNEXT_SUBMIT_DOCUMENTSubmit 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.Input Parameters
Output
Update ERPNext document
Update ERPNext document
ERPNEXT_UPDATE_DOCUMENTTool 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.