---
title: "Get External Settlement Details"
method: GET
path: "/billing/cash-balance/external-settlement-details"
tags: ["provider", "billing"]
---

# Get External Settlement Details

`GET /billing/cash-balance/external-settlement-details`

## Request

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

Get detailed transaction information for a specific external settlement type and date.

## 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)

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- ExternalSettlementDetail[]
  - `type` string, required: Type of settlement detail: 'payment' or 'tip'
  - `payment` ExternalSettlementPayment: Detailed payment information for external settlements.
    - `id` string, required: Payment ID
    - `amount` integer, required: Payment amount in cents
    - `patientName` string, required: Name of the patient who made the payment
    - `creatorName` string, required: Name of the user who created the payment
    - `paymentMedium` string, nullable: Payment medium (e.g., CARD, CASH)
    - `paymentMethodSummary` string, nullable: Payment method summary (e.g., last4 digits)
    - `chargeIds` string[]: List of charge IDs associated with this payment
    - `createdDate` string, date-time, required: When the payment was created
    - `comment` string, nullable: Payment comment
  - `tip` ExternalSettlementTip: Detailed tip information for external settlements.
    - `id` string, required: Tip ID
    - `amount` integer, required: Tip amount in cents
    - `providerName` string, required: Name of the provider who received the tip
    - `patientName` string, required: Name of the patient who gave the tip
    - `chargeId` string, required: Charge ID associated with this tip
    - `createdDate` string, date-time, required: When the tip was created

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)