GetAmountDetails

[POST] .../v1/pos/cashoperation/getamountdetails

Returns cash register cash details. Use this method to retrieve cash balance details for the current accepted POS cash register over a selected period. The request requires a period supplied either by start_date/end_date fields or by date filters and returns result with current_amount, start_amount, income, outcome and end_amount values. The method checks the current request user, requires cash operation read permission and requires an accepted cash register; missing body, invalid period, denied permission, missing accepted cash register and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
date int
end_date int Required period end as Unix time in seconds. The value must be positive and later than start_date.
start_date int Required period start as Unix time in seconds. The value must be positive and earlier than end_date.

Request Example

{
  "filters": [
    {
      "Field": "date",
      "Operator": "GreaterOrEqual",
      "Value": "1714521600"
    },
    {
      "Field": "date",
      "Operator": "LessOrEqual",
      "Value": "1714607999"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result CashAmountDetails Result object.

Response Example

{
  "ok": true,
  "result": {
    "current_amount": 450000.000,
    "start_amount": 300000.000,
    "income": 200000.000,
    "outcome": 50000.000,
    "end_amount": 450000.000
  }
}