Erpnext

erpnext

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

Accounting Project Management Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (52)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add CommentERPNEXT_ADD_COMMENTAcción

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.

Parámetros de entrada

contentstringObligatorio
The comment content/text to be added to the document
comment_bystringObligatorio
Name or identifier of the person making the comment (typically same as comment_email)
comment_emailstringObligatorio
Email address of the person making the comment
reference_namestringObligatorio
The name/ID of the specific document to add the comment to
reference_doctypestringObligatorio
The DocType of the document to add comment to (e.g., 'ToDo', 'Issue', 'Task')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add TagERPNEXT_ADD_TAGAcción

Tool to add a tag to a document in ERPNext. Use when you need to categorize or label documents for organization and filtering purposes.

Parámetros de entrada

dnstringObligatorio
Target document name (unique identifier) of the document to tag. This is the specific document instance within the DocType.
dtstringObligatorio
Target DocType (document type) to which the tag will be added. Examples include 'ToDo', 'Sales Invoice', 'Customer', etc.
tagstringObligatorio
Tag to add to the document. Can be any string value.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Apply WorkflowERPNEXT_APPLY_WORKFLOWAcción

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.

Parámetros de entrada

docobjectObligatorio
Document object to apply the workflow action to. Must include required fields like 'name', 'doctype', and other document-specific fields.
actionstringObligatorio
Workflow action name to apply (e.g., 'Approve', 'Reject', 'Submit'). Must be a valid action defined in the document's workflow.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel DocumentERPNEXT_CANCEL_DOCUMENTAcción

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.

Parámetros de entrada

namestringObligatorio
The unique name/ID of the submitted document to cancel. This is the document's primary identifier within ERPNext. The document must exist and be in Submitted state.
doctypestringObligatorio
The DocType of the document to cancel. Only submittable DocTypes can be canceled. Examples: 'Journal Entry', 'Sales Invoice', 'Purchase Order', 'Delivery Note', 'Payment Entry', 'Stock Entry'. The document must be in Submitted state (docstatus=1).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DocumentERPNEXT_CREATE_DOCUMENTAcción

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.

Parámetros de entrada

dataobjectObligatorio
Document data as a dictionary of field names and values. The required fields depend on the specific DocType. Common fields include: name, description, title, status, etc. Refer to ERPNext documentation for specific DocType field requirements.
doctypestringObligatorio
The DocType you'd like to create. For example: Customer, Supplier, Employee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, ToDo, etc. This must be a valid DocType name in your ERPNext instance.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TimesheetERPNEXT_CREATE_TIMESHEETAcción

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

Parámetros de entrada

notestring
Additional notes or comments for the timesheet
companystringObligatorio
Company name for which the timesheet is being created
employeestring
Employee ID or name for the timesheet (optional)
time_logsobject[]Obligatorio
List of time log entries for the timesheet. Each entry must have activity_type, from_time, and to_time

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookERPNEXT_CREATE_WEBHOOKAcción

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.

Parámetros de entrada

namestringObligatorio
Unique name identifier for the webhook. This is required as ERPNext webhooks use manual naming.
request_urlstringObligatorio
The endpoint URL where the webhook POST request will be sent.
webhook_dataobject[]
Optional list of document fields to include in the webhook payload. Maps document fieldnames to custom keys.
webhook_doctypestringObligatorio
The DocType to monitor for events (e.g., 'Task', 'Sales Invoice', 'Customer').
webhook_headersobject[]
Optional list of custom HTTP headers to include in the webhook request, useful for authorization.
webhook_doceventstringObligatorio
The document event to trigger the webhook. Common values: 'after_insert', 'on_update', 'on_submit', 'on_cancel', 'on_trash'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DocumentERPNEXT_DELETE_CLIENTAcción

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

Parámetros de entrada

namestringObligatorio
The unique name/identifier of the document to delete
doctypestringObligatorio
The DocType of the document to delete (e.g., 'Note', 'Customer', 'Task')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DocumentERPNEXT_DELETE_DOCUMENTAcción

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.

