{"info":{"_postman_id":"3e11654f-aa60-4b11-ba77-d6988333c014","name":"Cliniccards API Documentation","description":"

This API is available at https://cliniccards.com/api

The API allows to get information from Cliniccards. To work with the API you should get an API key. It is available only for the clinic's owner.

Go to Settings - Other - Clinic Settings - API key.

\n\n

After receiving, the key is saved in the clinic’s settings. You can delete it or generate a new one.

Each request must contain 2 required headers:

Token - your API key
\n
Content-Type - application/json
\n

Error Handling

Each response has the \"result\" variable. It can have value \"success\" or \"fail\". If an error occurs, there will be a description in the “error” variable.

Example:

{\"data\":null,\"result\":\"fail\",\"error\":\"Body for request is empty or has incorrect JSON\"}\n\n

Limits

60 requests per minute.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29513893","collectionId":"3e11654f-aa60-4b11-ba77-d6988333c014","publishedId":"2s9YBxZbqY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"47B269"},"publishDate":"2023-09-06T08:26:04.000Z"},"item":[{"name":"Schedule","item":[{"name":"Add Appointment","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"68096eb8-a655-4ba5-b2d9-50ea76c27904"}},{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"8b44e903-fb31-4c14-ba57-22a1b7562c99"}}],"id":"6d1b3976-43e4-4b80-8953-bf7fa79dd9c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"status\": \"PLANNED\",\n\"patient_id\": \"1111111\",\n\"cabinet_id\": \"15000\",\n\"doctor_id\": \"11111\",\n\"note\": \"Visit is created by API\",\n\"date\": \"2023-07-17\",\n\"time_start\": \"10:00\",\n\"time_end\": \"11:00\"\n}"},"url":"https://cliniccards.com/api/visits","description":"

Add a new doctor's appointment to the schedule.

Body Parameters

status \"string\" REQUIRED

Specifies the visit status.

One of: PLANNED, CONFIRMED,NOT_CONFIRMED,VISITED, MOVED,DID_NOT_COME,IN_CLINIC, BOOKING,CANCELLED, IN_CHAIR

patient_id \"string\" REQUIRED

Specifies the patient ID.

cabinet_id \"string\" REQUIRED

Specifies the cabinet ID.

doctor_id \"string\" REQUIRED

Specifies the doctor ID.

note \"string\" REQUIRED

Specifies a comment. String length from 1 to 400.

date \"string\" REQUIRED

Specifies the visit date. Must be in YYYY-MM-DD format.

time_start \"string\" REQUIRED

Specifies the start time. Must be in HH:MM format, multiples of 5 minutes.

time_end \"string\" REQUIRED

Specifies the end time. Must be in HH:MM format, multiples of 5 minutes.

\n","urlObject":{"protocol":"https","path":["api","visits"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"050d6fcd-27a6-4659-bc24-c8d8d1ab83a4","name":"Create Visit","originalRequest":{"method":"POST","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"status\": \"PLANNED\",\n\"patient_id\": \"1111111\",\n\"cabinet_id\": \"15000\",\n\"doctor_id\": \"12345\",\n\"note\": \"Visit is created by API\",\n\"date\": \"2023-07-01\",\n\"time_start\": \"10:00\",\n\"time_end\": \"11:00\"\n}"},"url":"https://cliniccards.com/api/visits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"visit_id\": \"77777777\",\n \"patient_id\": \"1111111\",\n \"status\": \"PLANNED\",\n \"doctor\": \"Awesome Doctor\",\n \"doctor_id\": \"12345\",\n \"date_created\": \"2023-08-01 11:10:10\",\n \"date_edited\": \"2023-08-01 11:10:10\",\n \"visit_start\": \"2023-07-01 10:00:00\",\n \"visit_end\": \"2023-07-01 11:00:00\",\n \"created_by\": \"Some Administrator\",\n \"created_by_id\": \"12304\",\n \"edited_by\": \"Some Administrator\",\n \"edited_by_id\": \"12304\",\n \"note\": \"Visit is created by API\",\n \"cabinet\": \"Office 1\",\n \"cabinet_id\": \"15000\"\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"6d1b3976-43e4-4b80-8953-bf7fa79dd9c8"},{"name":"Appointments","event":[{"listen":"test","script":{"id":"97b69efe-fc8e-43c7-a5b9-56c50ad03825","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"8a2281de-bf3a-411f-b229-e76ced5eff48","exec":[""],"type":"text/javascript"}}],"id":"04c7a723-6a14-422c-94fe-93b9a7e38cad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/visits?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get a list of visits within a period.

The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","visits"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"042dfc1b-8151-4708-ab5b-fc8d602d47b7","name":"Get Visits","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/visits?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","visits"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"visit_id\": \"77777777\",\n \"patient_id\": \"1111111\",\n \"status\": \"PLANNED\",\n \"doctor\": \"Awesome Doctor\",\n \"doctor_id\": \"12345\",\n \"date_created\": \"2023-07-01 11:11:13\",\n \"date_edited\": \"2023-07-01 11:11:13\",\n \"visit_start\": \"2023-07-17 10:00:00\",\n \"visit_end\": \"2023-07-17 11:00:00\",\n \"created_by\": \"Some Administrator\",\n \"created_by_id\": \"50000\",\n \"edited_by\": \"Some Administrator\",\n \"edited_by_id\": \"50000\",\n \"note\": \"Visit is created by API\",\n \"cabinet\": \"Office 1\",\n \"cabinet_id\": \"15000\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"04c7a723-6a14-422c-94fe-93b9a7e38cad"},{"name":"Update Appointment","id":"75356d4a-f4fb-4288-86e4-f45129d664af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visit_id\": 12345678,\n \"note\": \"visit note\",\n \"status\": \"PLANNED\",\n \"patient_id\": \"1111111\",\n \"cabinet_id\": \"55555\",\n \"doctor_id\": \"33333\",\n \"date\": \"2023-07-01\",\n \"time_start\": \"10:00\",\n \"time_end\": \"11:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/visits","description":"

Update doctor's schedule appointment.

Body Parameters

visit_id \"string\" REQUIRED

Specifies the visit ID.

status \"string\" REQUIRED

Specifies the visit status.

One of: PLANNED, CONFIRMED,NOT_CONFIRMED,VISITED, MOVED,DID_NOT_COME,IN_CLINIC, BOOKING,CANCELLED, IN_CHAIR

patient_id \"string\" REQUIRED

Specifies the patient ID.

cabinet_id \"string\" REQUIRED

Specifies the cabinet ID.

doctor_id \"string\" REQUIRED

Specifies the doctor ID.

note \"string\" REQUIRED

Specifies a comment. String length from 1 to 400.

date \"string\" REQUIRED

Specifies the visit date. Must be in YYYY-MM-DD format.

time_start \"string\" REQUIRED

Specifies the start time. Must be in HH:MM format, multiples of 5 minutes.

time_end \"string\" REQUIRED

Specifies the end time. Must be in HH:MM format, multiples of 5 minutes.

\n","urlObject":{"protocol":"https","path":["api","visits"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"214f2307-3e8f-4fcb-8758-792e5d47cfcc","name":"Update Visit","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"YOUR API KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visit_id\": 12345678,\n \"note\": \"visit note\",\n \"status\": \"PLANNED\",\n \"patient_id\": \"1111111\",\n \"cabinet_id\": \"55555\",\n \"doctor_id\": \"33333\",\n \"date\": \"2023-07-01\",\n \"time_start\": \"10:00\",\n \"time_end\": \"11:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/visits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"visit_id\": \"12345678\",\n \"patient_id\": \"1111111\",\n \"status\": \"PLANNED\",\n \"doctor\": \"Some Doctor\",\n \"doctor_id\": \"33333\",\n \"date_created\": \"2023-11-19 18:14:58\",\n \"date_edited\": \"2024-11-08 18:46:59\",\n \"visit_start\": \"2023-07-01 10:00:00\",\n \"visit_end\": \"2023-07-01 11:00:00\",\n \"created_by\": \"Some Doctor\",\n \"created_by_id\": \"33333\",\n \"edited_by\": \"Some Doctor\",\n \"edited_by_id\": \"33333\",\n \"note\": \"visit note\",\n \"cabinet\": \"Cabinet name\",\n \"cabinet_id\": \"55555\"\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"75356d4a-f4fb-4288-86e4-f45129d664af"},{"name":"Delete Appointment","id":"3aeddbb2-2171-4971-8f7e-6f074f900f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visit_id\": \"11111111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/visits","description":"

Delete a visit by id

visit_id \"string\" REQUIRED

Specifies the visit ID.

\n","urlObject":{"protocol":"https","path":["api","visits"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"30a76244-cc68-41fc-9cce-323ddf11f892","name":"Delete Visit","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"YOUR API KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visit_id\": \"11111111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/visits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"3aeddbb2-2171-4971-8f7e-6f074f900f9a"},{"name":"Provider Shifts","id":"4c94923b-e75a-471a-894c-7ac764455675","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/schedule-shifts?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get a list of schedule shifts for a specific period. The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","schedule-shifts"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"dd5fbae7-86e1-483c-9b49-92da06208f39","name":"Schedule Shifts","originalRequest":{"method":"GET","header":[{"key":"token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/schedule-shifts?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","schedule-shifts"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"schedule_shift_id\": \"1234567\",\n \"schedule_cabinets_id\": \"12345\",\n \"schedule_cabinet_name\": \"Cabinet 1\",\n \"doctor\": \"John Doe\",\n \"doctor_id\": \"11111\",\n \"shift_start\": \"2024-04-15 10:00:00\",\n \"shift_end\": \"2024-04-15 16:00:00\"\n },\n {\n \"schedule_shift_id\": \"7654321\",\n \"schedule_cabinets_id\": \"12345\",\n \"schedule_cabinet_name\": \"Cabinet 2\",\n \"doctor\": \"John Doe\",\n \"doctor_id\": \"11111\",\n \"shift_start\": \"2024-04-15 10:00:00\",\n \"shift_end\": \"2024-04-15 11:00:00\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"4c94923b-e75a-471a-894c-7ac764455675"},{"name":"Reserved Time Blocks","id":"30e42fe0-3af1-4fd2-ae77-65ff043909c5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Token","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/schedule-spaces?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get time reserves within the time period.

Date format YYYY-MM-DD

