---
title: "Get Payment Transactions By Filter"
method: POST
path: "/payments/transactions/filter"
---

# Get Payment Transactions By Filter

`POST /payments/transactions/filter`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/payments/transactions/filter`
- Auth: API key in header `x-api-key`

Rule-engine-based list endpoint — an alternative to the simple `filter.*` query params on the plain list endpoint, for building complex AND/OR filter conditions. `job_uid` is special-cased: it has no direct field on the transaction document, so it's pulled out of `filter_rules` before the rule engine runs and resolved via Job → Invoice/Estimate → `action_module`/`action_uid` lookup instead.

## Request body

- object
  - `page` integer
  - `limit` integer
  - `sort` 'ASC' | 'DESC'
  - `filter_rules` object[]: Rule-engine filter conditions, ANDed/ORed per filter_rule_operator. Get the exact field key enum from this module's Meta Filter endpoint.
    - `key` 'created_at' | 'amount' | 'payment_mode_uid' | 'action_module' | 'customer_uid' | 'organization_uid' | 'type' | 'source' | 'status' | 'transaction_id' | 'job_uid'
    - `operator` 'EQUAL_TO' | 'NOT_EQUAL_TO' | 'CONTAINS' | 'NOT_CONTAINS' | 'GREATER_THAN' | 'LESS_THAN' | 'BETWEEN' | 'IS_EMPTY' | 'IS_NOT_EMPTY'
    - `value` unknown
    - `type` 'default_field' | 'nested_field' | 'custom_field'
  - `filter_rule_operator` 'AND' | 'OR'
  - `sort_by` 'created_at' | 'updated_at'

## Response `200`

200

- object
  - `type` 'success'
  - `data` object[]: Payment transaction documents — same shape as GET /payments/transactions.
  - `total_records` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/payments/transactions/filter/post.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)