WHwhispa
accounts

Collections Summary

Money outcomes of the filtered working set (admin only): original / outstanding / collected totals and a per-collection-stage breakdown.

Takes the same filter params as /search and evaluates the same predicate, so the summary cards always describe exactly the rows in the table beneath them — including a single campaign via campaign_id.

get/accounts/collections-summary

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Query parameters

demo_market'au' | 'us' nullable
qstring nullable

Free-text search (case-insensitive) across display name, account number, email, external id and phone.

statusstring[] nullable

Provider status values to include (case-insensitive, repeatable). Omit for every status.

campaign_idstring uuid nullable

Only accounts with a membership in this campaign.

campaign_assignment'assigned' | 'unassigned' | 'multiple' | 'review' nullable

Filter by current campaign assignment count, or 'review' for accounts waiting on an operator decision.

timezone_status'unknown' | 'manual' nullable

'unknown': no timezone, so the gate will not call the account. 'manual': an operator set the timezone.

called'account' | 'customer' | 'never' nullable

'account': a call is linked to this account. 'customer': a call is linked to this account or another account of the same customer. 'never': neither.

min_balancenumber nullable

Inclusive lower bound on outstanding amount.

max_balancenumber nullable

Inclusive upper bound on outstanding amount.

min_arrearsnumber nullable

Inclusive lower bound on arrears amount.

max_arrearsnumber nullable

Inclusive upper bound on arrears amount.

Response

Successful Response

total_accountsinteger required
original_balance_totalnumber nullable

Sum of balances as originally listed, across the filter.

outstanding_totalnumber nullable

Sum of current outstanding balances, across the filter.

amount_paid_totalnumber nullable

Sum of amounts collected to date, across the filter — actual money received, including partial payments under arrangements.

arrangement_accountsinteger required

Accounts with a payment arrangement in place.

arrangement_outstanding_totalnumber nullable

Outstanding balance on arrangement-stage accounts: the money debtors have committed to pay but have not paid yet.

resolved_accountsinteger required

Accounts paid in full or settled (stages paid + settled).

Changes

No recorded changes to this operation across all 1 revision of this API.