API Reference
Complete REST API documentation for the Overplane business platform. All endpoints follow consistent CRUD conventions with module-scoped routing.
/api Overview
API Convention
All operations are REST endpoints at /api/{module}/{entity}/{operation}.
System columns on all non-child entities: id, created_at, updated_at, created_by, updated_by.
Authentication
All API requests require a valid session or API key. Pass your API key via the Authorization header:
Modules
Browse the API by module. Each module groups related entities and endpoints.
Account, Account Category, Account Closing Balance, Accounting Dimension , +121 more
Asset, Asset Activity, Asset Capitalization, Asset Category , +13 more
Buying Settings, Purchase Order, Request For Quotation, Supplier , +8 more
Address, Contact, Country, Currency , +3 more
Appointment, Appointment Booking Settings, Campaign, Competitor , +27 more
Maintenance Schedule, Maintenance Visit
Blanket Order, BOM, BOM Creator, BOM Update Log , +28 more
Activity Cost, Activity Type, Project, Projects Settings , +8 more
Non Conformance, Quality Action, Quality Feedback, Quality Feedback Template , +4 more
Authorization Control, Authorization Rule, Branch, Brand , +26 more
Signing Attachment, Signing Audit Log, Signing Document, Signing Document Data , +6 more
Batch, Bin, Customs Tariff Number, Delivery Note , +48 more
Subcontracting BOM, Subcontracting Inward Order, Subcontracting Order, Subcontracting Receipt
Issue, Issue Priority, Issue Type, Warranty Claim