Get Daily External Settlements

Get daily external settlement summaries by type for a location within a date range.

External settlements are payments settled outside the system (e.g., CARE_CREDIT, CHECK). This excludes:

get/billing/cash-balance/daily-external-settlements

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/billing/cash-balance/daily-external-settlements/get.ts
A function with typed inputs. Its response is checked against the schema.

location_idstring required

The location ID to fetch settlements for

start_datestring date-time nullable

Start date for the range (inclusive)

end_datestring date-time nullable

End date for the range (inclusive)

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

datestring date-time required

The date of the settlements

totalSettlementsinteger required

Total number of different settlement types

totalAmountinteger required

Total amount across all settlement types in cents

tipCountinteger

Total number of tips received on this day

totalTipAmountinteger

Total tip amount in cents

No recorded changes to this operation across all 2 revisions of this API.