Skip to main content
GET
/
analytics
/
dashboards
/
provider-earnings
/
provider-payment-medium-payments
Get Provider Payment Medium Payments
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/provider-earnings/provider-payment-medium-payments \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "paymentId": "<string>",
      "amount": 123,
      "tips": 123,
      "refunds": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "chargeId": "<string>",
      "patientId": "<string>",
      "patientFirstName": "<string>",
      "patientLastName": "<string>",
      "locationId": "<string>",
      "locationName": "<string>"
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
payment_medium
string
required
​
timezone
string
required
​
provider_id
string | null
​
start_date
string<date> | null
​
end_date
string<date> | null
​
location_ids
string[] | null
​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:25
Required range: 1 <= x <= 100
​
sort_by
string
default:created_date
​
sort_direction
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful Response

​
data
ProviderPaymentDetail · object[]
required
​
total
integer
required