Get

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

Returns cash journal operations (records in the cash register journal). Use this method to retrieve cash journal operations for the current accepted POS cash register during shift review, reconciliation and support diagnostics. The request requires a period supplied either by start_date/end_date fields or by date filters, supports limit and offset paging and returns result, next_offset and total. 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.
limit Int32 Optional Number of result items to return. If omitted or greater than the configured query limit, the server query_limit setting is used.
offset Int32 Optional Offset from the beginning of the result set. Negative values are treated as zero.

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"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of CashOperation Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 7001,
      "date": 1714550400,
      "type": {
        "id": 1,
        "name": "Sale"
      },
      "payment_type_id": 2,
      "payment_type_name": "Cash",
      "session_uuid": "7a4c7d3f-2d1b-4d0c-a2f1-3c8a8f6f0001",
      "document_uuid": "1f1b6c9b-5fd8-4f66-bb34-95e89f5f8d1a",
      "operating_cash_id": 12,
      "value": 150000.000,
      "description": "Retail sale payment",
      "user_id": 5,
      "user_full_name": "Anna Smith",
      "last_update": 1714553600
    }
  ],
  "next_offset": 0,
  "total": 1
}