erpnext-api-patterns

Document ERPNext/Frappe REST and RPC API integration patterns across v14–v16.

163|53|Updated Jan 14, 2026
One-click install
npx skills add https://github.com/OpenAEC-Foundation/ERPNext_Anthropic_Claude_Development_Skill_Package --skill erpnext-api-patterns
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: erpnext-api-patterns
Source: https://github.com/OpenAEC-Foundation/ERPNext_Anthropic_Claude_Development_Skill_Package/tree/main/skills/source/core/erpnext-api-patterns
Command: npx skills add https://github.com/OpenAEC-Foundation/ERPNext_Anthropic_Claude_Development_Skill_Package --skill erpnext-api-patterns

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

ERPNext/Frappe API integrations are complex due to multiple interfaces (REST, RPC, webhooks) and evolving version patterns across v14–v16; this skill consolidates best practices into a single, reusable guide to streamline secure, scalable API usage.

Core Features & Use Cases

  • REST API patterns for CRUD against docs via /api/resource
  • RPC API usage via /api/method for server-side logic
  • Webhook configuration and security basics for event-driven integrations
  • Authentication approaches (token, session, OAuth2) and rate limiting
  • Error handling, pagination, and security best practices
  • Use cases: external system integration, automated data sync, and programmatic ERPNext control

Quick Start

Set up a test integration using a token-based authentication, and verify access by calling a sample REST endpoint like /api/resource/Customer.

Frequently Asked Questions about erpnext-api-patterns

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate ERPNext REST API requests using tokens?

ERPNext REST API authentication supports token-based, session, and OAuth2 approaches. Token-based authentication is recommended for quick start integrations, allowing you to securely verify access by calling endpoints like /api/resource/Customer.

What is the difference between REST and RPC API endpoints in Frappe?

Frappe REST API endpoints (/api/resource) handle CRUD operations against documents, whereas RPC API endpoints (/api/method) execute server-side logic. Both are standardized across ERPNext versions v14 through v16 for external system integration.

How do I set up webhooks for ERPNext event-driven workflows?

Webhook configuration for ERPNext event-driven workflows involves setting up secure endpoints to receive automated data syncs. Standardized patterns enforce security basics, error handling, and rate limiting to ensure reliable external system integration.

What are the best practices for ERPNext API pagination and error handling?

Best practices for ERPNext API pagination and error handling involve standardizing how external systems process large data syncs. Enforcing these patterns ensures scalable, secure API usage across v14–v16 without hitting rate limits or losing event data.

Does the Frappe API rate limiting apply to both REST and RPC calls?

Frappe API rate limiting applies to both REST and RPC calls to control programmatic ERPNext access. Standardized integration patterns guide developers on implementing proper error handling and security to manage these constraints across versions v14–v16.