Skip to content
Verbatik
GuidesAPI reference

Integrations

ERPNext

Connect ERPNext, obtain the required access and configure permitted actions.

The API adapter is implemented. Validate your own account and authorized actions before routing production calls.

Before you start

Connect the account belonging to this business and workspace. Vendor subscriptions, API limits and role permissions still apply.

API: Frappe REST resource API used by ERPNext

Authentication: ERPNext user API key plus API secret; customer-managed OAuth Bearer token also accepted

Get access and connect

  1. Use a publicly reachable HTTPS ERPNext/Frappe site, such as a site at https://frappecloud.com/, or a customer-owned domain. The hosted integration cannot reach a private LAN-only ERP installation.
  2. Create a dedicated ERPNext integration user and assign minimum roles for Lead, Customer, Contact, Opportunity, ToDo, Communication and Comment where the selected actions require them.
  3. In the ERPNext User record's API Access section generate the user's API key and API secret. Copy both into Verbatik's apiKey and apiSecret credential fields; set instanceUrl to the site's root HTTPS origin and authMode api-key.
  4. Run Test connection, which calls frappe.auth.get_logged_user. Use known ERPNext document names for linked records and include company defaults and tenant-required fields in generic creates.
  5. Configure record, follow-up or call-log actions. Call summaries create linked Phone communications; internal notes create unpublished Comment documents.
  6. Optional authMode oauth accepts an access token from a customer-managed Frappe OAuth client. This adapter does not renew that optional OAuth token; use API-key mode for unattended operation or manage OAuth renewal externally.

Account requirements

  • The API user needs read/create/write permissions for the selected DocTypes and access to the referenced documents. Assigning ToDos or writing internal comments may require additional role permissions.
  • The standard resource API is part of Frappe, but managed hosting plans, customer customizations, required fields and security configuration still apply.
  • Only a root HTTPS origin is accepted; IP literals, localhost/private hosts, embedded credentials and custom ports are rejected. Public DNS is checked again by the shared transport.
  • API credentials belong to the customer installation; Verbatik does not create an ERPNext account or bypass its role and document permissions.

Permissions

  • API-key mode follows ERPNext user roles and DocType permissions
  • all (Frappe OAuth scope, if optional OAuth mode is used)

Grant the subset needed for the actions you enable. API scopes do not override the connected user’s record permissions or vendor validation rules.

Connection fields

  • apiKey — ERPNext API key (optional). Secret fields are saved as workspace credentials.
  • apiSecret — ERPNext API secret (optional). Secret fields are saved as workspace credentials.
  • accessToken — OAuth access token (OAuth mode only) (optional). Secret fields are saved as workspace credentials.
  • instanceUrl — ERPNext HTTPS origin (required).
  • authMode — Authentication mode: api-key or oauth (optional).

Available actions

  • test_connection — Read · available for after-call automation. Read account or schema metadata to verify credentials without creating records.
  • find_records — Read · available for after-call automation. Read records of a supported ERPNext DocType using exact-match filters.
  • get_record — Read · available for after-call automation. Read a known ERPNext document by its exact name.
  • create_record — Write · available for after-call automation. Create a supported ERPNext document. Provide all tenant-required fields and known linked record names.
  • update_record — Write · available for after-call automation. Update fields on an existing supported ERPNext document.
  • create_task — Write · available for after-call automation. Create an ERPNext ToDo, optionally assigned and linked to a CRM document.
  • log_call — Write · available for after-call automation. Record a completed phone communication on a CRM document. Does not place a phone call.
  • add_note — Write · available for after-call automation. Create an unpublished internal comment linked to an ERPNext CRM document.

Verify before going live

Run Test connection and one read action against a known permitted record. Then test each intended write in an authorized sandbox. Check the provider’s own record and the Verbatik receipt. Publish the agent after assigning its tools. If a write has an unknown outcome, reconcile it with the vendor before trying again.

Vendor documentation

Verbatik documentation · Updated November 5, 2026
Previous

Bitrix24

Next

Google Calendar