\n","urlObject":{"protocol":"https","path":["api","schedule-spaces"],"host":["cliniccards","com"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"89c586e3-7baa-48c0-8f5d-833aa7706c08","name":"Get Time Reserves","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/schedule-spaces?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","schedule-spaces"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"schedule_space_id\": \"1718303\",\n \"schedule_cabinets_id\": \"21684\",\n \"schedule_cabinet_name\": \"Chair 1\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Anonymous shift\",\n \"space_start\": \"2024-12-31 09:00:00\",\n \"space_end\": \"2024-12-31 18:00:00\"\n },\n {\n \"schedule_space_id\": \"1718306\",\n \"schedule_cabinets_id\": \"21685\",\n \"schedule_cabinet_name\": \"Chair 2\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Anonymous shift\",\n \"space_start\": \"2025-01-01 09:00:00\",\n \"space_end\": \"2025-01-01 18:00:00\"\n },\n {\n \"schedule_space_id\": \"1718307\",\n \"schedule_cabinets_id\": \"21684\",\n \"schedule_cabinet_name\": \"Chair 1\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Clean-up\",\n \"space_start\": \"2025-01-01 09:00:00\",\n \"space_end\": \"2025-01-01 10:00:00\"\n },\n {\n \"schedule_space_id\": \"1718309\",\n \"schedule_cabinets_id\": \"21685\",\n \"schedule_cabinet_name\": \"Chair 2\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Clean-up\",\n \"space_start\": \"2025-01-02 09:00:00\",\n \"space_end\": \"2025-01-02 10:00:00\"\n },\n {\n \"schedule_space_id\": \"1718311\",\n \"schedule_cabinets_id\": \"21684\",\n \"schedule_cabinet_name\": \"Chair 1\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Anonymous shift\",\n \"space_start\": \"2025-01-02 09:00:00\",\n \"space_end\": \"2025-01-02 18:00:00\"\n },\n {\n \"schedule_space_id\": \"1718313\",\n \"schedule_cabinets_id\": \"21685\",\n \"schedule_cabinet_name\": \"Chair 2\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Anonymous shift\",\n \"space_start\": \"2025-01-03 09:00:00\",\n \"space_end\": \"2025-01-03 18:00:00\"\n },\n {\n \"schedule_space_id\": \"1718315\",\n \"schedule_cabinets_id\": \"21684\",\n \"schedule_cabinet_name\": \"Chair 1\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Clean-up\",\n \"space_start\": \"2025-01-03 09:00:00\",\n \"space_end\": \"2025-01-03 10:00:00\"\n },\n {\n \"schedule_space_id\": \"1718317\",\n \"schedule_cabinets_id\": \"21685\",\n \"schedule_cabinet_name\": \"Chair 2\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Clean-up\",\n \"space_start\": \"2025-01-04 09:00:00\",\n \"space_end\": \"2025-01-04 10:00:00\"\n },\n {\n \"schedule_space_id\": \"1718319\",\n \"schedule_cabinets_id\": \"21684\",\n \"schedule_cabinet_name\": \"Chair 1\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Anonymous shift\",\n \"space_start\": \"2025-01-04 09:00:00\",\n \"space_end\": \"2025-01-04 18:00:00\"\n },\n {\n \"schedule_space_id\": \"1718329\",\n \"schedule_cabinets_id\": \"21684\",\n \"schedule_cabinet_name\": \"Chair 1\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Rest\",\n \"space_start\": \"2025-01-05 09:00:00\",\n \"space_end\": \"2025-01-05 18:00:00\"\n },\n {\n \"schedule_space_id\": \"1718332\",\n \"schedule_cabinets_id\": \"21685\",\n \"schedule_cabinet_name\": \"Chair 2\",\n \"created_by\": \"Last_name First_name\",\n \"created_by_id\": \"63577\",\n \"note\": \"\",\n \"type\": \"Rest\",\n \"space_start\": \"2025-01-05 09:00:00\",\n \"space_end\": \"2025-01-05 18:00:00\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"30e42fe0-3af1-4fd2-ae77-65ff043909c5"}],"id":"80f55cbf-9b46-4443-815a-35f2de0792f9","description":"

All schedule-related requests

\n","_postman_id":"80f55cbf-9b46-4443-815a-35f2de0792f9"},{"name":"Patients","item":[{"name":"Add Patient","event":[{"listen":"test","script":{"id":"3c13ef56-6a15-4bb9-88d5-1d76434ac0b1","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"5bfe4f3f-1993-42d9-a878-31b160f970c8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"25207dcb-1055-4711-be30-711693e559af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"lastname\": \"John\",\n\"firstname\": \"Doe\",\n\"phone\": \"380993334455\",\n\"phone2\": \"\",\n\"discount\": \"5\",\n\"address\": \"Some Street 3\",\n\"email\": \"johndoe@gmail.com\",\n\"gender\": \"M\",\n\"important_note\": \"Allergy\",\n\"note\": \"The patient is created by API\",\n\"birthday\": \"1980-01-01\",\n\"curator_id\": \"12345\",\n\"date_created\": \"2023-01-01\",\n\"preferred_contact\": \"PHONE\",\n\"payer\": \"\",\n\"statuses\": [],\n\"code\": null,\n\"subclinic_id\": \"111\"\n}"},"url":"https://cliniccards.com/api/patients","description":"

Add a new patient to the clinic.

Body Parameters

lastname \"string\" REQUIRED

Specifies the last name. String length from 1 to 50.

firstname \"string\" REQUIRED

Specifies the first name. String length from 1 to 50.

phone \"string\"

Specifies the primary phone number. Must be in international format (without a + sign).

Non-numeric characters will be removed.

Default: null

phone2 \"string\"

Specifies the additional phone number.

discount \"string\"

Specifies a discount. Will be converted to a float.

Default: null

address \"string\"

Specifies the address. String length from 1 to 150.

email \"string\"

Specifies an email. Must be in valid email format.

gender \"string\"

Specifies gender.

One of: M or F

Default: null

important_note \"string\"

Specifies important information about the patient (for example, allergies). String length from 1 to 200.

note \"string\"

Specifies a comment.

birthday \"string\"

Specifies the date of birth. Must be in YYYY-MM-DD format.

Default: null

curator_id \"string\"

Specifies the doctor ID the patient is assigned to.

Default: null

date_created \"string\"

Specifies the date of creation. Must be in YYYY-MM-DD format.

Default: the current date.

preferred_contact \"string\"

Specifies the preferred contact.

One of: PHONE, SMS, EMAIL, VIBER, WHATSAPP, FACEBOOK, INSTAGRAM, TELEGRAM

Default: null

payer \"string\"

Specifies the payer.

statuses [array]

Specifies a status. An array of numbers.

Default: the first status from the clinic will be added.

code \"string\"

Specifies the card number. Depends on the clinic settings. If the clinic has automatic numbering enabled and this field is empty, a new number will be generated. If a number is specified, it will be checked for uniqueness.

subclinic_id \"string\"

Specifies clinics tag.

\n","urlObject":{"protocol":"https","path":["api","patients"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"ad727e1b-af30-4b04-892e-f6c52de597e8","name":"Create Patient","originalRequest":{"method":"POST","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"lastname\": \"John\",\n\"firstname\": \"Doe\",\n\"phone\": \"380993334455\",\n\"phone2\": \"\",\n\"discount\": \"5\",\n\"address\": \"Some Street 3\",\n\"email\": \"johndoe@gmail.com\",\n\"gender\": \"M\",\n\"important_note\": \"Allergy\",\n\"note\": \"The patient is created by API\",\n\"birthday\": \"1980-01-01\",\n\"curator_id\": \"12345\",\n\"date_created\": \"2023-01-01\",\n\"preferred_contact\": \"PHONE\",\n\"payer\": \"\",\n\"statuses\": [],\n\"code\": null,\n\"subclinic_id\": \"111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/patients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"patient_id\": \"1111111\",\n \"lastname\": \"John\",\n \"firstname\": \"Doe\",\n \"phone\": \"380993334455\",\n \"phone2\": \"\",\n \"discount\": \"5\",\n \"address\": \"Some Street 3\",\n \"email\": \"johndoe@gmail.com\",\n \"gender\": \"M\",\n \"important_note\": \"Allergy\",\n \"note\": \"The patient is created by API\",\n \"code\": \"J00012\",\n \"birthday\": \"1980-01-01\",\n \"curator\": null,\n \"curator_id\": null,\n \"date_created\": \"2023-08-30\",\n \"preferred_contact\": \"PHONE\",\n \"payer\": \"\",\n \"statuses\": [\n 225376\n ],\n \"balance_paid\": \"0\",\n \"balance_issued\": \"0\",\n \"last_visit_date\": null,\n \"first_visit_date\": null,\n \"next_visit_date\": null,\n \"family\": null,\n \"insurance_policies\": null,\n \"main_plans_id\": \"1111111\",\n \"plans\": [\n 1111111,2222222\n ],\n \"subclinic\": {\n \"id\": 111,\n \"name\": \"Subclinic name\"\n }\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"25207dcb-1055-4711-be30-711693e559af"},{"name":"Update Patient","event":[{"listen":"test","script":{"id":"410029f0-f353-40ca-a230-663c2872804c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"cc05d500-ccfa-45b6-8cdb-b7cf6c84cc76","exec":[""],"type":"text/javascript","packages":{}}}],"id":"dbc3fa08-872f-4577-b753-47dab57393d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"lastname\": \"Jane\",\n\"firstname\": \"Doe\",\n\"phone\": \"380993334455\",\n\"phone2\": \"\",\n\"discount\": \"\",\n\"address\": \"Some Street 3\",\n\"email\": \"janedoe@gmail.com\",\n\"gender\": \"F\",\n\"important_note\": \"Allergy\",\n\"note\": \"The patient is created by API\",\n\"birthday\": \"1980-01-01\",\n\"curator_id\": \"12345\",\n\"date_created\": \"2023-01-01\",\n\"preferred_contact\": \"PHONE\",\n\"payer\": \"\",\n\"statuses\": [],\n\"code\": null,\n\"subclinic_id\": \"111\"\n}"},"url":"https://cliniccards.com/api/patients/{{patient_id}}","description":"

Update information about a patient.

Path Parameters

patient_id \"string\" REQUIRED

Specifies the patient ID.

Body Parameters

lastname \"string\"

Specifies the last name. String length from 1 to 50.

firstname \"string\"

Specifies the first name. String length from 1 to 50.

phone \"string\"

Specifies the primary phone number. Must be in international format (without a + sign).

Non-numeric characters will be removed.

Default: null

phone2 \"string\"

Specifies the additional phone number.

discount \"string\"

Specifies a discount. Will be converted to a float.

Default: null

address \"string\"

Specifies the address. String length from 1 to 150.

email \"string\"

Specifies an email. Must be in valid email format.

gender \"string\"

Specifies gender.

One of: M or F

Default: null

important_note \"string\"

Specifies important information about the patient (for example, allergies). String length from 1 to 200.

note \"string\"

Specifies a comment.

birthday \"string\"

Specifies the date of birth. Must be in YYYY-MM-DD format.

Default: null

curator_id \"string\"

Specifies the doctor ID the patient is assigned to.

Default: null

date_created \"string\"

Specifies the date of creation. Must be in YYYY-MM-DD format.

Default: the current date.

preferred_contact \"string\"

Specifies the preferred contact.

One of: PHONE, SMS, EMAIL, VIBER, WHATSAPP, FACEBOOK, INSTAGRAM, TELEGRAM

Default: null

payer \"string\"

Specifies the payer.

statuses [array]

Specifies a status. An array of numbers.

Default: the first status from the clinic will be added.

code \"string\"

subclinic_id \"string\"

Specifies clinics tag.

