Skip to main content
GET
/
billing
/
tips
/
export
/
detailed
Get Detailed Tip Export Data
curl --request GET \
  --url https://api.decodahealth.com/billing/tips/export/detailed \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "tipId": "<string>",
    "providerId": "<string>",
    "providerName": "<string>",
    "providerEmail": "<string>",
    "tipAmount": 123,
    "patientName": "<string>",
    "chargeId": "<string>",
    "locationName": "<string>",
    "tipDate": "<string>",
    "startDate": "<string>",
    "endDate": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
start_date
string<date>
required

Start date for tip export (YYYY-MM-DD)

​
end_date
string<date>
required

End date for tip export (YYYY-MM-DD)

​
timezone
string
required

Timezone for date range

​
location_ids
string[] | null

Optional location IDs to filter tips by

Response

Successful Response

​
tipId
string
required

Tip ID

​
providerId
string
required

Provider ID

​
providerName
string
required

Provider full name

​
providerEmail
string
required

Provider email

​
tipAmount
integer
required

Individual tip amount in cents

​
patientName
string
required

Patient name

​
chargeId
string
required

Charge ID

​
locationName
string
required

Location name

​
tipDate
string
required

Date when tip was created

​
startDate
string
required

Export period start date

​
endDate
string
required

Export period end date