ZUzuper

Get Commissions 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. Unlike other modules, invalid sort_by/sort values are not rejected — they silently fall back to the defaults (created_at / DESC) instead of returning a 400. filter_rules is only honored when the request opts into the rule-engine listing mode; without filter_rules, the endpoint falls back to legacy filter.job_uid / filter.project_uid / filter.user_uid query-style params on the same body.

post/commissions/filter

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/commissions/filter
  • Auth
    API key in header x-api-key

Request body

pageinteger
limitinteger
sort'ASC' | 'DESC'
filter_rule_operator'AND' | 'OR'
sort_by'paid_payout' | 'commission_date' | 'commission_amount' | 'created_at'
filter.job_uidstring
filter.project_uidstring
filter.user_uidstring

Response

200

type'success'
dataobject[]

Commission documents — same shape as GET /commissions.

total_recordsinteger

Changes