\n","urlObject":{"protocol":"https","path":["api","patients","{{patient_id}}"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"e332554a-1f6d-4bbc-91cb-e7a4fd9bce4c","name":"Update Patient","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"lastname\": \"Jane\",\n\"firstname\": \"Doe\",\n\"phone\": \"380993334455\",\n\"phone2\": \"\",\n\"discount\": \"\",\n\"address\": \"Some Street 3\",\n\"email\": \"janedoe@gmail.com\",\n\"gender\": \"F\",\n\"important_note\": \"Allergy\",\n\"note\": \"The patient is created by API\",\n\"birthday\": \"1980-01-01\",\n\"curator_id\": \"12345\",\n\"date_created\": \"2023-01-01\",\n\"preferred_contact\": \"PHONE\",\n\"payer\": \"\",\n\"statuses\": [],\n\"code\": null,\n\"subclinic_id\": \"111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/patients/{{patient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"patient_id\": \"1111111\",\n \"lastname\": \"Jane\",\n \"firstname\": \"Doe\",\n \"phone\": \"380993334455\",\n \"phone2\": \"\",\n \"discount\": \"5\",\n \"address\": \"Some Street 3\",\n \"email\": \"janedoe@gmail.com\",\n \"gender\": \"F\",\n \"important_note\": \"Allergy\",\n \"note\": \"The patient is created by API\",\n \"code\": \"J00012\",\n \"birthday\": \"1980-01-01\",\n \"curator\": null,\n \"curator_id\": null,\n \"date_created\": \"2023-01-01\",\n \"preferred_contact\": \"PHONE\",\n \"payer\": \"\",\n \"statuses\": [\n 225376\n ],\n \"balance_paid\": \"0\",\n \"balance_issued\": \"0\",\n \"last_visit_date\": null,\n \"first_visit_date\": null,\n \"next_visit_date\": null,\n \"family\": null,\n \"insurance_policies\": null,\n \"main_plans_id\": \"1111111\",\n \"plans\": [\n 1111111,2222222\n ],\n \"subclinic\": {\n \"id\": 111,\n \"name\": \"Subclinic name\"\n }\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"dbc3fa08-872f-4577-b753-47dab57393d1"},{"name":"Patients","event":[{"listen":"test","script":{"id":"2d9278cf-a632-4df5-97ef-bc41cc0a1c8a","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"c3ab03fe-9e76-46b0-9644-9aa37d154d77","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4791fc6b-08d5-44ed-adc5-120dcfe611d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/patients","description":"

Get all patients of the clinic.

\n","urlObject":{"protocol":"https","path":["api","patients"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"acd5e8d6-ddcc-4e34-9f76-e1b80b81abc7","name":"Get Patients","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/patients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"patient_id\": \"6060601\",\n \"lastname\": \"Jane\",\n \"firstname\": \"Doe\",\n \"source\": \"Patient recomendation\",\n \"patient_recommendation\": {\n \"lastname\": \"John\",\n \"firstname\": \"Doe\",\n \"patient_id\": 639618\n },\n \"phone\": \"6073205705\",\n \"phone2\": \"\",\n \"discount\": \"5\",\n \"address\": \"Some Street 34\",\n \"email\": \"someemail@dmail.com\",\n \"gender\": \"F\",\n \"important_note\": \"Allergy\",\n \"note\": \"\",\n \"code\": \"J00001\",\n \"birthday\": null,\n \"curator\": \"Awesome Doctor\",\n \"curator_id\": \"50004\",\n \"date_created\": \"2023-08-01\",\n \"preferred_contact\": \"SMS\",\n \"payer\": \"\",\n \"statuses\": [\n 225376\n ],\n \"balance_paid\": \"200\",\n \"balance_issued\": \"550\",\n \"last_visit_date\": null,\n \"first_visit_date\": null,\n \"next_visit_date\": null,\n \"family\": {\n \"family_number\": 1\n },\n \"insurance_policies\": [\n {\n \"id\": 17281,\n \"status\": \"EXPIRED\",\n \"annotation\": \"\",\n \"companies_id\": 1303,\n \"policy_limit\": \"7000\",\n \"policy_number\": \"123-456\",\n \"policy_expires\": \"2024-01-01\",\n \"franchise_percent\": null,\n \"franchise_absolute\": null\n },\n {\n \"id\": 17285,\n \"status\": \"ACTIVE\",\n \"annotation\": \"\",\n \"companies_id\": 1302,\n \"policy_limit\": \"8000\",\n \"policy_number\": \"88009911\",\n \"policy_expires\": \"2024-01-01\",\n \"franchise_percent\": 40,\n \"franchise_absolute\": null\n }\n ],\n \"main_plans_id\": \"1111111\",\n \"plans\": [\n 1111111,2222222\n ],\n \"subclinic\": {\n \"id\": 111,\n \"name\": \"Subclinic name\"\n }\n },\n {\n \"patient_id\": \"7070701\",\n \"lastname\": \"Torp\",\n \"firstname\": \"Justyn\",\n \"source\": \"Google\",\n \"patient_recommendation\": null,\n \"phone\": null,\n \"phone2\": \"\",\n \"discount\": null,\n \"address\": \"Awesome Street, 35\",\n \"email\": \"\",\n \"gender\": \"M\",\n \"important_note\": \"\",\n \"note\": \"\",\n \"code\": \"T00241\",\n \"birthday\": \"1980-01-01\",\n \"curator\": null,\n \"curator_id\": null,\n \"date_created\": \"2023-08-28\",\n \"preferred_contact\": \"PHONE\",\n \"payer\": \"\",\n \"statuses\": [\n 225376\n ],\n \"balance_paid\": \"0\",\n \"balance_issued\": \"0\",\n \"last_visit_date\": null,\n \"first_visit_date\": null,\n \"next_visit_date\": null,\n \"family\": null,\n \"insurance_policies\": null,\n \"main_plans_id\": \"3333333\",\n \"plans\": [\n 3333333,\n 4444444\n ],\n \"subclinic\": null\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"4791fc6b-08d5-44ed-adc5-120dcfe611d0"},{"name":"Patient by ID","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"63bba764-8ef6-46db-9408-d5a3a6fb1c9f"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"9f620680-7c68-4e87-a53a-b2fbed295727"}}],"id":"55463cbe-de35-489d-9f66-daf81099e9e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://cliniccards.com/api/patients/{{patient_id}}","description":"

Get a patient by ID. Can be added a few comma-separated IDs.

Path Parameters

patient_id \"string\" REQUIRED

Specifies the patient ID.

\n","urlObject":{"protocol":"https","path":["api","patients","{{patient_id}}"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"0526a806-8c5f-4aa6-aa1e-33b87af5e1b8","name":"Get a Patient By ID","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/patients/{{patient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"patient_id\": \"1111111\",\n \"lastname\": \"Jane\",\n \"firstname\": \"Doe\",\n \"source\": \"Patient recomendation\",\n \"patient_recommendation\": {\n \"lastname\": \"John\",\n \"firstname\": \"Doe\",\n \"patient_id\": 639618\n },\n \"phone\": \"380993334455\",\n \"phone2\": \"\",\n \"discount\": \"5\",\n \"address\": \"Some Street 3\",\n \"email\": \"janedoe@gmail.com\",\n \"gender\": \"F\",\n \"important_note\": \"Allergy\",\n \"note\": \"The patient is created by API\",\n \"code\": \"J00012\",\n \"birthday\": \"1980-01-01\",\n \"curator\": null,\n \"curator_id\": null,\n \"date_created\": \"2023-01-01\",\n \"preferred_contact\": \"PHONE\",\n \"payer\": \"\",\n \"statuses\": [\n 225376\n ],\n \"balance_paid\": \"0\",\n \"balance_issued\": \"0\",\n \"last_visit_date\": null,\n \"first_visit_date\": null,\n \"next_visit_date\": null,\n \"family\": null,\n \"insurance_policies\": null,\n \"main_plans_id\": \"1111111\",\n \"plans\": [\n 1111111,2222222\n ],\n \"subclinic\": {\n \"id\": 111,\n \"name\": \"Subclinic name\"\n }\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"55463cbe-de35-489d-9f66-daf81099e9e3"},{"name":"Patient by Phone","event":[{"listen":"test","script":{"id":"2d9278cf-a632-4df5-97ef-bc41cc0a1c8a","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"c3ab03fe-9e76-46b0-9644-9aa37d154d77","exec":[""],"type":"text/javascript","packages":{}}}],"id":"78aca998-8845-421c-9a4b-40417ef0fe94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/patients?phone={{phone_number}}","description":"

Get patient by 1st phone number. {{phone_number}} can be both 380XXXXXXXXX or +380(XX)XXX-XX-XX

\n","urlObject":{"protocol":"https","path":["api","patients"],"host":["cliniccards","com"],"query":[{"description":{"content":"

optional

\n","type":"text/plain"},"key":"phone","value":"{{phone_number}}"}],"variable":[]}},"response":[{"id":"470200cb-d992-4691-941e-55f3cf15fc95","name":"Get Patients by Phone","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/patients?phone={{phone_number}}","protocol":"https","host":["cliniccards","com"],"path":["api","patients"],"query":[{"key":"phone","value":"{{phone_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"patient_id\": \"8840022\",\n \"lastname\": \"Doe\",\n \"firstname\": \"Jane\",\n \"source\": null,\n \"patient_recommendation\": null,\n \"phone\": \"380000000000\",\n \"phone2\": \"\",\n \"discount\": \"0\",\n \"address\": \"\",\n \"email\": \"\",\n \"gender\": null,\n \"important_note\": \"\",\n \"note\": \"\",\n \"code\": \"\",\n \"birthday\": null,\n \"curator\": null,\n \"curator_id\": null,\n \"date_created\": \"0000-00-00\",\n \"preferred_contact\": null,\n \"payer\": \"\",\n \"statuses\": [\n 277792\n ],\n \"balance_paid\": \"250\",\n \"balance_issued\": \"1511.54\",\n \"last_visit_date\": \"2024-09-25 10:30:00\",\n \"first_visit_date\": \"2024-09-25 10:30:00\",\n \"next_visit_date\": null,\n \"family\": null,\n \"insurance_policies\": null,\n \"main_plans_id\": \"3035824\",\n \"plans\": [\n 3035824\n ],\n \"subclinic\": null\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"78aca998-8845-421c-9a4b-40417ef0fe94"},{"name":"Delete Patient","id":"b4d20452-6dac-4530-985b-03e9b1d77e97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"patient_id\": \"1111111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/patients","description":"

Delete a patient by id

patient_id \"string\" REQUIRED

Specifies the patient ID.

\n","urlObject":{"protocol":"https","path":["api","patients"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"da552006-0d27-48b5-8cfa-b20307391ba7","name":"Delete Patient","originalRequest":{"method":"DELETE","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"patient_id\": \"1111111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/patients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"b4d20452-6dac-4530-985b-03e9b1d77e97"}],"id":"87057a33-7bb9-4ca0-9a01-a1b2b82a4cbb","description":"

Get, post, and update information about patients of the clinic.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b809aaad-d455-4330-ba8f-c8b585523c06"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5d0ae5e3-3173-42e0-b907-2ac88cbdc54b"}}],"_postman_id":"87057a33-7bb9-4ca0-9a01-a1b2b82a4cbb"},{"name":"Treatment Plans","item":[{"name":"Plans","event":[{"listen":"test","script":{"id":"e68cd6e0-4c01-464c-b9f5-b293d50407ec","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f4e895a9-6f91-41d1-ba2e-3a7efbc4c8e6","exec":[""],"type":"text/javascript"}}],"id":"35b51dfb-637f-4e89-b539-8f34677a6c14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/plans?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get all plans for a period. The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","plans"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"344322e0-47d3-4838-b8f7-22ead477c207","name":"Get Plans","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/plans?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","plans"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"plan_id\": \"1111111\",\n \"plan_name\": \"Treatment Plan\",\n \"doctor_id\": \"11111\",\n \"date_created\": \"2023-07-13 16:20:31\",\n \"date_edited\": \"2023-07-13 16:21:03\",\n \"plan_total\": \"715\",\n \"plan_total_done\": \"20\",\n \"plan_discount\": \"0\",\n \"plan_total_with_discount\": \"715\",\n \"plan_total_done_with_discount\": \"20\",\n \"stages_list\": {\n \"5656560\": \"Item 1\",\n \"5656561\": \"Item 2\",\n \"5656562\": \"Item 3\"\n }\n },\n {\n \"plan_id\": \"1111112\",\n \"plan_name\": \"Treatment Plan 2\",\n \"doctor_id\": \"22222\",\n \"date_created\": \"2023-07-13 16:21:21\",\n \"date_edited\": \"2023-08-18 10:36:04\",\n \"plan_total\": \"11700\",\n \"plan_total_done\": \"550\",\n \"plan_discount\": \"0\",\n \"plan_total_with_discount\": \"11700\",\n \"plan_total_done_with_discount\": \"550\",\n \"stages_list\": {\n \"5631044\": \"Item 1\",\n \"5631045\": \"Item 2\",\n \"5937949\": \"Item 3\"\n }\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"35b51dfb-637f-4e89-b539-8f34677a6c14"},{"name":"All Plan Items","event":[{"listen":"test","script":{"id":"cab6d91b-f801-4244-a4df-8a25ad0d7b05","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"ab6176d7-be37-4a0f-9d28-31518647ec02","exec":[""],"type":"text/javascript"}}],"id":"0dee6d99-d0c7-40ce-961a-6557f57ecebc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/planItems/{{status}}?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get all treatment plan items for a period. The start and end dates of the period must be in the YYYY-MM-DD format.

