Read the branch stock count sheet

Any counting role. Returns every active medicine with the quantity the branch holds. Scoped to the caller’s branch, the count and variance come back null for the till to fill in.

GET/api/v1/stockcount

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Responses

200

The count sheet for the caller's branch

branch_idstringrequired

itemsobject[]required

Show properties

Array of object

idstringrequired

medicine_idstringrequired

namestringrequired

barcodestringrequired

categorystringrequired

db_quantitynumberrequired

low_stock_thresholdnumberrequired

branch_quantitynumberrequired

system_quantitynumberrequired

batch_countintegerrequired

min -9007199254740991 · max 9007199254740991

counted_quantitynullrequired

variancenullrequired

401

Not authenticated

detailstringrequired

403

Access forbidden for the caller's role

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Request

curl -X GET 'http://localhost:8000/api/v1/stockcount' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/stockcount", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/stockcount",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "branch_id": "string",
  "items": [
    {
      "id": "string",
      "medicine_id": "string",
      "name": "string",
      "barcode": "string",
      "category": "string",
      "db_quantity": 0,
      "low_stock_threshold": 0,
      "branch_quantity": 0,
      "system_quantity": 0,
      "batch_count": -9007199254740991,
      "counted_quantity": null,
      "variance": null
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}