Skip to main content
PUT
/
billing
/
cash-balance
/
{cash_balance_id}
Update Cash Balance
curl --request PUT \
  --url https://api.decodahealth.com/billing/cash-balance/{cash_balance_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "closingBalance": 123,
  "balanceDiscrepancy": 123,
  "discrepancyAcknowledged": true,
  "acknowledgedById": "<string>",
  "creatorId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z"
}
'
{
  "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
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

cash_balance_id
string
required

Body

application/json

Update a cash balance record.

closingBalance
integer | null

The closing balance amount in cents

balanceDiscrepancy
integer | null

The balance discrepancy amount in cents

discrepancyAcknowledged
boolean | null

Whether the discrepancy has been acknowledged

acknowledgedById
string | null

The ID of the user who acknowledged the discrepancy

creatorId
string | null

The ID of the creator

createdDate
string<date-time> | null

The date and time the cash balance was created

Response

Successful Response

Summary of a cash balance record.

id
string
required

The unique identifier for the cash balance

creatorId
string
required

The ID of the creator

locationId
string
required

The ID of the location

closingBalance
integer
required

The closing balance amount in cents

balanceDiscrepancy
integer
required

The balance discrepancy amount in cents

createdDate
string<date-time>
required

The date and time the cash balance was created

discrepancyAcknowledged
boolean
default:false

Whether the discrepancy has been acknowledged

acknowledgedById
string | null

The ID of the user who acknowledged the discrepancy

updatedDate
string<date-time> | null

The date and time the cash balance was last updated

isArchived
boolean
default:false

Whether the cash balance record is archived/voided