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

​
adjustment_id
string
required

Body

application/json

Update a cash balance adjustment.

​
amount
integer | null

The adjustment amount in cents

​
reason
string | null

The reason for the adjustment

​
createdDate
string<date-time> | null

The date and time the adjustment was created

Response

Successful Response

Summary of a cash balance adjustment.

​
id
string
required

The unique identifier for the adjustment

​
locationId
string
required

The ID of the location

​
amount
integer
required

The adjustment amount in cents

​
reason
string
required

The reason for the adjustment

​
creatorId
string
required

The ID of the creator

​
createdDate
string<date-time>
required

The date and time the adjustment was created

​
isArchived
boolean
default:false

Whether the adjustment has been voided