Optionally a status can be specified.

Path Parameters

status \"string\" OPTIONAL

One of: NEW, PLANNED_TO_DO, DONE, INVOICED.

Note:
The status INVOICED may replace DONE.
This happens under the SIMPLE financial model, where an invoice is created as soon as a plan item is marked DONE.
Under the STANDARD financial model, the status stays as DONE because no invoice is created automatically.

\n","urlObject":{"protocol":"https","path":["api","planItems","{{status}}"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"4b52e53b-1693-4af8-b7de-7152c719cb2e","name":"Get All Plan Items","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/planItems/{{status}}?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","planItems","{{status}}"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"plan_item_id\": \"55555555\",\n \"patient_id\": \"666666\",\n \"plan_id\": \"8888888\",\n \"stage_id\": \"5555555\",\n \"name\": \"Diagnostics\",\n \"price\": \"100\",\n \"amount\": \"1\",\n \"discount\": \"0\",\n \"price_with_discount\": \"100\",\n \"price_id\": \"333333\",\n \"price_group_id\": \"77715\",\n \"price_group_name\": \"Diagnostics\",\n \"status\": \"NEW\",\n \"date_created\": \"2023-07-13 16:21:03\",\n \"done_by\": null,\n \"done_by_doctor_id\": null,\n \"marked_done_date\": null,\n \"date_invoiced\": null,\n \"purpose\": \"STANDARD\",\n \"paid\": \"0\",\n \"purpose_diagnosis\": null,\n \"invoice_id\": null,\n \"invoice_comment\": null,\n \"payments\": null\n },\n {\n \"plan_item_id\": \"363636363\",\n \"patient_id\": \"2222222\",\n \"plan_id\": \"33333333\",\n \"stage_id\": \"55555555\",\n \"name\": \"Consultation\",\n \"price\": \"5\",\n \"amount\": \"1\",\n \"discount\": \"0\",\n \"price_with_discount\": \"5\",\n \"price_id\": \"9999999\",\n \"price_group_id\": \"77715\",\n \"price_group_name\": \"Diagnostics\",\n \"status\": \"NEW\",\n \"date_created\": \"2023-07-13 16:21:03\",\n \"done_by\": null,\n \"done_by_doctor_id\": null,\n \"marked_done_date\": null,\n \"date_invoiced\": null,\n \"purpose\": \"STANDARD\",\n \"paid\": \"0\",\n \"purpose_diagnosis\": null,\n \"invoice_id\": null,\n \"invoice_comment\": null,\n \"payments\": [\n {\n \"date\": \"2023-07-13 19:15:45\",\n \"amount\": 3,\n \"payment_id\": 11122233\n },\n {\n \"date\": \"2023-07-13 20:21:18\",\n \"amount\": 2,\n \"payment_id\": 11112233\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"0dee6d99-d0c7-40ce-961a-6557f57ecebc"},{"name":"Invoiced Plan Items","event":[{"listen":"test","script":{"id":"6887fd74-faa9-4bcf-be53-0ba77a4e593b","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"296b2e71-d583-4dab-a62d-b6f3ddc89aab","exec":[""],"type":"text/javascript"}}],"id":"6bb8c9f8-85f7-4d8d-9202-f48b7cc155cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/planItems/invoiced?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get all treatment plan items for the period that have been completed and invoiced. The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","planItems","invoiced"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"135c8570-6759-4986-94d4-fa2a171be054","name":"Get Invoiced Plan Items","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/planItems/invoiced?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","planItems","invoiced"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"plan_item_id\": \"3636363636\",\n \"patient_id\": \"1111111\",\n \"plan_id\": \"12121212\",\n \"stage_id\": \"34343434\",\n \"name\": \"Consultation\",\n \"price\": \"20\",\n \"amount\": \"1\",\n \"discount\": \"0\",\n \"price_with_discount\": \"20\",\n \"price_id\": \"975132\",\n \"price_group_id\": \"77715\",\n \"price_group_name\": \"Consultation\",\n \"status\": \"INVOICED\",\n \"date_created\": \"2023-07-13 16:21:03\",\n \"done_by\": \"Some Doctor\",\n \"done_by_doctor_id\": \"50000\",\n \"marked_done_date\": \"2023-07-13 00:00:00\",\n \"date_invoiced\": \"2023-07-13 00:00:00\",\n \"purpose\": \"STANDARD\",\n \"paid\": \"0\",\n \"purpose_diagnosis\": \"\",\n \"invoice_id\": \"3334445\",\n \"invoice_comment\": null,\n \"assistant_ids\": null\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"6bb8c9f8-85f7-4d8d-9202-f48b7cc155cb"}],"id":"d3060948-b0a3-4355-889f-fc8422e40c48","description":"

Get information about treatment plans.

\n","_postman_id":"d3060948-b0a3-4355-889f-fc8422e40c48"},{"name":"Treatment History","item":[{"name":"Stages and comments (text only)","id":"8936a99c-4382-48a4-82c4-2cb25db942fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stages/","description":"

Get all patient stages and stage comments.
If a comment contains file only and no text, a blank comment will be fetched.

Path Parameters

patient_id \"string\" OPTIONAL

Specifies the patient ID.

\n","urlObject":{"protocol":"https","path":["api","stages",""],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"2011222f-e2f8-43f2-9ee3-1731aaf5e578","name":"Stages and comments (text only)","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stages/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"patient_id\": 11639245,\n \"id\": \"28273890\",\n \"date\": \"2025-08-21 15:03:25\",\n \"name\": \"Stage 1\",\n \"text\": null,\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\",\n \"comments\": [\n {\n \"date\": \"2025-08-21 15:03:34\",\n \"text\": \"

Comment 1 under stage 1