Parámetros de entrada

doctypestringObligatorio
The type of the document to delete. Examples: Customer, Supplier, Employee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, Note, etc. The DocType must exist in your ERPNext instance and you must have delete permissions.
document_namestringObligatorio
The unique name (ID) of the document to delete. This is the document's primary identifier, not the display title. Example: EMP001 (for Employee DocType) or a generated ID like 7l1epfhlls (for Note DocType).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download file from ERPNextERPNEXT_DOWNLOAD_FILEAcción

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.

Parámetros de entrada

file_urlstringObligatorio
URL of the file to download. This should be a relative path starting with /files/ or /private/files/ (e.g., '/files/test_file.txt'). The file must exist on the ERPNext instance.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download PDF DocumentERPNEXT_DOWNLOAD_PDFAcción

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.

Parámetros de entrada

namestringObligatorio
Document name/ID to download
formatstring
Print format name to use for the PDF. If not specified, the default print format for the DocType will be used.
doctypestringObligatorio
DocType of the document to download (e.g., 'User', 'Sales Invoice', 'Purchase Order')
no_letterheadinteger
Set to 1 to exclude letterhead from the PDF, set to 0 or omit to include letterhead

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All LanguagesERPNEXT_GET_ALL_LANGUAGESAcción

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.

Parámetros de entrada

with_language_nameboolean
Include language names along with language codes. When false or omitted, returns only an array of language codes (e.g., ['en', 'es']). When true, returns an array of objects with both language_code and language_name fields (e.g., [{'language_code': 'en', 'language_name': 'English'}]).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All RolesERPNEXT_GET_ALL_ROLESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DocumentERPNEXT_GET_CLIENTAcción

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.

Parámetros de entrada

namestring
The unique name/identifier of the specific document to retrieve. If provided, this takes precedence over filters.
doctypestringObligatorio
The DocType to query (e.g., 'User', 'Customer', 'Item'). DocTypes are the document types defined in your Frappe/ERPNext instance.
filtersobject
Filter conditions to find the document when name is not provided. Should be a dictionary of field-value pairs. Example: {'email': 'user@example.com'}

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Document CountERPNEXT_GET_COUNTAcción

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.

Parámetros de entrada

doctypestringObligatorio
The DocType name to count documents for (e.g., 'User', 'Task', 'Project'). Must be a valid DocType in the ERPNext/Frappe system.
filtersobject
Optional filter conditions to apply when counting documents. Format: {field_name: value} or {field_name: ['operator', value]}. Example: {'status': 'Open'} or {'creation': ['>', '2024-01-01']}.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DocType MetadataERPNEXT_GET_DOCTYPE_METAAcción

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.

Parámetros de entrada

doctypestringObligatorio
The DocType name to retrieve metadata for (e.g., 'Customer', 'Sales Order', 'Item')
with_parentboolean
Include parent DocType metadata if this DocType is a child table. Useful when retrieving metadata for child tables in reports.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DocumentERPNEXT_GET_DOCUMENTAcción

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.

Parámetros de entrada

namestringObligatorio
The name (ID) of the document you'd like to receive. For example EMP001 (of type Employee).
fieldsstring[]
By default, only the "name" field is included in the listing. To add more fields, you can pass the fields param. For example, ["name", "country"]
doctypestringObligatorio
The DocType you'd like to receive. For example Customer, Supplier, Employee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.
filtersarray[]
You can filter the listing using sql conditions. Each condition is an array of the format, [doctype, field, operator, value]. For example, [["Customer", "country", "=", "India"]]

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Document with MetadataERPNEXT_GET_DOC_WITH_METAAcción

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.

Parámetros de entrada

namestringObligatorio
The unique name/identifier of the document to retrieve
doctypestringObligatorio
The DocType name (e.g., 'Account', 'Customer', 'Sales Order')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Exchange RateERPNEXT_GET_EXCHANGE_RATEAcción

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.

