Skip to main content
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>"
}
'

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:
draft,
issued,
balanced,
cancelled
patientId
string
Maximum string length: 128
type
string
Maximum string length: 200
recipientId
string
Maximum string length: 128
date
string
issuerId
string
Maximum string length: 128
accountId
string
Maximum string length: 128
participant
object[]
Maximum array length: 20
lineItem
object[]
Maximum array length: 50
totalNet
object
totalGross
object
paymentTerms
string
Maximum string length: 2000
cancelledReason
string
Maximum string length: 1000
note
string
Maximum string length: 5000

Response

201

Invoice created