\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n },\n {\n \"date\": \"2025-08-21 15:03:42\",\n \"text\": \"

Comment 2 under stage 2

\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n }\n ]\n },\n {\n \"patient_id\": 11639245,\n \"id\": \"28273933\",\n \"date\": \"2025-08-21 15:03:55\",\n \"name\": \"Hidden Stage 2\",\n \"text\": null,\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\",\n \"comments\": [\n {\n \"date\": \"2025-08-21 15:04:13\",\n \"text\": \"

Comment 3 under hidden stage 2

\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n }\n ]\n },\n {\n \"patient_id\": 12053008,\n \"id\": \"28273971\",\n \"date\": \"2025-08-21 15:04:34\",\n \"name\": \"Stage 3\",\n \"text\": null,\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\",\n \"comments\": [\n {\n \"date\": \"2025-08-21 15:05:14\",\n \"text\": \"

Comment 4 under stage 3 (NOTE: comment 5 will be blank — just a file attached)

\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n },\n {\n \"date\": \"2025-08-21 15:06:32\",\n \"text\": \"\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"8936a99c-4382-48a4-82c4-2cb25db942fe"},{"name":"Stages and Comments (text only) by patient ID","id":"c9316cd0-faf3-4e4d-9767-b19ddf6c1e17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stages/{{patient_id}}","description":"

Get stages and stage comments of a specific patient’s treatment history.

Path Parameters

patient_id \"string\" REQUIRED

Specifies the patient ID.

\n","urlObject":{"protocol":"https","path":["api","stages","{{patient_id}}"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"82ff500f-5c59-42f7-8bfd-f81883a7b34c","name":"Stages and Comments (text only) by patient ID","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stages/{{patient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"patient_id\": 11639245,\n \"id\": \"28273890\",\n \"date\": \"2025-08-21 15:03:25\",\n \"name\": \"Stage 1\",\n \"text\": null,\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\",\n \"comments\": [\n {\n \"date\": \"2025-08-21 15:03:34\",\n \"text\": \"

Comment 1 under stage 1

\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n },\n {\n \"date\": \"2025-08-21 15:03:42\",\n \"text\": \"

Comment 2 under stage 2

Comment 3 under hidden stage 2

\",\n \"created_by\": \"Staff 1\",\n \"created_by_id\": \"34458\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"c9316cd0-faf3-4e4d-9767-b19ddf6c1e17"}],"id":"2ab938cd-aac4-4e27-aa0a-4bff4728e8e8","_postman_id":"2ab938cd-aac4-4e27-aa0a-4bff4728e8e8","description":""},{"name":"Patient Finances","item":[{"name":"Add Payment","id":"e02af57b-1e2b-4918-a481-96ea723d0dd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"patient_id\": 1234567,\n\"amount\": 100,\n\"payment_type\": \"CASH\",\n\"issue_date\": \"2023-01-01\",\n\"note\": \"\",\n\"insurance_company_id\": \"\",\n\"cash_desk_id\": \"11830\",\n\"invoice_id\": null,\n\"rate\": 1,\n\"use_cashback\": 1,\n\"subclinics_id\": \"\",\n\"cashback_percent\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/receive-patients-payment","description":"

Receive a payment from a patient.

Body Parameters

patient_id number REQUIRED

Specifies a patient ID.

amount number REQUIRED

Specifies an amount of payment. Can be positive or negative (in case of return payment).

payment_type \"string\" REQUIRED

Specifies a type of payment.

One of: CASH,NON_CASH,CREDIT_CARD,CASHBOX,INSURANCE, CERTIFICATE.

cash_desk_id \"string\" REQUIRED

Specifies the cash desk ID.

invoice_id \"number\"

Specifies the related invoice ID.
If set to null, the payment is not linked to any invoice.
If set to a \"number\", the payment is bound to the corresponding invoice.

rate number REQUIRED

Specifies a currency rate.

use_cashback number REQUIRED

Specifies if the clinic gives a patient cashback.

One of: 0 (NO) or 1 (YES).

issue_date \"string\" REQUIRED

Specifies the date of the payment. Must be in YYYY-MM-DD format.

note \"string\"

Specifies a comment. String length from 1 to 300.

cashback_percent number

Specifies a percent of cashback.

insurance_company_id \"string\"

Specifies an insurance company ID. REQUIRED only if the payment type is \"INSURANCE\".

subclinics_id \"string\"

Specifies a clinic affiliate ID.

\n","urlObject":{"protocol":"https","path":["api","receive-patients-payment"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"cdaf51a4-dc19-4523-901f-db1f9c9679c1","name":"Add Patient Payment","originalRequest":{"method":"POST","header":[{"key":"Token","value":"YOUR API KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n\"patient_id\": 1111111,\n\"amount\": 250,\n\"payment_type\": \"CASH\",\n\"issue_date\": \"2023-01-01\",\n\"note\": \"\",\n\"insurance_company_id\": \"\",\n\"cash_desk_id\": 10000,\n\"rate\": 1,\n\"use_cashback\": 1,\n\"subclinics_id\": \"\",\n\"cashback_percent\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/receive-patients-payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"payment_id\": 8000000,\n \"patient_id\": 1111111,\n \"amount\": 250,\n \"payment_type\": \"Cash\",\n \"cash_desk_id\": 10000,\n \"rate\": 1,\n \"use_cashback\": 1,\n \"issue_date\": \"2023-01-01\",\n \"note\": \"\",\n \"cashback_percent\": 5\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"e02af57b-1e2b-4918-a481-96ea723d0dd4"},{"name":"Payments","event":[{"listen":"test","script":{"id":"8ac20537-96a9-48db-8ca0-0b6537ac981f","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"5674fe81-ea2a-48d4-b173-68fdbbb47dbf","exec":[""],"type":"text/javascript","packages":{}}}],"id":"db78f06c-3836-4af8-b70a-a37ed3887d7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/payments?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get a list of payments for a period. The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","payments"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"b8ca74e3-65c5-44da-8102-d50a20e0f9fd","name":"Get Payments","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/payments?from=2025-04-30&to=2025-04-30","protocol":"https","host":["cliniccards","com"],"path":["api","payments"],"query":[{"key":"from","value":"2025-04-30","description":"required"},{"key":"to","value":"2025-04-30","description":"required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"payment_id\": \"18860011\",\n \"patient_id\": \"11268477\",\n \"subclinics_id\": \"460\",\n \"created_by\": \"Front Office User\",\n \"date\": \"2025-04-30 13:13:01\",\n \"date_created\": \"2025-04-30 13:13:01\",\n \"amount\": \"1\",\n \"insurance_company\": null,\n \"type\": \"CASH\",\n \"note\": \"\",\n \"cash_desk_id\": \"11830\",\n \"invoice_id\": null,\n \"cash_desk\": {\n \"id\": \"11830\",\n \"name\": \"Title\",\n \"company\": null,\n \"currency\": \"UAH\",\n \"type\": \"CASH\",\n \"status\": \"ACTIVE\"\n }\n },\n {\n \"payment_id\": \"18861070\",\n \"patient_id\": \"11178905\",\n \"subclinics_id\": \"460\",\n \"created_by\": \"Front Office User\",\n \"date\": \"2025-04-30 13:33:50\",\n \"date_created\": \"2025-04-30 13:33:50\",\n \"amount\": \"1\",\n \"insurance_company\": null,\n \"type\": \"CASH\",\n \"note\": \"\",\n \"cash_desk_id\": \"11830\",\n \"invoice_id\": \"20734547\",\n \"cash_desk\": {\n \"id\": \"11830\",\n \"name\": \"Title\",\n \"company\": null,\n \"currency\": \"UAH\",\n \"type\": \"CASH\",\n \"status\": \"ACTIVE\"\n }\n },\n {\n \"payment_id\": \"18861139\",\n \"patient_id\": \"11123955\",\n \"subclinics_id\": \"460\",\n \"created_by\": \"Nhuien User A Kao Ki\",\n \"date\": \"2025-04-30 13:35:12\",\n \"date_created\": \"2025-04-30 13:35:12\",\n \"amount\": \"1\",\n \"insurance_company\": null,\n \"type\": \"CASH\",\n \"note\": \"\",\n \"cash_desk_id\": \"11830\",\n \"invoice_id\": \"20734612\",\n \"cash_desk\": {\n \"id\": \"11830\",\n \"name\": \"Рецепція\",\n \"company\": null,\n \"currency\": \"UAH\",\n \"type\": \"CASH\",\n \"status\": \"ACTIVE\"\n }\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"db78f06c-3836-4af8-b70a-a37ed3887d7f"},{"name":"Add Invoice","event":[{"listen":"test","script":{"id":"93296d3a-843e-4a05-b048-d4c17ee5f1c4","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"62f4a1ef-48c6-4812-9d45-109af7f1251d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6e572a95-634b-48c9-8577-a9518778859c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoice_note\": \"Lorem ipsum\",\n \"issuer_id\": 68478,\n \"patient_id\": 11260283,\n \"purpose\": \"STANDARD\",\n \"_comment_purpose\": \"can also be 'PREINVOICE' or 'INSURANCE'\",\n \"purpose_payed\": null,\n \"purpose_payed_date\": null,\n \"purpose_police_id\": null,\n \"purpose_company_id\": null,\n \"purpose_diagnosis\": null,\n \"subclinic_id\": null,\n \"invoice_items\": [\n {\n \"price\": 1,\n \"item_id\": 1146560,\n \"discount\": 0,\n \"quantity\": 1,\n \"price_code\": null,\n \"plan_item_id\": 81928214,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Diagnostic service\"\n },\n {\n \"price\": 1,\n \"item_id\": 1146560,\n \"discount\": 0,\n \"quantity\": 2,\n \"price_code\": null,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Item renamed\"\n }\n ],\n \"assistants\": null,\n \"performers\": [\n {\n \"id\": 68478,\n \"lastname\": \"\",\n \"firstname\": \"\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/invoice/","description":"

Creates an invoice within a specific patient card.

\n","urlObject":{"protocol":"https","path":["api","invoice",""],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"48832064-f9e7-42ee-bc4b-2a04fda19673","name":"Create Invoice","originalRequest":{"method":"POST","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoice_note\": \"Lorem ipsum\",\n \"issuer_id\": 68478,\n \"patient_id\": 11260283,\n \"purpose\": \"STANDARD\",\n \"_comment_purpose\": \"can also be 'PREINVOICE' or 'INSURANCE'\",\n \"purpose_payed\": null,\n \"purpose_payed_date\": null,\n \"purpose_police_id\": null,\n \"purpose_company_id\": null,\n \"purpose_diagnosis\": null,\n \"subclinic_id\": null,\n \"invoice_items\": [\n {\n \"price\": 1,\n \"item_id\": 1146560,\n \"discount\": 0,\n \"quantity\": 1,\n \"price_code\": null,\n \"plan_item_id\": 81928214,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Diagnostic service\"\n },\n {\n \"price\": 1,\n \"item_id\": 1146560,\n \"discount\": 0,\n \"quantity\": 2,\n \"price_code\": null,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Item renamed\"\n }\n ],\n \"assistants\": null,\n \"performers\": [\n {\n \"id\": 68478,\n \"lastname\": \"\",\n \"firstname\": \"\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/invoice/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"amount\": 3,\n \"date_created\": \"2025-05-02\",\n \"fiscal_amount\": null,\n \"fiscal_member_id\": null,\n \"fiscal_member_name\": null,\n \"fiscal_payments\": null,\n \"fiscal_rro_names\": null,\n \"fiscal_state\": null,\n \"id\": 20796019,\n \"invoice_note\": \"Lorem ipsum\",\n \"invoice_type\": \"STANDARD\",\n \"issuer_id\": 68478,\n \"issuer_name\": \"Username\",\n \"patient_id\": 11260283,\n \"purpose\": \"STANDARD\",\n \"purpose_payed\": null,\n \"purpose_payed_date\": null,\n \"purpose_police_id\": 0,\n \"purpose_police_company_name\": null,\n \"serial_number\": null,\n \"stock_invoice_id\": null,\n \"subclinic_id\": null,\n \"subclinic_name\": null,\n \"invoice_items\": [\n {\n \"price\": 1,\n \"item_id\": 1146560,\n \"discount\": 0,\n \"quantity\": 1,\n \"price_code\": null,\n \"plan_item_id\": 82252604,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Diagnostic service\"\n },\n {\n \"price\": 2,\n \"item_id\": 1146560,\n \"discount\": 0,\n \"quantity\": 2,\n \"price_code\": null,\n \"plan_item_id\": 82252605,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Item renamed\"\n }\n ],\n \"assistants\": null,\n \"performers\": [\n {\n \"id\": 68478,\n \"lastname\": \"Provider\",\n \"firstname\": \"Name\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"6e572a95-634b-48c9-8577-a9518778859c"},{"name":"Invoices","event":[{"listen":"test","script":{"id":"93296d3a-843e-4a05-b048-d4c17ee5f1c4","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"62f4a1ef-48c6-4812-9d45-109af7f1251d","exec":[""],"type":"text/javascript"}}],"id":"96856b7d-1fa5-4e4b-9496-95d28e38da01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/invoices?from=YYYY-MM-DD&to=YYYY-MM-DD&patient_id={{patient_id}}","description":"

Get acts of completed work for a period. The start and end dates of the period must be in the YYYY-MM-DD format.
Optionally, a patient ID can be specified.

