Skip to main content
GET
/
analytics
/
dashboards
/
payment-breakdown
/
payment-breakdown
Get Payment Breakdown
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/payment-breakdown/payment-breakdown \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "createdDate": "2023-11-07T05:31:56Z",
      "patient": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "type": "PATIENT",
        "locationId": "<string>",
        "dateOfBirth": "2023-12-25",
        "onSchedulingBlacklist": true
      },
      "paymentMedium": "<string>",
      "amount": 123,
      "fee": 123,
      "netAmount": 123,
      "status": "<string>",
      "paymentId": "<string>",
      "location": "<string>",
      "paymentMethodType": "<string>",
      "paymentMethodDetails": "<string>",
      "comment": "<string>"
    }
  ],
  "total": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

group_by
enum<string> | null
Available options:
location,
provider,
payment_medium,
created_date,
week,
month
group_key
string | null
timezone
string
required

Timezone for date grouping (e.g., 'America/New_York', 'UTC')

sort_by
string
default:created_date
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
start_date
string | null
end_date
string | null
location_ids
string[] | null
location_names
string[] | null
payment_mediums
string[] | null
payment_statuses
string[] | null
min_amount
number | null
max_amount
number | null
comment
string | null
location
string | null
provider
string | null
payment_medium
string | null
created_date
string | null
week
string | null
month
string | null
page
integer | null
per_page
integer | null

Response

Successful Response

data
PaymentBreakdownItem · object[]
required
total
integer
required