Skip to main content
GET
/
billing
/
cash-balance
/
expected
/
{location_id}
Get Expected Cash Balance
curl --request GET \
  --url https://api.decodahealth.com/billing/cash-balance/expected/{location_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "expectedCash": 123,
  "lastClosingBalance": 123,
  "paymentsSinceClose": 123,
  "refundsSinceClose": 123,
  "adjustmentsSinceClose": 123,
  "lastCloseDate": "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

Path Parameters

​
location_id
string
required

Response

Successful Response

Expected cash balance calculation for a location.

​
expectedCash
integer
required

Expected cash balance in cents

​
lastClosingBalance
integer
required

Last closing balance in cents

​
paymentsSinceClose
integer
required

Cash payments since last close in cents

​
refundsSinceClose
integer
required

Cash refunds since last close in cents

​
adjustmentsSinceClose
integer
required

Cash balance adjustments since last close in cents

​
lastCloseDate
string<date-time> | null

Date of last close