API Design

All APIs should be versioned under /api/v1.

8.1 Auth

• POST /auth/login
• POST /auth/logout
• GET /auth/me

8.2 People

• GET /people
• POST /people
• GET /people/:id
• PUT /people/:id
• GET /people/:id/journeys

8.3 Collaborator Journeys

• GET /collaborators
• POST /collaborators
• GET /collaborators/:id
• PUT /collaborators/:id
• POST /collaborators/:id/extend
• POST /collaborators/:id/finish
• GET /collaborators/:id/projection

8.4 Reference Data

• GET /reference-data/:type
• POST /reference-data/:type
• PUT /reference-data/:type/:id

8.5 Work Periods and Planning

• GET /work-periods
• POST /work-periods
• GET /work-periods/:id
• POST /work-periods/:id/seed-from-previous
• GET /work-periods/:id/plan
• PUT /work-periods/:id/plan-items/:planItemId
• POST /work-periods/:id/inform
• POST /work-periods/:id/accrue

8.6 Mine Production

• GET /mine-productions
• POST /mine-productions
• PUT /mine-productions/:id

8.7 Gold Prices

• GET /gold-prices
• POST /gold-prices
• PUT /gold-prices/:id
• GET /gold-prices/latest

8.8 Price List

• GET /price-list
• POST /price-list
• PUT /price-list/:id
• GET /price-list/:id/price-preview?currency=BRL|GOLD_GRAMS

8.9 Expenses

• GET /expenses
• POST /expenses
• GET /expenses/:id
• POST /expenses/:id/revert

8.10 Ledger / Current Account

• GET /current-accounts/:collaboratorId/summary
• GET /current-accounts/:collaboratorId/entries
• GET /current-accounts/:collaboratorId/entries?currency=BRL
• GET /current-accounts/:collaboratorId/entries?currency=GOLD_GRAMS
• POST /current-accounts/entries/:id/revert
• POST /current-accounts/:collaboratorId/zero-gold
• POST /current-accounts/:collaboratorId/close

8.11 Reports

• GET /reports/dashboard
• GET /reports/collaborator-balances
• GET /reports/journeys-ending-soon
• GET /reports/pending-production-accruals
• GET /reports/mercantile-sales