Failed payments summary
The /reports/cashflow-failed-payments-summary endpoint returns failed payment totals for month-to-date and year-to-date periods with comparisons to the prior equivalent periods, including recovery rates and failure percentages.
GET /reports/cashflow-failed-payments-summary
Query parameters
| Parameter | Type | Description |
|---|
baseCurrency | string | Target currency for conversion. Defaults to account base currency. |
fix_fx | boolean | Use fixed exchange rates. |
region | string | Filter by region or country codes (space-separated). |
currency | string | Filter by currency codes (space-separated). |
plan | string | Filter by plan group IDs (space-separated). |
data_source | string | Filter by data source ID (space-separated). |
Example response
200 OK
{
"currency": "usd",
"summary": {
"mtd_still_unpaid": 3000,
"prev_mtd_still_unpaid": 4500,
"ytd_still_unpaid": 15000,
"prev_ytd_still_unpaid": 18000,
"mtd_recovery_rate": 75.0,
"prev_mtd_recovery_rate": 68.0,
"ytd_recovery_rate": 72.5,
"prev_ytd_recovery_rate": 65.0,
"mtd_failed_pct": 3.2,
"prev_mtd_failed_pct": 4.1,
"ytd_failed_pct": 3.5,
"prev_ytd_failed_pct": 4.0,
"mtd_failed_invoices": 8,
"prev_mtd_failed_invoices": 12,
"ytd_failed_invoices": 45,
"prev_ytd_failed_invoices": 55,
"mtd_still_unpaid_change_pct": -33.3,
"ytd_still_unpaid_change_pct": -16.7,
"mtd_recovery_rate_change": 7.0,
"ytd_recovery_rate_change": 7.5,
"mtd_failed_pct_change": -0.9,
"ytd_failed_pct_change": -0.5
}
}
Response fields
| Field | Type | Description |
|---|
mtd_still_unpaid | number | Month-to-date unpaid amount (cents) |
prev_mtd_still_unpaid | number | Previous month equivalent (cents) |
ytd_still_unpaid | number | Year-to-date unpaid amount (cents) |
prev_ytd_still_unpaid | number | Previous year equivalent (cents) |
mtd_recovery_rate | float | Month-to-date recovery rate (%) |
prev_mtd_recovery_rate | float | Previous month recovery rate (%) |
ytd_recovery_rate | float | Year-to-date recovery rate (%) |
prev_ytd_recovery_rate | float | Previous year recovery rate (%) |
mtd_failed_pct | float | Month-to-date failure percentage |
prev_mtd_failed_pct | float | Previous month failure percentage |
ytd_failed_pct | float | Year-to-date failure percentage |
prev_ytd_failed_pct | float | Previous year failure percentage |
mtd_failed_invoices | integer | Month-to-date failed invoice count |
prev_mtd_failed_invoices | integer | Previous month failed invoice count |
ytd_failed_invoices | integer | Year-to-date failed invoice count |
prev_ytd_failed_invoices | integer | Previous year failed invoice count |
*_change_pct | float | Percentage change vs prior period |
*_change | float | Absolute change vs prior period |
