Skip to content

MngGetCashierTransactionsByFilter

Returns Cashier transactions using the standard BackOffice table filter format.

The response contains structure, rows, and count.

Access

SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER, SESSION_CRM_MANAGER, SESSION_CRM_ADMIN.

Requires access_crm scope and see_finance permission. Rows are limited to transactions visible through linked customer/account brand and desk scope.

Request Parameters

Name Type Required Description
limit int No Page size, 1..50000; default 100
offset int No Nonnegative pagination offset; default 0
where array No AND filters
orWhere array No OR comparison group in [[field, operator, value], ...] format; at least one condition must match
whereNot array No Negative filters
whereIn array No Include-by-list filters
whereNotIn array No Exclude-by-list filters
whereBetween array No Range filters
whereNotBetween array No Negative range filters
orderBy array No Sort expression

Supported Filter Fields

Field Type
id int
customer_id int
login int
type int
status int
source int
approved_by int
approved_time int64
processed_by int
processed_time int64
provider string
method string
provider_config_id int
currency string
provider_payment_id string
idempotency_key string
created_time int64
attributed_manager_id int
owner_manager_id int
amount number
converted_amount number
comment string
failure_reason string
reject_reason string

Operators by field type:

Type Operators Notes
int, int64 =, !=, >, >=, <, <=, like like matches the decimal digits as a substring
number =, !=, >, >=, <, <= The value may be an integer (100) or a decimal (100.5); equality is exact, prefer whereBetween for amount searches
string =, !=, like Case-insensitive; like matches a substring and ignores % characters

whereIn, whereNotIn, whereBetween and whereNotBetween accept the same fields. A condition on an unsupported field, or with a value of the wrong JSON type (for example a string for amount), never matches.

Response Structure

Field Type Description
structure string[] Ordered column names; all 28 columns are present even for an empty page
rows array[] Values in exactly the same order and length as structure
count int Total number of matching rows visible to the caller before pagination

Customer/account scope filtering occurs before pagination. count is the total visible matching set; offset and limit then select the returned page.

All transaction-record fields are returned. The original 19 declared column positions are preserved; the remaining fields are appended. provider_config_id is now correctly populated at index 6, followed by provider_payment_id at index 7. Clients must map values using structure, not the former malformed 18-value row.

Column Type Description
id int Transaction identifier
customer_id int Linked customer identifier
login int Trading account login
type int Transaction type
provider string Payment provider name
method string Payment method
provider_config_id int Provider configuration identifier; 0 when unset
provider_payment_id string External payment identifier; empty when unset
amount number Amount in transaction currency
currency string Transaction currency
status int Cashier transaction status
failure_reason string Processing failure description
source int Transaction source
approved_by int Approving actor identifier
approved_time int64 Approval Unix timestamp in seconds; 0 when unset
processed_by int Processing actor identifier
processed_time int64 Processing Unix timestamp in seconds; 0 when unset
created_time int64 Creation Unix timestamp in seconds
updated_time int64 Last update Unix timestamp in seconds
account_currency string Account currency
converted_amount number Amount converted to account currency
conversion_rate number Applied currency conversion rate
idempotency_key string Transaction idempotency key
comment string Transaction comment
metadata_json string JSON-encoded metadata, not a nested JSON object; default string is {}
reject_reason string Rejection explanation
attributed_manager_id int Manager the customer was assigned to when the transaction was created
owner_manager_id int Owner: the manager the transaction counts towards in statistics

Empty string fields remain present. Only the fields listed in Supported Filter Fields can be filtered; the remaining response columns (for example metadata_json, account_currency, updated_time) cannot. Sorting supports id, customer_id, login, status, source, approved_by, approved_time, processed_by, processed_time, amount, created_time, attributed_manager_id and owner_manager_id. Only the first orderBy expression is used; desc requests descending order. Without a sort expression the default is id desc.

Rows follow this structure order:

[
  "id",
  "customer_id",
  "login",
  "type",
  "provider",
  "method",
  "provider_config_id",
  "provider_payment_id",
  "amount",
  "currency",
  "status",
  "failure_reason",
  "source",
  "approved_by",
  "approved_time",
  "processed_by",
  "processed_time",
  "created_time",
  "updated_time",
  "account_currency",
  "converted_amount",
  "conversion_rate",
  "idempotency_key",
  "comment",
  "metadata_json",
  "reject_reason",
  "attributed_manager_id",
  "owner_manager_id"
]

Request Example

{
  "command": "MngGetCashierTransactionsByFilter",
  "extID": "1",
  "data": {
    "limit": 50,
    "offset": 0,
    "where": [
      ["status", "=", 1],
      ["provider", "=", "stripe"]
    ],
    "orderBy": [
      ["created_time", "desc"]
    ]
  }
}

Account history with a comment search and an amount range:

{
  "command": "MngGetCashierTransactionsByFilter",
  "extID": "2",
  "data": {
    "limit": 20,
    "offset": 0,
    "where": [
      ["login", "=", 2000009],
      ["comment", "like", "%deposit%"]
    ],
    "whereBetween": [
      ["amount", [100, 500.5]]
    ],
    "orderBy": [
      ["amount", "desc"]
    ]
  }
}

Response Example

{
  "structure": [
    "id",
    "customer_id",
    "login",
    "type",
    "provider",
    "method",
    "provider_config_id",
    "provider_payment_id",
    "amount",
    "currency",
    "status",
    "failure_reason",
    "source",
    "approved_by",
    "approved_time",
    "processed_by",
    "processed_time",
    "created_time",
    "updated_time",
    "account_currency",
    "converted_amount",
    "conversion_rate",
    "idempotency_key",
    "comment",
    "metadata_json",
    "reject_reason",
    "attributed_manager_id",
    "owner_manager_id"
  ],
  "rows": [
    [
      15,
      5,
      2000009,
      0,
      "stripe",
      "card",
      7,
      "pi_123",
      250.0,
      "USD",
      1,
      "",
      0,
      0,
      0,
      0,
      0,
      1779270000,
      1779270000,
      "USD",
      250.0,
      1.0,
      "deposit-15",
      "CRM deposit",
      "{\"reference\":\"ref-15\"}",
      "",
      12,
      12
    ]
  ],
  "count": 1
}