cURL
curl --request GET \ --url https://api.decodahealth.com/analytics/dashboards/payment-plans/payment-plans-grouped \ --header 'API-KEY: <api-key>' \ --header 'TENANT: <tenant>'
{ "groups": [ { "key": "<string>", "label": "<string>", "count": 123, "summary": { "planCount": 0, "totalPlanValue": 0, "totalAmountPaid": 0, "totalAmountRemaining": 0, "activeCount": 0, "completedCount": 0, "failedCount": 0, "cancelledCount": 0 }, "rows": [ { "paymentPlanId": "<string>", "patientId": "<string>", "patientFirstName": "<string>", "patientLastName": "<string>", "planTotal": 123, "amountPaid": 123, "amountRemaining": 123, "installmentsCompleted": 123, "installmentsTotal": 123, "frequency": "<string>", "status": "<string>", "nextPaymentDate": "2023-12-25", "createdDate": "2023-11-07T05:31:56Z", "locationId": "<string>", "locationName": "<string>", "paymentMethodLast4": "<string>", "paymentMethodBrand": "<string>", "plannedPayments": [ { "id": "<string>", "amount": 123, "paymentDate": "2023-12-25", "status": "<string>" } ] } ] } ], "grandTotals": { "planCount": 0, "totalPlanValue": 0, "totalAmountPaid": 0, "totalAmountRemaining": 0, "activeCount": 0, "completedCount": 0, "failedCount": 0, "cancelledCount": 0 }, "totalCount": 123 }
Get payment plan analytics data with optional grouping.
Group options:
The tenant you are making this request on behalf of
Your api key
status
location
frequency
none
Successful Response
Show child attributes