Parámetros de entrada

to_currencystringObligatorio
Target currency code in ISO 4217 format (e.g., 'EUR', 'USD', 'JPY'). This is the currency you are converting to.
from_currencystringObligatorio
Source currency code in ISO 4217 format (e.g., 'USD', 'EUR', 'GBP'). This is the currency you are converting from.
transaction_datestring
Optional date for the exchange rate in YYYY-MM-DD format. If not provided, the current date's exchange rate will be used.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Fiscal YearERPNEXT_GET_FISCAL_YEARAcción

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.

Parámetros de entrada

datestring
Date to check for fiscal year in YYYY-MM-DD format. If not provided, the current date will be used.
companystring
Company name to get fiscal year for. If not provided, the default company will be used.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Framework VersionERPNEXT_GET_FRAMEWORK_VERSIONAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Item DetailsERPNEXT_GET_ITEM_DETAILSAcción

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.

Parámetros de entrada

ctxobjectObligatorio
Context object containing all required parameters for retrieving item details.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get List of DocumentsERPNEXT_GET_LISTAcción

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.

Parámetros de entrada

startinteger
Pagination start index (zero-based). Use this with page_length for pagination. For example, start=0 gets first page, start=20 gets second page with page_length=20.
fieldsstring[]
List of field names to return in the response. If not specified, only the 'name' field is returned by default. Use this to specify which fields you want to retrieve (e.g., ['name', 'email', 'first_name']).
doctypestringObligatorio
The DocType to query. This is the name of the document type you want to retrieve records from (e.g., 'User', 'Customer', 'Sales Order').
filtersobject
Filter conditions to apply to the query. Supports various filter operators. Can be a simple dict like {'status': 'Open'} or complex filters with operators like {'creation': ['>', '2024-01-01']}.
order_bystring
Sort order for the results. Specify field name with optional direction (e.g., 'modified desc', 'creation asc', 'name'). Default is descending order.
page_lengthinteger
Number of records to return per page. Default is 20 if not specified. Maximum value depends on server configuration. Use with start parameter for pagination.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Logged UserERPNEXT_GET_LOGGED_USERAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Party DetailsERPNEXT_GET_PARTY_DETAILSAcción

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.

Parámetros de entrada

partystringObligatorio
Name (ID) of the customer or supplier
companystring
Company name for which to fetch party details. If not specified, default company is used.
party_typestringObligatorio
Type of party - either 'Customer' or 'Supplier'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Payment EntryERPNEXT_GET_PAYMENT_ENTRYAcción

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.

Parámetros de entrada

dnstringObligatorio
Document name (ID) of the specific document to get payment entry for (e.g., 'SINV-26-00001', 'PINV-2024-00001').
dtstringObligatorio
DocType for which to get payment entry details. Common values include 'Sales Invoice', 'Purchase Invoice', 'Sales Order', 'Purchase Order'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock BalanceERPNEXT_GET_STOCK_BALANCEAcción

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.

Parámetros de entrada

item_codestringObligatorio
The unique code/identifier of the item to check stock balance for.
warehousestringObligatorio
The name of the warehouse to check stock balance in.
posting_datestring
Date for balance calculation in YYYY-MM-DD format. If not provided, current date is used.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TimezonesERPNEXT_GET_TIMEZONESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User RolesERPNEXT_GET_USER_ROLESAcción

Tool to get roles assigned to a user. Use when you need to check user permissions or access levels in ERPNext/Frappe.

Parámetros de entrada

uidstring
User ID to get roles for. If not provided, returns roles for the currently authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Field ValueERPNEXT_GET_VALUEAcción

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.

Parámetros de entrada