\n","urlObject":{"protocol":"https","path":["api","invoices"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"patient_id","value":"{{patient_id}}"}],"variable":[]}},"response":[{"id":"01fa9b12-6c05-4b2d-b86c-b587b270e49f","name":"Get Invoices","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/invoices?from=YYYY-MM-DD&to=YYYY-MM-DD&patient_id={{patient_id}}","protocol":"https","host":["cliniccards","com"],"path":["api","invoices"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"},{"key":"patient_id","value":"{{patient_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"amount\": 229,\n \"date_created\": \"2024-01-10\",\n \"fiscal_amount\": 229,\n \"fiscal_member_id\": 50000,\n \"fiscal_member_name\": \"Doctor\",\n \"fiscal_payments\": \"CARD\",\n \"fiscal_rro_names\": [\n \"РРО №1\"\n ],\n \"fiscal_state\": \"PRINTED\",\n \"id\": 11111100,\n \"invoice_note\": \"Some text here\",\n \"invoice_type\": \"SIMPLE\",\n \"issuer_id\": 11000,\n \"issuer_name\": \"Doctor House\",\n \"patient_id\": 6000000,\n \"purpose\": \"STANDARD\",\n \"purpose_payed\": 0,\n \"purpose_payed_date\": null,\n \"purpose_police_id\": 0,\n \"purpose_police_company_name\": \"Some company\",\n \"serial_number\": null,\n \"stock_invoice_id\": null,\n \"subclinic_id\": null,\n \"subclinic_name\": null,\n \"invoice_items\": [\n {\n \"price\": 49,\n \"item_id\": 1302321,\n \"discount\": 2,\n \"quantity\": 1,\n \"price_code\": null,\n \"plan_item_id\": 46464646,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Item name\"\n },\n {\n \"price\": 180,\n \"item_id\": 1302321,\n \"discount\": 20,\n \"quantity\": 2,\n \"price_code\": \"1234\",\n \"plan_item_id\": 46474747,\n \"discount_type\": \"absolute\",\n \"plan_item_name\": \"Item name\"\n }\n ],\n \"assistants\": [\n {\n \"id\": 10000,\n \"lastname\": \"Awesome\",\n \"firstname\": \"Assistant\"\n }\n ],\n \"performers\": [\n {\n \"id\": 30000,\n \"lastname\": \"Awesome\",\n \"firstname\": \"Doctor\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"96856b7d-1fa5-4e4b-9496-95d28e38da01"},{"name":"Receipts","event":[{"listen":"test","script":{"id":"b7dea721-59a3-48f5-a0db-9f29fb99b4aa","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2cf31338-d1f0-4730-9e36-f85df5424d94","exec":[""],"type":"text/javascript"}}],"id":"34997ffe-4298-4881-8981-af06725aa99c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/receipts?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get a list of receipts for a specific period. The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","receipts"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"b96844b6-e2e0-4a9e-978d-d5f08dc1dfb7","name":"Get Receipts","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/receipts?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","receipts"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"999999\",\n \"invoice_id\": \"7777777\",\n \"patient_id\": \"1111111\",\n \"doctor_id\": \"55555\",\n \"pay_method\": \"CASH\",\n \"card_amount\": \"0.00\",\n \"card_payment_id\": \"0\",\n \"cash_amount\": \"100.00\",\n \"cash_payment_id\": \"8888000\",\n \"status\": \"DONE\",\n \"date_created\": \"2023-07-19 14:34:43\",\n \"fiscal_code\": \"TEST-frI_ua\",\n \"fiscal_date\": \"2023-07-19 11:34:44\",\n \"registrator_id\": \"1011\",\n \"invoice_date\": \"2023-07-19 00:00:00\",\n \"receipt_items\": [\n {\n \"cost\": 100,\n \"price\": 100,\n \"discount\": 0,\n \"quantity\": 1,\n \"plan_item_id\": 36714010,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Manipulation\"\n }\n ]\n },\n {\n \"id\": \"9555555\",\n \"invoice_id\": \"8000000\",\n \"patient_id\": \"3333333\",\n \"doctor_id\": \"55555\",\n \"pay_method\": \"CASH\",\n \"card_amount\": \"0.00\",\n \"card_payment_id\": \"0\",\n \"cash_amount\": \"100.00\",\n \"cash_payment_id\": \"8181818\",\n \"status\": \"DONE\",\n \"date_created\": \"2023-07-19 15:15:59\",\n \"fiscal_code\": \"TEST-e-o7G9\",\n \"fiscal_date\": \"2023-07-19 12:16:00\",\n \"registrator_id\": \"1000\",\n \"invoice_date\": \"2023-07-19 00:00:00\",\n \"receipt_items\": [\n {\n \"cost\": 100,\n \"price\": 100,\n \"discount\": 0,\n \"quantity\": 1,\n \"plan_item_id\": 8888888,\n \"discount_type\": \"percent\",\n \"plan_item_name\": \"Manipulation\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"34997ffe-4298-4881-8981-af06725aa99c"},{"name":"Add Deposit","id":"beedf01a-9501-4fc3-810c-ba48079a607a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"patient_id\": 1111111,\n \"amount\": 100,\n \"cash_desk_id\": 22222,\n \"issue_date\": \"2023-08-02\",\n \"comment\": \"Deposit\",\n \"return\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/save-deposit","description":"

Save a payment from a patient to a deposit.

Body Parameters

patient_id number REQUIRED

Specifies a patient ID.

amount number REQUIRED

Specifies the amount of a deposit.

cash_desk_id \"string\" REQUIRED

Specifies the cash desk ID.

issue_date \"string\" REQUIRED

Specifies the date of the payment. Must be in YYYY-MM-DD format.

comment \"string\"

Specifies a comment. String length from 1 to 300.

return boolean

Specifies a return payment.

Default: false

\n","urlObject":{"protocol":"https","path":["api","save-deposit"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"6c70151d-6393-40a0-9685-33f9fcb1c940","name":"Add Deposit","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"patient_id\": 1111111,\n \"amount\": 100,\n \"cash_desk_id\": 22222,\n \"issue_date\": \"2023-08-02\",\n \"comment\": \"Deposit\",\n \"return\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/save-deposit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 140000,\n \"clinic_id\": 33333,\n \"doctor_id\": 50000,\n \"patient_id\": 1111111,\n \"cash_desk_id\": 22222,\n \"currency\": \"UAH\",\n \"amount\": 100,\n \"return\": false,\n \"issue_date\": \"2023-08-02 12:39\",\n \"comment\": \"Deposit\"\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"beedf01a-9501-4fc3-810c-ba48079a607a"},{"name":"Deposits","id":"ea3ad294-1b10-44b3-8d6b-a9f226c8611c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/deposits-list/{{patient_id}}","description":"

Get patients’ payments to a deposit.

Path Parameters

patient_id \"string\" REQUIRED

Specifies the patient ID.

\n","urlObject":{"protocol":"https","path":["api","deposits-list","{{patient_id}}"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"b57b2f28-dbcf-47e1-bd1f-d40b935d3527","name":"Get Deposits","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/deposits-list/{{patient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 111111,\n \"clinic_id\": 22222,\n \"doctor_id\": 33333,\n \"patient_id\": 1200000,\n \"cash_desk_id\": 11000,\n \"currency\": \"UAH\",\n \"amount\": 100,\n \"return\": true,\n \"issue_date\": \"2023-08-02 14:05:00\",\n \"comment\": \"Return\"\n },\n {\n \"id\": 111112,\n \"clinic_id\": 22222,\n \"doctor_id\": 30000,\n \"patient_id\": 1200000,\n \"cash_desk_id\": 11000,\n \"currency\": \"UAH\",\n \"amount\": 200,\n \"return\": false,\n \"issue_date\": \"2023-08-02 14:06:00\",\n \"comment\": \"Deposit\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"ea3ad294-1b10-44b3-8d6b-a9f226c8611c"}],"id":"59e7c694-7dbc-4483-b165-76fae6f922b5","description":"

Get and create patients' payments.

\n","_postman_id":"59e7c694-7dbc-4483-b165-76fae6f922b5"},{"name":"Clinic Structure","item":[{"name":"Staff","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"c7378b57-b1ad-49d6-bbd5-6ea0d85c0147"}}],"id":"c31b8ae4-b3b1-4da5-b06c-407304cd3507","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/staff","description":"

Get a list of the clinic staff.

\n","urlObject":{"protocol":"https","path":["api","staff"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"5448bc34-9e98-465b-8a62-4b2de79a55c1","name":"Get Staff","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/staff"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"doctor_id\": \"11111\",\n \"lastname\": \"Jane\",\n \"firstname\": \"Doe\",\n \"date_added\": \"2023-07-13 16:16:55\",\n \"color\": \"7\",\n \"role\": \"MANAGER\",\n \"order_index\": \"0\",\n \"phone\": \"+111111111111\"\n },\n {\n \"doctor_id\": \"22222\",\n \"lastname\": \"John\",\n \"firstname\": \"Doe\",\n \"date_added\": \"2023-07-15 18:06:39\",\n \"color\": \"9\",\n \"role\": \"DOCTOR\",\n \"order_index\": \"0\",\n \"phone\": \"+222222222222\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"c31b8ae4-b3b1-4da5-b06c-407304cd3507"},{"name":"Сabinets","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"408a59fc-c1dc-4c6d-9936-8625a7941e04"}}],"id":"20f765d6-15c7-4667-9f90-e7f8e2cd9240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/cabinets","description":"

Get doctors’ offices at the clinic.

\n","urlObject":{"protocol":"https","path":["api","cabinets"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"d0c04378-c938-45be-a888-156beb654909","name":"Get Сabinets","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/cabinets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"cabinet_id\": \"10000\",\n \"name\": \"Office 1\",\n \"date_added\": \"2023-07-13 16:16:55\",\n \"color\": \"1\",\n \"order_index\": \"0\"\n },\n {\n \"cabinet_id\": \"20000\",\n \"name\": \"Office 2\",\n \"date_added\": \"2023-07-14 09:45:34\",\n \"color\": \"1\",\n \"order_index\": \"1\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"20f765d6-15c7-4667-9f90-e7f8e2cd9240"},{"name":"Subclinics","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"bfd974fb-057e-4fa7-8fba-dcd675fbd84b"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"251cacd1-1837-459a-a7b1-b292a9968411"}}],"id":"4900f91a-b375-4f22-87ce-59162c5d940f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/sub-clinics","description":"

Get the clinic’s marks.

\n","urlObject":{"protocol":"https","path":["api","sub-clinics"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"6ee08337-5db7-4cab-9f40-ad9ee95a8db5","name":"Get Subclinics","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/sub-clinics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"555\",\n \"name\": \"Clinic 1\",\n \"address\": \"Some Street, 1\",\n \"ip_address\": \"111.111.111.111\",\n \"date_created\": \"2023-08-08 10:24:05\",\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": \"999\",\n \"name\": \"Clinic 2\",\n \"address\": \"Some Street, 3\",\n \"ip_address\": \"\",\n \"date_created\": \"2023-08-10 13:50:13\",\n \"status\": \"NON_ACTIVE\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"4900f91a-b375-4f22-87ce-59162c5d940f"},{"name":"Patient Statuses","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"8bbb4ced-8161-4dde-95a3-fca27fc129e7"}}],"id":"5027fd07-5f2d-4b63-8482-b200cb81f172","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/patientStatuses","description":"

Get all patients’ statuses at the clinic.

\n","urlObject":{"protocol":"https","path":["api","patientStatuses"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"a4635841-03e6-4680-ba9a-3da156d6a01c","name":"Get Patients' Statuses","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/patientStatuses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"status_id\": \"225555\",\n \"name\": \"New\",\n \"color\": \"1\",\n \"date_added\": \"2023-07-13 16:16:56\",\n \"order_index\": \"1\"\n },\n {\n \"status_id\": \"227777\",\n \"name\": \"Planned\",\n \"color\": \"2\",\n \"date_added\": \"2023-07-13 16:16:56\",\n \"order_index\": \"2\"\n },\n {\n \"status_id\": \"222222\",\n \"name\": \"Done\",\n \"color\": \"4\",\n \"date_added\": \"2023-07-13 16:16:56\",\n \"order_index\": \"4\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"5027fd07-5f2d-4b63-8482-b200cb81f172"},{"name":"Insurance Companies","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"b1f17eb9-5a33-44e3-b732-1ea4c5f7c226"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"6f074427-fca5-4a93-9656-3220f130e63c"}}],"id":"df32e445-54cf-4441-88da-fb4e1b43b82f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/insurance-companies","description":"

Get a list of insurance companies added to the clinic.

\n","urlObject":{"protocol":"https","path":["api","insurance-companies"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"fed871fb-c5cf-4df4-8d94-3c4d2164fd11","name":"Get Insurance Companies","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/insurance-companies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1111\",\n \"status\": \"ACTIVE\",\n \"company_name\": \"Іnsurance Company\",\n \"date_created\": \"2023-08-07 12:01:50\",\n \"creator_clinics_members_id\": \"50000\",\n \"full_name\": \"Іnsurance Company\",\n \"attributes\": \"22233334444555\",\n \"contact_person\": \"Person\",\n \"discount\": \"4\",\n \"annotation\": \"\",\n \"discount_percent\": \"0\"\n },\n {\n \"id\": \"1333\",\n \"status\": \"NON_ACTIVE\",\n \"company_name\": \"Іnsurance Company2\",\n \"date_created\": \"2023-08-08 09:49:40\",\n \"creator_clinics_members_id\": \"50000\",\n \"full_name\": \"Іnsurance Company2\",\n \"attributes\": \"667778889990\",\n \"contact_person\": \"\",\n \"discount\": \"\",\n \"annotation\": \"\",\n \"discount_percent\": \"0\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"df32e445-54cf-4441-88da-fb4e1b43b82f"}],"id":"40753e88-85e1-48b3-9bd7-749d4e21255a","description":"

Get information about the clinic.

