Payment KPIs

Report the money actually received, rather than the amounts invoiced. Payment KPIs group received payments by method, dealer and time period, giving you the collection side of your cash flow picture.

Reversed payments are excluded by default. Use the includeReversed or reversed filters to bring them in.

Available KPIs

Payment Summary

Returns overall payment totals.

Endpoint

GET /backend/kpi/payments/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "payment_customer_count": 2350,
    "payment_count": 3105,
    "payment_amount": 84250.000
  }
]

Payments by Method

Groups payments by how they were made: Direct Debit, card, cheque, bank transfer and so on.

Endpoint

GET /backend/kpi/payments/byMethod/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/byMethod/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "payment_method": "Direct Debit",
    "payment_customer_count": 1850,
    "payment_count": 2250,
    "payment_amount": 61500.000
  },
  {
    "payment_method": "Credit Card",
    "payment_customer_count": 420,
    "payment_count": 650,
    "payment_amount": 17250.000
  },
  {
    "payment_method": "Cheque",
    "payment_customer_count": 80,
    "payment_count": 205,
    "payment_amount": 5500.000
  }
]

Payments by Dealer

Groups payments by dealer for segmentation and comparison.

Endpoint

GET /backend/kpi/payments/byDealer/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/byDealer/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Payments by Month

Tracks amounts received over time.

Endpoint

GET /backend/kpi/payments/byMonth/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/byMonth/?minDate=2026-01-01" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "payment_month": "2026-01",
    "payment_customer_count": 2280,
    "payment_count": 2960,
    "payment_amount": 81300.000
  },
  {
    "payment_month": "2026-02",
    "payment_customer_count": 2350,
    "payment_count": 3105,
    "payment_amount": 84250.000
  }
]

Flexible Grouping

Combine the payment dimensions (period, method, dealer, currency) with groupBy and pick an interval:

# Amounts received by quarter and payment method
curl -X GET "https://companyname.callstats.net/backend/kpi/payments/?groupBy=period,method&interval=quarter" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

The currency dimension is only available on platforms with the multi-currency module active. With groupBy, the period column is named payment_period rather than payment_month.

Filtering Options

Refine your results using these filter parameters:

Parameter	Type	Description	Example
minDate	date	Payments dated on or after	minDate=2026-01-01
maxDate	date	Payments dated on or before	maxDate=2026-01-31
reversed	boolean	Include only reversed payments	reversed=true
includeReversed	boolean	Include reversed payments as well (excluded by default)	includeReversed=true
minReversedDate	date	Payments reversed on or after	minReversedDate=2026-01-01
maxReversedDate	date	Payments reversed on or before	maxReversedDate=2026-01-31
paymentMethod	string	Filter by payment method name	paymentMethod=Direct Debit
paymentMethodID	integer list	Filter by one or more payment method IDs	paymentMethodID=2,3
dealer	string	Filter by dealer name	dealer=Direct
dealerCode	string	Filter by specific dealer code	dealerCode=DEALER01
currencyID	integer list	Filter by currency	currencyID=1

Reversed payments are excluded unless you ask for them. Supplying minReversedDate or maxReversedDate without reversed or includeReversed filters to reversed payments automatically, since that is the only thing a reversal date can usefully narrow.

Filter Examples

This Month’s Receipts

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/byMethod/?minDate=2026-07-01&maxDate=2026-07-31" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Recent Reversals

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/?reversed=true&minReversedDate=2026-06-01" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Use Cases

Cash Flow Reporting

Compare invoiced against received amounts:

# Amounts received by month
curl -X GET "https://companyname.callstats.net/backend/kpi/payments/byMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Amounts invoiced by month, for comparison
curl -X GET "https://companyname.callstats.net/backend/kpi/invoices/byMonth/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Payment Method Mix

Watch how customers pay, and spot shifts away from Direct Debit:

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/?groupBy=period,method&interval=quarter" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Reversal Monitoring

Track reversed payments as an early warning of disputes or failures:

curl -X GET "https://companyname.callstats.net/backend/kpi/payments/byMonth/?reversed=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Best Practices

1. Pair with invoice KPIs - Received versus invoiced amounts together show your true collection rate
2. Watch the method mix - A drift from Direct Debit towards manual methods usually means more chasing later
3. Keep an eye on reversals - A rising reversal count is worth investigating before it becomes a debt problem
4. Use date filters - Bound your queries to the periods you are reporting on

Related KPIs

• Invoice KPIs - The amounts billed that these payments settle
• Collection KPIs - Direct Debit collection performance in detail
• Debt Ageing KPIs - What remains outstanding, by age