namestring
The specific document name/ID to retrieve. Use this when you know the exact document identifier. Cannot be used together with filters parameter.
doctypestringObligatorio
The DocType (document type) to query. Examples include 'User', 'Customer', 'Sales Invoice', 'Item', etc.
filtersstring
Filter conditions as JSON string to match documents (e.g., '{"status": "Open"}' or '{"email": "user@example.com"}'). Returns the first matching document. Cannot be used together with name parameter.
fieldnamestringObligatorio
The field name(s) to retrieve. For multiple fields, provide a comma-separated list (e.g., 'full_name,email').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workflow TransitionsERPNEXT_GET_WORKFLOW_TRANSITIONSAcción

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.

Parámetros de entrada

namestringObligatorio
The name/ID of the specific document to get workflow transitions for.
doctypestringObligatorio
The DocType name of the document to get workflow transitions for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Insert DocumentERPNEXT_INSERT_DOCUMENTAcción

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.

Parámetros de entrada

docobjectObligatorio
Document object containing doctype field (required) and document-specific fields. The doctype must be a valid DocType name in your ERPNext instance (e.g., 'ToDo', 'Customer', 'Item'). Additional fields depend on the specific DocType schema.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Insert Multiple DocumentsERPNEXT_INSERT_MANYAcción

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.

Parámetros de entrada

docsobject[]Obligatorio
Array of document objects to insert. Each document must have a 'doctype' field that specifies the type of document (e.g., 'Note', 'Customer', 'Item'). Additional fields depend on the specific doctype requirements. For example, a Note requires 'title' and 'content' fields.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DocTypesERPNEXT_LIST_DOCTYPESAcción

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.

Parámetros de entrada

fieldsstring[]
Fields to include in the listing. By default, only the "name" field is included. Pass a list of field names to include additional fields, for example ["name", "module"].
filtersarray[]
SQL conditions to filter the listing. Each condition is an array of the format [doctype, field, operator, value]. For example, [["DocType", "module", "=", "Core"]] to filter DocTypes by module.
limit_startinteger
Starting offset for pagination. To request successive pages, pass a multiple of your limit_page_length. For example, to request the second page, pass limit_start as 20 (if limit_page_length is 20).
limit_page_lengthinteger
Number of items to return per page. By default, listings are paginated with 20 items per page.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ERPNext DocumentsERPNEXT_LIST_DOCUMENTSAcción

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.

Parámetros de entrada

fieldsstring[]
Fields to include in the response. By default, only the 'name' field is included. Pass a list of field names to retrieve additional fields. For example: ['name', 'country']
doctypestringObligatorio
The DocType you'd like to receive. For example: Customer, Supplier, Employee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.
filtersarray[]
SQL conditions to filter the listing. Each condition is an array of the format: [doctype, field, operator, value]. For example: [['Customer', 'country', '=', 'India']]
limit_startinteger
Offset for pagination. Pass a multiple of limit_page_length to request successive pages. For example, to request the second page with page length 20, pass 20.
limit_page_lengthinteger
Number of items to return per page. Default is 20.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EmployeesERPNEXT_LIST_EMPLOYEESAcción

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

Parámetros de entrada

fieldsstring[]
List of fields to include in the response. By default, only the 'name' field is included. Pass field names as a list to retrieve additional fields. For example: ['name', 'employee_name', 'department', 'designation']
filtersarray[]
SQL conditions to filter the listing. Each condition is an array of the format [doctype, field, operator, value]. For example: [['Employee', 'status', '=', 'Active']] to filter active employees only.
limit_startinteger
Starting position for pagination. To request successive pages, pass a multiple of limit_page_length. For example, to request the second page with page size 20, pass limit_start=20.
limit_page_lengthinteger
Number of records to return per page. Default is 20.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ProjectsERPNEXT_LIST_PROJECTSAcción

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

Parámetros de entrada

