Skip to main content
GET
/
billing
/
cash-balance
/
timeline
Get Cash Balance Timeline
curl --request GET \
  --url https://api.decodahealth.com/billing/cash-balance/timeline \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "events": [
    {
      "id": "<string>",
      "type": "balance_closure",
      "date": "2023-11-07T05:31:56Z",
      "cashBalance": {
        "id": "<string>",
        "creatorId": "<string>",
        "locationId": "<string>",
        "closingBalance": 123,
        "balanceDiscrepancy": 123,
        "createdDate": "2023-11-07T05:31:56Z",
        "discrepancyAcknowledged": false,
        "acknowledgedById": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z",
        "isArchived": false,
        "locationName": "<string>",
        "creatorName": "<string>",
        "acknowledgedByName": "<string>"
      },
      "adjustment": {
        "id": "<string>",
        "locationId": "<string>",
        "amount": 123,
        "reason": "<string>",
        "creatorId": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "isArchived": false,
        "creatorName": "<string>"
      },
      "calculatedBalance": {
        "date": "2023-11-07T05:31:56Z",
        "endingBalance": 123,
        "startingBalance": 123,
        "cashPayments": 123,
        "cashRefunds": 123,
        "adjustments": 123,
        "locationId": "<string>",
        "locationName": "<string>"
      },
      "paymentSummary": {
        "id": "<string>",
        "amount": 123,
        "payerName": "<string>",
        "creatorName": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "paymentMedium": "<string>"
      },
      "refundSummary": {
        "id": "<string>",
        "amount": 123,
        "payerName": "<string>",
        "creatorName": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "reason": "<string>"
      },
      "locationName": "<string>"
    }
  ],
  "stats": {
    "totalEvents": 123,
    "balanceClosures": 123,
    "adjustments": 123,
    "discrepancies": 123
  }
}

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
start_date
string<date-time> | null
end_date
string<date-time> | null
include_calculated
boolean
default:true

Response

Successful Response

Complete timeline response including events and stats.

events
TimelineEvent · object[]
required

List of timeline events

stats
TimelineStats · object
required

Summary statistics