Skip to content
PharmaFlow Knowledgebase
Esc
↑↓navigate↵open⌘Jpreview

Read a session Z-report

Any signed in user. Returns session totals, break minutes, and takings by payment method. It reads whether the session is open or closed, and an id that matches no session is refused.

GET/api/v1/sessions/{sessionId}/z-report
Authorization
AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters
sessionIdstringrequired

The cash session id.

Responses
200

The session's Z-report

session_idstringrequired
pharmacist_namestring | nullrequired
branch_namestring | nullrequired
opening_floatstringrequired
statusstringrequired
break_minutesintegerrequired
min -9007199254740991 · max 9007199254740991
opened_atstringrequired
closed_atstring | nullrequired
total_salesintegerrequired
min -9007199254740991 · max 9007199254740991
total_revenuestringrequired
total_vatstringrequired
payment_breakdownobject[]required
Show properties
Array of object
methodstringrequired
countintegerrequired
min -9007199254740991 · max 9007199254740991
totalstringrequired
401

Not authenticated

detailstringrequired
404

Session not found

detailstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'http://localhost:8000/api/v1/sessions/string/z-report' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "session_id": "string",
  "pharmacist_name": "string",
  "branch_name": "string",
  "opening_float": "string",
  "status": "string",
  "break_minutes": -9007199254740991,
  "opened_at": "string",
  "closed_at": "string",
  "total_sales": -9007199254740991,
  "total_revenue": "string",
  "total_vat": "string",
  "payment_breakdown": [
    {
      "method": "string",
      "count": -9007199254740991,
      "total": "string"
    }
  ]
}