Create invoice
curl --request POST \
--url https://api.clinikapi.com/v1/invoices \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"type": "<string>",
"recipientId": "<string>",
"date": "<string>",
"issuerId": "<string>",
"accountId": "<string>",
"participant": [
{
"actorId": "<string>",
"role": "<string>"
}
],
"lineItem": [
{
"chargeItemCode": "<string>",
"sequence": 123,
"priceComponent": [
{
"type": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"totalNet": {
"value": 123,
"currency": "<string>"
},
"totalGross": {
"value": 123,
"currency": "<string>"
},
"paymentTerms": "<string>",
"cancelledReason": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/invoices"
payload = {
"patientId": "<string>",
"type": "<string>",
"recipientId": "<string>",
"date": "<string>",
"issuerId": "<string>",
"accountId": "<string>",
"participant": [
{
"actorId": "<string>",
"role": "<string>"
}
],
"lineItem": [
{
"chargeItemCode": "<string>",
"sequence": 123,
"priceComponent": [
{
"type": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"totalNet": {
"value": 123,
"currency": "<string>"
},
"totalGross": {
"value": 123,
"currency": "<string>"
},
"paymentTerms": "<string>",
"cancelledReason": "<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({
patientId: '<string>',
type: '<string>',
recipientId: '<string>',
date: '<string>',
issuerId: '<string>',
accountId: '<string>',
participant: [{actorId: '<string>', role: '<string>'}],
lineItem: [
{
chargeItemCode: '<string>',
sequence: 123,
priceComponent: [{type: '<string>', amount: {value: 123, currency: '<string>'}}]
}
],
totalNet: {value: 123, currency: '<string>'},
totalGross: {value: 123, currency: '<string>'},
paymentTerms: '<string>',
cancelledReason: '<string>',
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/invoices', 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/invoices",
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([
'patientId' => '<string>',
'type' => '<string>',
'recipientId' => '<string>',
'date' => '<string>',
'issuerId' => '<string>',
'accountId' => '<string>',
'participant' => [
[
'actorId' => '<string>',
'role' => '<string>'
]
],
'lineItem' => [
[
'chargeItemCode' => '<string>',
'sequence' => 123,
'priceComponent' => [
[
'type' => '<string>',
'amount' => [
'value' => 123,
'currency' => '<string>'
]
]
]
]
],
'totalNet' => [
'value' => 123,
'currency' => '<string>'
],
'totalGross' => [
'value' => 123,
'currency' => '<string>'
],
'paymentTerms' => '<string>',
'cancelledReason' => '<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/invoices"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"date\": \"<string>\",\n \"issuerId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"participant\": [\n {\n \"actorId\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"lineItem\": [\n {\n \"chargeItemCode\": \"<string>\",\n \"sequence\": 123,\n \"priceComponent\": [\n {\n \"type\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"totalNet\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"totalGross\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"paymentTerms\": \"<string>\",\n \"cancelledReason\": \"<string>\",\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/invoices")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"date\": \"<string>\",\n \"issuerId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"participant\": [\n {\n \"actorId\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"lineItem\": [\n {\n \"chargeItemCode\": \"<string>\",\n \"sequence\": 123,\n \"priceComponent\": [\n {\n \"type\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"totalNet\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"totalGross\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"paymentTerms\": \"<string>\",\n \"cancelledReason\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/invoices")
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 \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"date\": \"<string>\",\n \"issuerId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"participant\": [\n {\n \"actorId\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"lineItem\": [\n {\n \"chargeItemCode\": \"<string>\",\n \"sequence\": 123,\n \"priceComponent\": [\n {\n \"type\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"totalNet\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"totalGross\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"paymentTerms\": \"<string>\",\n \"cancelledReason\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyInvoices
Create Invoice
POST
/
v1
/
invoices
Create invoice
curl --request POST \
--url https://api.clinikapi.com/v1/invoices \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"type": "<string>",
"recipientId": "<string>",
"date": "<string>",
"issuerId": "<string>",
"accountId": "<string>",
"participant": [
{
"actorId": "<string>",
"role": "<string>"
}
],
"lineItem": [
{
"chargeItemCode": "<string>",
"sequence": 123,
"priceComponent": [
{
"type": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"totalNet": {
"value": 123,
"currency": "<string>"
},
"totalGross": {
"value": 123,
"currency": "<string>"
},
"paymentTerms": "<string>",
"cancelledReason": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/invoices"
payload = {
"patientId": "<string>",
"type": "<string>",
"recipientId": "<string>",
"date": "<string>",
"issuerId": "<string>",
"accountId": "<string>",
"participant": [
{
"actorId": "<string>",
"role": "<string>"
}
],
"lineItem": [
{
"chargeItemCode": "<string>",
"sequence": 123,
"priceComponent": [
{
"type": "<string>",
"amount": {
"value": 123,
"currency": "<string>"
}
}
]
}
],
"totalNet": {
"value": 123,
"currency": "<string>"
},
"totalGross": {
"value": 123,
"currency": "<string>"
},
"paymentTerms": "<string>",
"cancelledReason": "<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({
patientId: '<string>',
type: '<string>',
recipientId: '<string>',
date: '<string>',
issuerId: '<string>',
accountId: '<string>',
participant: [{actorId: '<string>', role: '<string>'}],
lineItem: [
{
chargeItemCode: '<string>',
sequence: 123,
priceComponent: [{type: '<string>', amount: {value: 123, currency: '<string>'}}]
}
],
totalNet: {value: 123, currency: '<string>'},
totalGross: {value: 123, currency: '<string>'},
paymentTerms: '<string>',
cancelledReason: '<string>',
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/invoices', 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/invoices",
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([
'patientId' => '<string>',
'type' => '<string>',
'recipientId' => '<string>',
'date' => '<string>',
'issuerId' => '<string>',
'accountId' => '<string>',
'participant' => [
[
'actorId' => '<string>',
'role' => '<string>'
]
],
'lineItem' => [
[
'chargeItemCode' => '<string>',
'sequence' => 123,
'priceComponent' => [
[
'type' => '<string>',
'amount' => [
'value' => 123,
'currency' => '<string>'
]
]
]
]
],
'totalNet' => [
'value' => 123,
'currency' => '<string>'
],
'totalGross' => [
'value' => 123,
'currency' => '<string>'
],
'paymentTerms' => '<string>',
'cancelledReason' => '<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/invoices"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"date\": \"<string>\",\n \"issuerId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"participant\": [\n {\n \"actorId\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"lineItem\": [\n {\n \"chargeItemCode\": \"<string>\",\n \"sequence\": 123,\n \"priceComponent\": [\n {\n \"type\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"totalNet\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"totalGross\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"paymentTerms\": \"<string>\",\n \"cancelledReason\": \"<string>\",\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/invoices")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"date\": \"<string>\",\n \"issuerId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"participant\": [\n {\n \"actorId\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"lineItem\": [\n {\n \"chargeItemCode\": \"<string>\",\n \"sequence\": 123,\n \"priceComponent\": [\n {\n \"type\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"totalNet\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"totalGross\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"paymentTerms\": \"<string>\",\n \"cancelledReason\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/invoices")
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 \"patientId\": \"<string>\",\n \"type\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"date\": \"<string>\",\n \"issuerId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"participant\": [\n {\n \"actorId\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"lineItem\": [\n {\n \"chargeItemCode\": \"<string>\",\n \"sequence\": 123,\n \"priceComponent\": [\n {\n \"type\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"totalNet\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"totalGross\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"paymentTerms\": \"<string>\",\n \"cancelledReason\": \"<string>\",\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:
draft, issued, balanced, cancelled Maximum string length:
128Maximum string length:
200Maximum string length:
128Maximum string length:
128Maximum string length:
128Maximum array length:
20Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
2000Maximum string length:
1000Maximum string length:
5000Response
201
Invoice created
⌘I