Get

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

Returns cash journal operations (records in the cash register journal). Use this method to retrieve back-office cash journal entries for an operating cash register over a required date period. The request requires operating_cash_id and a positive Unix date period supplied through date filters, start_date must be earlier than end_date, the current user must have cash journal select permission 372 and limit plus offset page the result. The response returns a paged list of cash operation records with translated operation type, payment type, session and document UUIDs, amount, comment, user, next_offset and total. Business errors such as missing body, missing operating_cash_id, missing or invalid period, denied access, database failures or translation lookup errors are returned as HTTP 200 ErrorResult.

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 Period end as Unix time in seconds. Required filter field.
operating_cash_id int Operating cash register ID. Required filter field.
start_date int Period start as Unix time in seconds. Required filter field.

Request Example

{
  "filters": [
    {
      "field": "operating_cash_id",
      "operator": "Equal",
      "value": "12"
    },
    {
      "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
}