Skip to main content
GET
/
billing
/
cash-balance
/
daily-external-settlements
Get Daily External Settlements
curl --request GET \
  --url https://api.decodahealth.com/billing/cash-balance/daily-external-settlements \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "date": "2023-11-07T05:31:56Z",
    "settlements": [
      {
        "settlementType": "<string>",
        "totalAmount": 123,
        "transactionCount": 123
      }
    ],
    "totalSettlements": 123,
    "totalAmount": 123,
    "tipCount": 0,
    "totalTipAmount": 0
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
location_id
string
required

The location ID to fetch settlements for

​
start_date
string<date-time> | null

Start date for the range (inclusive)

​
end_date
string<date-time> | null

End date for the range (inclusive)

Response

Successful Response

​
date
string<date-time>
required

The date of the settlements

​
settlements
ExternalSettlementSummary · object[]
required

List of settlement summaries by type

​
totalSettlements
integer
required

Total number of different settlement types

​
totalAmount
integer
required

Total amount across all settlement types in cents

​
tipCount
integer
default:0

Total number of tips received on this day

​
totalTipAmount
integer
default:0

Total tip amount in cents