Central Cashy Backend API Catalog¶
This technical reference catalogs the central Cashy backend API endpoints utilized by Cashy-Hub to exchange data, compute live calculations, synchronize customer records, and record store operations.
All front-desk actions in Cashy-Hub communicate directly with the central Cashy API gateway, ensuring immediate synchronization between retail counter operations and the central business database.
| Endpoint | Method | Functional Domain | Purpose |
|---|---|---|---|
/api/login |
POST |
User Authentication | Authenticate operator credentials against central directory. |
/api/company/names |
GET |
Organization & Branches | Retrieve registered corporate operating entities. |
/api/shop/names |
GET |
Organization & Branches | Retrieve authorized store branches and locations. |
/api/deals/all |
POST |
Deals & Contracts | Paginated search, sorting, and filtering of all contracts. |
/api/deals/create |
POST |
Deals & Contracts | Register a newly created pawn or purchase deal contract. |
/api/deals/:id |
GET |
Deals & Contracts | Fetch complete deal contract, metadata, and collateral items. |
/api/deals/:id/notes |
POST |
Deals & Contracts | Add operational or audit note to deal timeline. |
/api/deals/:id/payout-data |
PATCH |
Deals & Contracts | Update disbursement method, bank IBAN, or PayPal address. |
/api/deals/manual-calculation |
POST |
Live Pricing & Calculations | Compute real-time statutory fees and payback for general items. |
/api/deals/car |
POST |
Live Pricing & Calculations | Query external vehicle valuation engine via chassis number (VIN). |
/api/deals/car-calculation |
POST |
Live Pricing & Calculations | Compute vehicle loan LTV, storage fees, and statutory interest. |
/api/deals/:id/preview-calculation |
POST |
Live Pricing & Calculations | Preview payback or extension fees prior to counter settlement. |
/api/customers/search |
GET |
Customer Directory & KYC | Real-time customer search for returning borrower lookup. |
/api/customers/all |
POST |
Customer Directory & KYC | Paginated directory of registered customers with KYC profiles. |
/api/columns |
GET |
Store Pipeline & Kanban | Retrieve active Kanban pipeline stage columns. |
/api/columns/:id |
POST/DELETE |
Store Pipeline & Kanban | Create, reorder, or remove custom store Kanban columns. |
/api/tasks |
POST |
Store Pipeline & Kanban | Create operational reminder task card on Kanban column. |
/api/cashbook/cash-flows |
POST |
Store Cash Accounting | Retrieve filtered branch cash receipts, payouts, and transfers. |
/api/item-categories |
POST |
Dynamic Forms & Builder | Fetch hierarchical category taxonomy tree. |
/api/deal-wizard/builders |
GET |
Dynamic Forms & Builder | List dynamic wizard templates across merchandise categories. |
/api/deal-wizard/builders/:id |
GET/DELETE |
Dynamic Forms & Builder | Retrieve or remove a dynamic wizard form template. |
/api/deal-checkpoints |
POST |
Checkpoints & Workflow | Paginated list of business checkpoints mapped to deal statuses. |
/api/deal-checkpoints/create |
POST |
Checkpoints & Workflow | Map new business checkpoint to central deal status triggers. |