Skip to main content
POST
/
billing
/
cash-balance
Create Cash Balance
curl --request POST \
  --url https://api.decodahealth.com/billing/cash-balance \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "locationId": "<string>",
  "closingBalance": 123,
  "creatorId": "<string>",
  "balanceDiscrepancy": 0,
  "discrepancyAcknowledged": false
}
'
{
  "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

Body

application/json

Create a cash balance record for a location.

​
locationId
string
required

The ID of the location

​
closingBalance
integer
required

The closing balance amount in cents

​
creatorId
string
required

The ID of the creator

​
balanceDiscrepancy
integer
default:0

The balance discrepancy amount in cents

​
discrepancyAcknowledged
boolean
default:false

Whether the discrepancy has been acknowledged

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