Declare the counted cash

Any signed in user. Files cash counted at the till against the session’s expected amount. It reads as overage, shortage, or balanced, and a caller with no session cannot declare.

POST/api/v1/sessions/tender

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Request body

requiredapplication/json

declared_cashnumberrequired

notesstring

default: ""

Responses

200

The filed declaration

idstringrequired

session_idstringrequired

declared_cashstringrequired

expected_cashstringrequired

differencestringrequired

statusstringrequired

declared_atstringrequired

400

Invalid request body: a declared cash amount is required

detailstringrequired

401

Not authenticated

detailstringrequired

404

No active session

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

Bodyapplication/json

declared_cashnumber*notesstring

Request

curl -X POST 'http://localhost:8000/api/v1/sessions/tender' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "declared_cash": 0,
  "notes": ""
}'

const response = await fetch("http://localhost:8000/api/v1/sessions/tender", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"declared_cash\": 0,\n  \"notes\": \"\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/sessions/tender",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"declared_cash\": 0,\n  \"notes\": \"\"\n}",
)

Response

{
  "id": "string",
  "session_id": "string",
  "declared_cash": "string",
  "expected_cash": "string",
  "difference": "string",
  "status": "string",
  "declared_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}