ZUzuper

Get Payment Transactions By Filter

Changed on

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.

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

Request body

pageinteger
limitinteger
sort'ASC' | 'DESC'
filter_rule_operator'AND' | 'OR'
sort_by'created_at' | 'updated_at'

Response

200

type'success'
dataobject[]

Payment transaction documents — same shape as GET /payments/transactions.

total_recordsinteger

Changes