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
}
}Get complete cash balance timeline for a location with all events aggregated.
By default (when no start_date is provided), returns the last 7 days of data for performance. The timeline will automatically include the most recent cash balance closure before the start date to ensure accurate running balance calculations.
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
}
}The tenant you are making this request on behalf of
Your api key