Skip to main content
POST
/
v1
/
charge-items
Create charge item
curl --request POST \
  --url https://api.clinikapi.com/v1/charge-items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "patientId": "<string>",
  "encounterId": "<string>",
  "occurrenceDateTime": "<string>",
  "occurrencePeriod": {
    "start": "<string>",
    "end": "<string>"
  },
  "performer": [
    {
      "actorId": "<string>",
      "function": "<string>"
    }
  ],
  "performingOrganizationId": "<string>",
  "requestingOrganizationId": "<string>",
  "bodySite": [
    "<string>"
  ],
  "overrideReason": "<string>",
  "enteredDate": "<string>",
  "reason": [
    "<string>"
  ],
  "accountIds": [
    "<string>"
  ],
  "note": "<string>"
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
planned,
billable,
not-billable,
aborted,
billed
code
required
patientId
string
required
Maximum string length: 128
encounterId
string
Maximum string length: 128
occurrenceDateTime
string
occurrencePeriod
object
performer
object[]
Maximum array length: 20
performingOrganizationId
string
Maximum string length: 128
requestingOrganizationId
string
Maximum string length: 128
quantity
object
bodySite
string[]
Maximum array length: 10
Maximum string length: 500
priceOverride
object
overrideReason
string
Maximum string length: 2000
enteredDate
string
reason
string[]
Maximum array length: 10
Maximum string length: 500
accountIds
string[]
Maximum array length: 10
Maximum string length: 128
note
string
Maximum string length: 5000

Response

201

Charge item created