fieldsstring[]
Fields to include in the response. By default, only the "name" field is included. Pass a list of field names to include additional fields.
filtersarray[]
SQL conditions to filter the listing. Each condition is an array of the format: [doctype, field, operator, value]. For example: [["Project", "status", "=", "Open"]]
limit_startinteger
Offset for pagination. Pass a multiple of limit_page_length to request successive pages. For example, pass 20 to request the second page when limit_page_length is 20.
limit_page_lengthinteger
Number of items to return per page. Controls pagination size.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TimesheetsERPNEXT_LIST_TIMESHEETSAcción

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.

Parámetros de entrada

fieldsstring[]
List of fields to include in the response. By default, only the 'name' field is included. To add more fields, specify them in this list. For example: ['name', 'employee', 'total_hours', 'status']
filtersarray[]
SQL-style conditions to filter the listing. Each condition is an array of the format: [doctype, field, operator, value]. For example: [['Timesheet', 'status', '=', 'Submitted']] to get only submitted timesheets. Multiple filters can be combined: [['Timesheet', 'employee', '=', 'EMP-001'], ['Timesheet', 'status', '=', 'Draft']]
limit_startinteger
Starting position for pagination. To request successive pages, pass a multiple of your limit_page_length. For example, to request the second page with page length 20, pass limit_start=20.
limit_page_lengthinteger
Number of records to return per page. Controls the page size for pagination. Default is 20 records. Maximum is 1000.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksERPNEXT_LIST_WEBHOOKSAcción

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

Parámetros de entrada

fieldsstring[]
List of fields to include in the response. By default, only the 'name' field is included. Pass additional fields like ['name', 'webhook_doctype', 'webhook_docevent'] to get more data.
filtersarray[]
SQL conditions to filter the listing. Each condition is an array of the format [doctype, field, operator, value]. For example: [['Webhook', 'enabled', '=', 1]]
limit_startinteger
Starting index for pagination. Pass a multiple of limit_page_length to get successive pages. For example, to get the second page with page size 20, pass 20.
limit_page_lengthinteger
Number of items to return per page. By default, the API returns 20 items.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Make Delivery NoteERPNEXT_MAKE_DELIVERY_NOTEAcción

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.

Parámetros de entrada

source_namestringObligatorio
Sales Order name/ID from which to create the Delivery Note. The Sales Order must exist and be in a submitted state (docstatus=1). Example: 'SAL-ORD-2026-00002', 'SO-00123'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Make Purchase OrderERPNEXT_MAKE_PURCHASE_ORDERAcción

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.

Parámetros de entrada

source_namestringObligatorio
Material Request name/ID from which to create the Purchase Order. The Material Request must exist and be of type 'Purchase' with submitted state (docstatus=1). Example: 'MAT-MR-2026-00001', 'MR-00123'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Make Sales InvoiceERPNEXT_MAKE_SALES_INVOICEAcción

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.

Parámetros de entrada

source_namestringObligatorio
Sales Order name/ID to convert into a Sales Invoice. Must be a valid Sales Order identifier (e.g., 'SAL-ORD-2026-00001'). The Sales Order should exist in the system and be in a valid state for invoice creation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Make Stock EntryERPNEXT_MAKE_STOCK_ENTRYAcción

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.

Parámetros de entrada

qtynumberObligatorio
Quantity of the item to be transferred, received, or issued. Must be a positive number.
sourcestring
Source warehouse from which the item is being transferred or issued. Required for Material Transfer and Material Issue purposes.
targetstring
Target warehouse to which the item is being transferred or received. Required for Material Transfer and Material Receipt purposes.
purposestringenum
Enumeration of stock entry purposes.
Material ReceiptMaterial IssueMaterial TransferMaterial Transfer for ManufactureMaterial Consumption for ManufactureManufactureRepackSend to Subcontractor
item_codestringObligatorio
Item code for the stock entry. Must be a valid Item in the ERPNext system.
basic_ratenumber
Valuation rate per unit of the item. Required for Material Receipt when the item has no valuation rate defined to avoid validation errors.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Ping APIERPNEXT_PINGAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rename DocumentERPNEXT_RENAME_DOCAcción

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.

