Skip to main content
GET
/
billing
/
cash-balance
/
external-settlement-details
Get External Settlement Details
curl --request GET \
  --url https://api.decodahealth.com/billing/cash-balance/external-settlement-details \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "type": "<string>",
    "payment": {
      "id": "<string>",
      "amount": 123,
      "patientName": "<string>",
      "creatorName": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "paymentMedium": "<string>",
      "paymentMethodSummary": "<string>",
      "chargeIds": [],
      "comment": "<string>"
    },
    "tip": {
      "id": "<string>",
      "amount": 123,
      "providerName": "<string>",
      "patientName": "<string>",
      "chargeId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  }
]

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 settlement details for

​
settlement_type
string
required

The external settlement type to fetch details for

​
date
string
required

The date to fetch details for (YYYY-MM-DD format)

Response

Successful Response

​
type
string
required

Type of settlement detail: 'payment' or 'tip'

​
payment
ExternalSettlementPayment · object

Payment details if type is 'payment'

​
tip
ExternalSettlementTip · object

Tip details if type is 'tip'