\n","_postman_id":"40753e88-85e1-48b3-9bd7-749d4e21255a"},{"name":"Clinic Operations","item":[{"name":"Reminders","id":"d88a0c45-486e-4e55-8d05-d33a9afe35ee","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true,"connection":true,"accept-encoding":true,"accept":true,"user-agent":true,"host":true,"content-length":true}},"request":{"method":"POST","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"date\": \"YYYY-MM-DD\",\n \"patient_id\": null,\n \"note\": \"Note_content\",\n \"subclinic_id\": null,\n \"executor\": [\"ALL\"],\n \"status\": 1,\n \"priority\": 1\n}\n","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/reminders","description":"

date – required field, format: YYYY-MM-DD

executor:
1 – userID
2 – \"ALL\"
3 – \"MANAGER\"
4 – \"DOCTOR\"
6 – \"ASSISTANT\"
5 – \"ADMINISTRATOR\"
7 – \"OTHER\"

// There may be multiple userID executors.
// Group tagging (ALL, MANAGER, DOCTOR, ASSISTANT, ADMINISTRATOR, OTHER) is limited to a single executor entry

Values for priority:
1 – Normal
2 – High
// Use digits only
// If the priority is not specified or specified incorrectly, the value 1 is set by default.

Values for status:
1 – NEW
2 – DONE
3 – CANCELLED
4 – MOVED
// Use digits only
// If the status is not specified or specified incorrectly, the value 1 is set by default.

\n","urlObject":{"protocol":"https","path":["api","reminders"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"4dddf06a-2bc7-42c6-8771-a2cd0edbf627","name":"Reminders","originalRequest":{"method":"POST","header":[{"key":"Token","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"date\": \"YYYY-MM-DD\",\n \"patient_id\": null,\n \"note\": \"Lorem ipsum...\",\n \"subclinic_id\": null,\n \"executor\": [\"ALL\"],\n \"status\": 1,\n \"priority\": 1\n}\n","options":{"raw":{"language":"json"}}},"url":"https://cliniccards.com/api/reminders"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"reminderId\": \"3681261\"\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"d88a0c45-486e-4e55-8d05-d33a9afe35ee"},{"name":"Reminders","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"fcb3a9f0-9dab-4815-a645-2b6b32ed297c"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"43b8bcd4-b323-4559-a1e5-301a825083bd"}}],"id":"7ca5b888-cdc1-407b-a5c2-222d9c75cd0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/reminders?from=YYYY-MM-DD&to=YYYY-MM-DD&patient_id={{patient_id}}","description":"

Get a list of reminders for a period. The start and end dates of the period must be in the YYYY-MM-DD format.

Optionally a patient ID can be specified.

\n","urlObject":{"protocol":"https","path":["api","reminders"],"host":["cliniccards","com"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"patient_id","value":"{{patient_id}}"}],"variable":[]}},"response":[{"id":"bf8b95db-3a74-43df-8a47-11360db73735","name":"Get Reminders","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/reminders?from=YYYY-MM-DD&to=YYYY-MM-DD&patient_id={{patient_id}}","protocol":"https","host":["cliniccards","com"],"path":["api","reminders"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"},{"key":"patient_id","value":"{{patient_id}}","description":"optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"creator_id\": 11111,\n \"creator_name\": \"Some Doctor\",\n \"date\": \"2023-07-13\",\n \"date_created\": \"2023-07-13\",\n \"executors\": [\n \"ALL\"\n ],\n \"id\": 1101011,\n \"note\": \"Some text\",\n \"patient_id\": 6144339,\n \"priority\": 1,\n \"status\": \"DONE\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"7ca5b888-cdc1-407b-a5c2-222d9c75cd0c"},{"name":"Waiting List","id":"4c70273d-ed68-4030-8b32-c16b997243a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/waitings/?from=YYYY-MM-DD&to=YYYY-MM-DD&status=2&doctor_id={{doctor_id}}&created_by_id={{created_by_id}}&patient_id={{patient_id}}","description":"

Get a list of patients in the waiting line at the clinic for a period.

The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","waitings",""],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"},{"description":{"content":"

optional;\nOne of: 1, 2, 3

\n","type":"text/plain"},"key":"status","value":"2"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"doctor_id","value":"{{doctor_id}}"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"created_by_id","value":"{{created_by_id}}"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"patient_id","value":"{{patient_id}}"}],"variable":[]}},"response":[{"id":"435f6813-7ac8-4323-aeb0-f522f6959bc2","name":"Waitings","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"}],"url":{"raw":"https://cliniccards.com/api/waitings/?from=YYYY-MM-DD&to=YYYY-MM-DD&status=2&doctor_id={{doctor_id}}&created_by_id={{created_by_id}}&patient_id={{patient_id}}","protocol":"https","host":["cliniccards","com"],"path":["api","waitings",""],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"},{"key":"status","value":"2"},{"key":"doctor_id","value":"{{doctor_id}}"},{"key":"created_by_id","value":"{{created_by_id}}"},{"key":"patient_id","value":"{{patient_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"status\": \"2\",\n \"waiting_id\": \"111111\",\n \"patient\": \"Ellie Marisol\",\n \"patient_id\": \"8888899\",\n \"doctor\": \"Awesome Doctor\",\n \"doctor_id\": \"33333\",\n \"created_by\": \"Administrator\",\n \"created_by_id\": \"22222\",\n \"date_created\": \"2024-02-19 10:17:14\",\n \"note\": \"Some text here\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"4c70273d-ed68-4030-8b32-c16b997243a0"}],"id":"0c49b003-2c6a-4b4b-9d6e-2de39d8ec141","_postman_id":"0c49b003-2c6a-4b4b-9d6e-2de39d8ec141","description":""},{"name":"Clinic Finances","item":[{"name":"Fee Schedule / Price List","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"e27be362-ea0a-4da8-96ac-99416af052a0"}}],"id":"99e75edc-b1e5-4575-b170-d9f66dbb0fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/prices","description":"

Get the price list of the clinic.

\n","urlObject":{"protocol":"https","path":["api","prices"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"b77f5d73-e44f-4a0a-8990-9d39ea0e180f","name":"Get Prices","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/prices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"group_id\": \"77777\",\n \"group_name\": \"Consultation\",\n \"group_color\": \"1\",\n \"group_additional\": null,\n \"item_id\": \"999999\",\n \"item_name\": \"Consultation\",\n \"item_code\": \"1233\",\n \"item_additional\": null,\n \"item_price\": \"20\"\n },\n {\n \"group_id\": \"77778\",\n \"group_name\": \"Diagnostics\",\n \"group_color\": \"1\",\n \"group_additional\": null,\n \"item_id\": \"977777\",\n \"item_name\": \"Diagnostics\",\n \"item_code\": null,\n \"item_additional\": null,\n \"item_price\": \"100\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"99e75edc-b1e5-4575-b170-d9f66dbb0fbc"},{"name":"Ledgers / Cash Desks","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"17674398-5f1b-47f7-9855-05002dab5b57"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"037c29d2-4b97-451d-8257-2034d772814d"}}],"id":"049df121-5f32-4aed-869d-7a79a2bbb1b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/cash-desks","description":"

Get a list of ledgers.

\n","urlObject":{"protocol":"https","path":["api","cash-desks"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"0112b372-2365-495b-b531-61924b6cab07","name":"Get Ledgers (Cash Desks)","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/cash-desks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 11111,\n \"name\": \"CashDesk 1\",\n \"company_name\": \"Company\",\n \"currency\": \"UAH\",\n \"type\": \"CASH\",\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": 12222,\n \"name\": \"CashDesk 1\",\n \"company_name\": \"Company\",\n \"currency\": \"UAH\",\n \"type\": \"CASHLESS\",\n \"status\": \"NON_ACTIVE\"\n },\n {\n \"id\": 13333,\n \"name\": \"CashDesk 3\",\n \"company_name\": null,\n \"currency\": \"EUR\",\n \"type\": \"CASH\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"049df121-5f32-4aed-869d-7a79a2bbb1b8"},{"name":"Expenses","id":"493e8642-bdc0-49f8-b357-b5ca0d4c68d5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"connection":true,"accept-encoding":true}},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/spendings/{{spendingsId}}/?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get a list of spendings for a period or by spendingsId. The start and end dates of the period must be in the YYYY-MM-DD format.

Optionally a spending ID can be specified.

\n","urlObject":{"protocol":"https","path":["api","spendings","{{spendingsId}}",""],"host":["cliniccards","com"],"query":[{"description":{"content":"