Parámetros de entrada

mergeboolean
If True, merge with an existing document having the new_name. If False or omitted, rename without merging.
doctypestringObligatorio
The DocType of the document to rename (e.g., 'Customer', 'Item', 'Sales Order').
new_namestringObligatorio
The new unique name/ID to assign to the document.
old_namestringObligatorio
The current unique name/ID of the document to be renamed.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Save Document with ActionERPNEXT_SAVE_DOCSAcción

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.

Parámetros de entrada

docobjectObligatorio
Document to save as a dictionary. Must include required fields: 'doctype' (the DocType name), 'name' (document ID if updating), and other relevant fields for the specific DocType. Example: {'doctype': 'ToDo', 'name': 'abc123', 'description': 'Task description', 'status': 'Open'}
actionstringenum
Action to perform on the document: Save (create or update), Submit (submit for approval), Cancel (cancel submitted document), Update (update after submission)
SaveSubmitCancelUpdate

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Save DocumentERPNEXT_SAVE_DOCUMENTAcción

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.

Parámetros de entrada

docobjectObligatorio
Complete document object to save. Must include 'doctype' and 'name' at minimum. Should also include system fields (owner, creation, modified, modified_by, docstatus, idx) and any doctype-specific fields you want to update. Additional fields beyond the base schema are allowed and will be passed to the API.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Global SearchERPNEXT_SEARCH_GLOBALAcción

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.

Parámetros de entrada

textstringObligatorio
Search query text to find across documents
limitinteger
Maximum number of results to return
scopestring
Optional scope to narrow search to specific route/section
startinteger
Starting position for pagination (0-based index)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Link Field DocumentsERPNEXT_SEARCH_LINKAcción

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.

Parámetros de entrada

txtstringObligatorio
Search text to filter results. Can be empty string to return all results.
querystring
Custom search query function path (advanced usage)
doctypestringObligatorio
DocType to search within (e.g., 'User', 'Customer', 'Item')
filtersobject
Filter conditions to apply to the search as a dictionary of field-value pairs
page_lengthinteger
Number of results to return per page
searchfieldstring
Specific field to search within (if not provided, searches default fields)
link_fieldnamestring
Name of the link field being searched (used for context)
reference_doctypestring
Document type containing the link field (used for context)
ignore_user_permissionsboolean
Whether to ignore user permissions when searching (default: False)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set ValueERPNEXT_SET_VALUEAcción

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.

Parámetros de entrada

namestringObligatorio
The document name/ID to update.
valueany
The value to set for the field. Can be string, number, or boolean.
doctypestringObligatorio
The DocType name (e.g., 'ToDo', 'Task', 'User', 'Customer').
fieldnamestringObligatorio
The field name to set (e.g., 'description', 'status').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Submit DocumentERPNEXT_SUBMIT_DOCUMENTAcción

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.

Parámetros de entrada

docstringObligatorio
JSON-stringified complete document object to submit. Must include: (1) 'doctype' field specifying the document type (e.g., 'Journal Entry', 'Sales Invoice'), (2) 'name' field with the document ID, (3) all required fields for the DocType, (4) all child table records if applicable (as arrays of objects), (5) timestamp fields ('modified', 'creation') matching current server state. The document must be in draft state (docstatus=0) and the DocType must be submittable. Fetch the complete document first using GET endpoint to ensure all fields and timestamps are current.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ERPNext documentERPNEXT_UPDATE_DOCUMENTAcción

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.

Parámetros de entrada

namestringObligatorio
The name (ID) of the document you'd like to update. For example EMP001 (of type Employee), or 4klj4teijs (of type ToDo).
fieldsobjectObligatorio
Dictionary of field names and their new values. Only include the fields you want to update - acts like a PATCH request. Field names and types must match the DocType schema.
doctypestringObligatorio
The DocType you'd like to update. For example Customer, Supplier, Employee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not