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>"
}
'import requests
url = "https://api.clinikapi.com/v1/charge-items"
payload = {
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.clinikapi.com/v1/charge-items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/charge-items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/charge-items"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"performingOrganizationId\": \"<string>\",\n \"requestingOrganizationId\": \"<string>\",\n \"bodySite\": [\n \"<string>\"\n ],\n \"overrideReason\": \"<string>\",\n \"enteredDate\": \"<string>\",\n \"reason\": [\n \"<string>\"\n ],\n \"accountIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/charge-items")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"performingOrganizationId\": \"<string>\",\n \"requestingOrganizationId\": \"<string>\",\n \"bodySite\": [\n \"<string>\"\n ],\n \"overrideReason\": \"<string>\",\n \"enteredDate\": \"<string>\",\n \"reason\": [\n \"<string>\"\n ],\n \"accountIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/charge-items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"performingOrganizationId\": \"<string>\",\n \"requestingOrganizationId\": \"<string>\",\n \"bodySite\": [\n \"<string>\"\n ],\n \"overrideReason\": \"<string>\",\n \"enteredDate\": \"<string>\",\n \"reason\": [\n \"<string>\"\n ],\n \"accountIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCharge Items
Create Charge Item
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>"
}
'import requests
url = "https://api.clinikapi.com/v1/charge-items"
payload = {
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.clinikapi.com/v1/charge-items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/charge-items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/charge-items"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"performingOrganizationId\": \"<string>\",\n \"requestingOrganizationId\": \"<string>\",\n \"bodySite\": [\n \"<string>\"\n ],\n \"overrideReason\": \"<string>\",\n \"enteredDate\": \"<string>\",\n \"reason\": [\n \"<string>\"\n ],\n \"accountIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/charge-items")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"performingOrganizationId\": \"<string>\",\n \"requestingOrganizationId\": \"<string>\",\n \"bodySite\": [\n \"<string>\"\n ],\n \"overrideReason\": \"<string>\",\n \"enteredDate\": \"<string>\",\n \"reason\": [\n \"<string>\"\n ],\n \"accountIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/charge-items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"performingOrganizationId\": \"<string>\",\n \"requestingOrganizationId\": \"<string>\",\n \"bodySite\": [\n \"<string>\"\n ],\n \"overrideReason\": \"<string>\",\n \"enteredDate\": \"<string>\",\n \"reason\": [\n \"<string>\"\n ],\n \"accountIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
planned, billable, not-billable, aborted, billed Maximum string length:
128Maximum string length:
128Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
128Maximum string length:
128Show child attributes
Show child attributes
Maximum array length:
10Maximum string length:
500Show child attributes
Show child attributes
Maximum string length:
2000Maximum array length:
10Maximum string length:
500Maximum array length:
10Maximum string length:
128Maximum string length:
5000Response
201
Charge item created
⌘I