Plan Utilisation Journey
A member reviews their insurance plan usage: charges incurred, invoices issued, payments made, ledger entries, and explanation-of-benefits documents.
Sequence Diagram
API Reference
| Step | Service | Method | Path | Auth | Response |
|---|---|---|---|---|---|
| Get token | Keycloak | POST | /realms/olly/protocol/openid-connect/token | None | access_token |
| List charges | billing | GET | /charges/list | Member JWT | 200 {charges:[...]} |
| List invoices | billing | GET | /invoices/list | Member JWT | 200 {invoices:[...]} |
| Invoice detail | billing | GET | /invoices/{locator} | Member JWT | 200 {Locator, Status} |
| Ledger | billing | GET | /ledger/list | Member JWT | 200 {entries:[...]} |
| EOB | billing | GET | /eob/{claimLocator} | Member JWT | 200 or 404 |
Notes
- All billing endpoints are read-only in the member journey — write operations (charges, payments, adjustments) are triggered by the claims adjudication engine.
- EOB returns 404 when no EOB exists for the given claim locator — this is expected in a fresh environment.
GET /charges(without/list) also exists and supports filtering;/charges/listis the paginated version.