Resources
API resource map
Read and write operations for business entities.
| Entity | Base path | Create | Update | Delete |
|---|---|---|---|---|
| Customers | /customers | Yes | Yes | Soft delete and restore |
| Suppliers | /suppliers | Yes | Yes | Soft delete and restore |
| Leads | /leads | Yes | Yes, with a status route | Before conversion to customer |
| Lead activities | /leads/{id}/activities | Yes | Yes | With lead deletion |
| Products and services | /products | Yes | Yes | Soft delete and restore |
| Raw materials and recipes | /raw-materials and product component fields | Yes | Yes | Subject to recipe usage |
| Inventory | /inventory | Through item creation | Quantity and settings | Through item deletion |
| Inventory movements | /inventory/movements | Through a document | Correction through a document | No historical deletion |
| Sales and purchase documents | /documents | Yes | Handling note; close or reopen | Through a correcting document |
| Document drafts | /document-drafts | Yes | Yes | Soft delete |
| Receipt payments | /payments | As part of a document | Through a correcting document | No deletion of recorded payments |
| Expenses and lines | /expenses | Yes | Yes, with revision | Draft deletion or voiding |
| Expense categories | /expense-categories | Yes | Yes, with revision | Soft delete |
| Expense payments and allocations | /expense-payments | Yes | Reverse and record a new payment | No deletion of recorded payments |
| Tasks | /tasks | Yes | Yes | Soft delete |
| Tags | /tags | Yes | Yes | Soft delete |
| Sales agents and bank accounts | /sales-agents, /business/bank-accounts | In business settings | In business settings | In business settings |
Each resource group has a detailed page. The reference lists every field and exact route; the write guide provides a complete example, permissions, pagination, and idempotency rules.
The system model map also covers relationships, supporting entities, and internal records that are not exposed for public writes.