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

Body

application/json

Create a cash balance adjustment (pay-in/pay-out).

locationId
string
required

The ID of the location for this adjustment

amount
integer
required

The adjustment amount in cents (positive for pay-in, negative for pay-out)

reason
string
required

The reason for the adjustment

creatorId
string
required

The ID of the creator

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