required (if spendingsId is empty)

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required (if spendingsId is empty)

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"175fb700-30d6-43b5-98b1-a1ba98b86ad8","name":"Get Spendings","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/spendings/{{spendingsId}}/?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","spendings","{{spendingsId}}",""],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1234567\",\n \"amount\": \"1000\",\n \"paid\": \"1000\",\n \"payment_status\": \"Paid\",\n \"supplier\": {\n \"id\": 11111,\n \"name\": \"Supplier name\"\n },\n \"spendings_category\": {\n \"id\": 22222,\n \"name\": \"Spendings category name\"\n },\n \"spendings_subcategory\": {\n \"id\": 33333,\n \"name\": \"Spendings subcategory name\"\n },\n \"note\": \"\",\n \"date_issued\": \"2024-01-01\",\n \"period_from\": null,\n \"period_to\": null,\n \"member\": null,\n \"created_by\": \"Some Doctor\",\n \"subclinic\": null,\n \"payments\": [\n {\n \"amount\": -1000,\n \"cash_desk_id\": 11111,\n \"payment_type\": \"SPENDING\",\n \"cash_desk_name\": \"Cash desk name\",\n \"cash_desk_type\": \"CASH\"\n }\n ]\n },\n {\n \"id\": \"7654321\",\n \"amount\": \"-200\",\n \"paid\": \"-200\",\n \"payment_status\": \"Paid\",\n \"supplier\": {\n \"id\": 11111,\n \"name\": \"Supplier name\"\n },\n \"spendings_category\": {\n \"id\": 22222,\n \"name\": \"Spendings category name\"\n },\n \"spendings_subcategory\": {\n \"id\": 33333,\n \"name\": \"Spendings subcategory name\"\n },\n \"note\": \"\",\n \"date_issued\": \"2024-01-08\",\n \"period_from\": null,\n \"period_to\": null,\n \"member\": null,\n \"created_by\": \"Some Doctor\",\n \"subclinic\": null,\n \"payments\": [\n {\n \"amount\": 200,\n \"cash_desk_id\": 22222,\n \"payment_type\": \"MONEYBACK\",\n \"cash_desk_name\": \"Cash desk name\",\n \"cash_desk_type\": \"CASH\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}\n"}],"_postman_id":"493e8642-bdc0-49f8-b357-b5ca0d4c68d5"},{"name":"Transactions","id":"139c51da-dfe8-443c-aaab-54535760de74","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/cash-flow-operations?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

This feature allows one to get all the available transations found on https://cliniccards.com/cabinet#cash-flow/grid

\n","urlObject":{"protocol":"https","path":["api","cash-flow-operations"],"host":["cliniccards","com"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"1a0ac94c-f4a0-4776-8e11-b3ce1cc2c035","name":"Get Ledger Operations","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/cash-flow-operations?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","cash-flow-operations"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"date_issued\": \"01.21.2025\",\n \"created_by\": \"X\",\n \"created_by_id\": \"Y\",\n \"cash_desk_name\": \"Z\",\n \"cash_desk_id\": \"XX\",\n \"type\": \"SPENDING\",\n \"amount\": \"11\",\n \"acquiring\": \"0.00\",\n \"currency\": \"USD\",\n \"comment\": \"\",\n \"spendings_category\": null,\n \"spendings_subcategory\": null,\n \"spendings_clinicmember\": null,\n \"spendings_clinicmember_id\": null,\n \"supplier\": null,\n \"patient\": null,\n \"patient_id\": null\n },\n {\n \"date_issued\": \"01.21.2025\",\n \"created_by\": \"YY\",\n \"created_by_id\": \"ZZ\",\n \"cash_desk_name\": \"XXX\",\n \"cash_desk_id\": \"YYY\",\n \"type\": \"SPENDING\",\n \"amount\": \"1\",\n \"acquiring\": \"0.00\",\n \"currency\": \"USD\",\n \"comment\": \"11\",\n \"spendings_category\": null,\n \"spendings_subcategory\": null,\n \"spendings_clinicmember\": null,\n \"spendings_clinicmember_id\": null,\n \"supplier\": null,\n \"patient\": null,\n \"patient_id\": null\n },\n {\n \"date_issued\": \"01.21.2025\",\n \"created_by\": \"XXXX\",\n \"created_by_id\": \"YYYY\",\n \"cash_desk_name\": \"ZZZZ\",\n \"cash_desk_id\": \"XXXXX\",\n \"type\": \"PAYMENT\",\n \"amount\": \"20\",\n \"acquiring\": \"0.00\",\n \"currency\": \"USD\",\n \"comment\": \"\",\n \"spendings_category\": null,\n \"spendings_subcategory\": null,\n \"spendings_clinicmember\": null,\n \"spendings_clinicmember_id\": null,\n \"supplier\": null,\n \"patient\": \"YYYYY\",\n \"patient_id\": \"ZZZZZ\"\n } \n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"139c51da-dfe8-443c-aaab-54535760de74"}],"id":"0794cde3-6aa4-4b5a-bbd2-2dd0f23e247e","description":"

Get information about prices, payments, receipts and invoices.

\n","_postman_id":"0794cde3-6aa4-4b5a-bbd2-2dd0f23e247e"},{"name":"Online Booking","item":[{"name":"Booking Settings","id":"6f158ad8-83f1-49d7-8d6c-0715e46e4246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/booking-settings","description":"

Get information about online booking settings.

\n","urlObject":{"protocol":"https","path":["api","booking-settings"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"6f045a5f-8754-4c3c-849d-f50469434520","name":"Booking Settings","originalRequest":{"method":"GET","header":[{"key":"token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/booking-settings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"booking_title\": \"

Title

\",\n \"booking_description\": \"

Description

\",\n \"booking_interval\": 15,\n \"booking_status\": \"active\",\n \"booking_link\": \"https://cliniccards.com/booking/F6LQZkVLyVBZPx5hChgJeX4HXI24SNQYIq5\",\n \"booking_logo\": \"https://cc-publical.s3.eu-central-1.amazonaws.com/booking/kSuN9bkzbsZ8z2NlTK5_NspA1KQBjPfX-1.jpg\"\n },\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"6f158ad8-83f1-49d7-8d6c-0715e46e4246"},{"name":"Online Bookings","id":"3164ebb7-e328-434a-a193-38a12ad388aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/booking-items","description":"

Get bookings that came through the online booking form.

\n","urlObject":{"protocol":"https","path":["api","booking-items"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"a4927c7e-9988-4fcd-8c7a-50430942b23e","name":"Booking Items","originalRequest":{"method":"GET","header":[{"key":"token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/booking-items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"specialist_id\": \"12345\",\n \"specialist_name\": \"John Doe\",\n \"booking_items\": [\n {\n \"price_item_id\": 1234567,\n \"execution_time\": 15,\n \"price_item_name\": \"Manipulation 1\"\n },\n {\n \"price_item_id\": 7654321,\n \"execution_time\": 60,\n \"price_item_name\": \"Manipulation 2\"\n }\n ]\n },\n\t\t\t\t{\n \"specialist_id\": \"54321\",\n \"specialist_name\": \"Awesome Doctor\",\n \"booking_items\": [\n {\n \"price_item_id\": 1123211,\n \"execution_time\": 10,\n \"price_item_name\": \"Manipulation 1\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"3164ebb7-e328-434a-a193-38a12ad388aa"}],"id":"6b4aa586-3a2f-403b-880d-ba012c0b889a","description":"

Get information about online booking.

\n","_postman_id":"6b4aa586-3a2f-403b-880d-ba012c0b889a"},{"name":"Stock","item":[{"name":"Stock Products","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"04974c53-b07c-428b-a663-14f6b47d6494"}}],"id":"0afeebb1-1e2b-4274-8503-69aac535deb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stock-products","description":"

Get all stock products.

\n","urlObject":{"protocol":"https","path":["api","stock-products"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"70686822-be33-41fd-a804-52f1e6685814","name":"Get Stock Products","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stock-products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"product_id\": \"60600\",\n \"category_id\": \"4040\",\n \"category_name\": \"Category\",\n \"brand_id\": \"10000\",\n \"brand_name\": \"Brand\",\n \"product_name\": \"Product 1\",\n \"measure_id\": \"6\",\n \"dimension_id\": \"1\",\n \"dimensions_value\": \"100\",\n \"code\": \"12345\",\n \"barcode\": \"\",\n \"date_created\": \"2023-07-20 08:51:24\",\n \"measure_name\": \"Pkg\",\n \"dimension_name\": \"g\",\n \"measure_name_full\": \"Packaging\",\n \"dimension_name_full\": \"gram\",\n \"photo\": \"photo.jpg\"\n },\n {\n \"product_id\": \"60600\",\n \"category_id\": \"4100\",\n \"category_name\": \"Category2\",\n \"brand_id\": \"10000\",\n \"brand_name\": \"Brand\",\n \"product_name\": \"Some Product\",\n \"measure_id\": \"2\",\n \"dimension_id\": \"5\",\n \"dimensions_value\": \"100\",\n \"code\": \"123\",\n \"barcode\": \"\",\n \"date_created\": \"2023-07-20 08:51:57\",\n \"measure_name\": \"Vl\",\n \"dimension_name\": \"mL\",\n \"measure_name_full\": \"Vial\",\n \"dimension_name_full\": \"milliliter\",\n \"photo\": \"photo.jpg\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"0afeebb1-1e2b-4274-8503-69aac535deb9"},{"name":"Stock Invoices","event":[{"listen":"test","script":{"id":"7b6cdf19-3b2e-42c6-80f4-4ba8426baae0","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"a6323429-89c1-4e68-96fe-4e3455d2297a","exec":[""],"type":"text/javascript"}}],"id":"b7f416b2-2080-46f3-a4f6-967f8311720b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/stock-invoices?from=YYYY-MM-DD&to=YYYY-MM-DD","description":"

Get a list of stock invoices for a period. Get all treatment plan items for a period. The start and end dates of the period must be in the YYYY-MM-DD format.

\n","urlObject":{"protocol":"https","path":["api","stock-invoices"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"eae8c244-8559-404c-9681-1689ba276b4d","name":"Get Stock Invoices","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://cliniccards.com/api/stock-invoices?from=YYYY-MM-DD&to=YYYY-MM-DD","protocol":"https","host":["cliniccards","com"],"path":["api","stock-invoices"],"query":[{"key":"from","value":"YYYY-MM-DD"},{"key":"to","value":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"invoice_id\": \"111111\",\n \"room_user_id\": \"50000\",\n \"room_user_name\": \"Some User\",\n \"from_room_user_id\": \"0\",\n \"from_room_user_name\": null,\n \"invoice_number\": \"0101-0000000001\",\n \"room_id\": \"1335\",\n \"room_name\": \"Main\",\n \"from_room_id\": \"0\",\n \"from_room_name\": null,\n \"supplier_id\": \"24242\",\n \"supplier_name\": \"Supplier\",\n \"supplier_edrpou\": null,\n \"total_price\": \"2000.5\",\n \"comments\": null,\n \"type\": \"INCOME\",\n \"date\": \"2023-07-20\",\n \"date_create\": \"2023-07-20 08:53:32\",\n \"invoice_items\": [\n {\n \"id\": 1777777,\n \"count\": 7,\n \"price\": 13.5,\n \"measure_id\": 6,\n \"product_id\": 66666,\n \"total_price\": 94.5,\n \"dimension_id\": 1,\n \"dimension_type\": \"MEASURE\",\n \"dimension_value\": 100,\n \"measure_name\": \"Pkg\",\n \"dimension_name\": \"g\"\n },\n {\n \"id\": 1122222,\n \"count\": 10,\n \"price\": 20,\n \"measure_id\": 2,\n \"product_id\": 61111,\n \"total_price\": 200,\n \"dimension_id\": 5,\n \"dimension_type\": \"MEASURE\",\n \"dimension_value\": 100,\n \"measure_name\": \"Vl\",\n \"dimension_name\": \"mL\"\n },\n {\n \"id\": 1199999,\n \"count\": 2,\n \"price\": 15,\n \"measure_id\": 6,\n \"product_id\": 60611,\n \"total_price\": 30,\n \"dimension_id\": 8,\n \"dimension_type\": \"MEASURE\",\n \"dimension_value\": 10,\n \"measure_name\": \"Pkg\",\n \"dimension_name\": \"pc\"\n }\n ]\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"b7f416b2-2080-46f3-a4f6-967f8311720b"}],"id":"724fa9f7-4f3c-4e7c-b701-e5a00f35d0a5","description":"

Get information about stock items and stock invoices.

\n","_postman_id":"724fa9f7-4f3c-4e7c-b701-e5a00f35d0a5"},{"name":"Files","item":[{"name":"Files by Patient ID","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"3b83962a-d793-4cdd-9b8c-a4612dcec920"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"c07a1363-493a-4306-9699-a432df17a555"}}],"id":"8398d730-eb97-4470-90d5-e4d85229964e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://cliniccards.com/api/files/{{patient_id}}","description":"

Get patient files by patient ID.

Path parameters

patient_id \"string\" REQUIRED

Specifies the patient ID.

\n","urlObject":{"protocol":"https","path":["api","files","{{patient_id}}"],"host":["cliniccards","com"],"query":[],"variable":[]}},"response":[{"id":"5d90c144-d6d3-4674-923e-3a2280596e12","name":"Get Files","originalRequest":{"method":"GET","header":[{"key":"Token","value":"YOUR API KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://cliniccards.com/api/files/{{patient_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"file\": \"djdjjjjf677hhh/0fbf092d10d3365c522470ce5d3338e9.jpg\",\n \"patient_id\": \"111111\",\n \"stage_id\": \"10444444\",\n \"comments_id\": \"13333333\",\n \"is_image\": \"1\",\n \"original\": \"photo.jpg\",\n \"date_uploaded\": \"2023-07-13 16:22:23\"\n },\n {\n \"file\": \"fgghhssh556jjj/a8df0e918addb2e07ec230d21a778892.pdf\",\n \"patient_id\": \"111111\",\n \"stage_id\": \"104444445\",\n \"comments_id\": \"13333335\",\n \"is_image\": \"0\",\n \"original\": \"doc.pdf\",\n \"date_uploaded\": \"2023-07-13 16:22:23\"\n }\n ],\n \"result\": \"success\",\n \"error\": null\n}"}],"_postman_id":"8398d730-eb97-4470-90d5-e4d85229964e"},{"name":"File by Name","event":[{"listen":"test","script":{"id":"cbc197b6-00bf-4a57-82e2-85e53d9a8cc5","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"976f1a81-8613-42cb-95d8-70339493e6d1","exec":[""],"type":"text/javascript"}}],"id":"8b7433bc-e154-42a3-aa0c-45fd504283cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://cliniccards.com/api/file?name={{file_name}}","description":"

Get a single file by its name.

\n","urlObject":{"protocol":"https","path":["api","file"],"host":["cliniccards","com"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"name","value":"{{file_name}}"}],"variable":[]}},"response":[],"_postman_id":"8b7433bc-e154-42a3-aa0c-45fd504283cc"}],"id":"8a91c58d-e5fc-4e2b-978f-8691f5c006ac","description":"

Get patient files.

\n","_postman_id":"8a91c58d-e5fc-4e2b-978f-8691f5c006ac"}]}