latestOpenAPI 3.1.12026-08-198571,0002.4 MB

d8d7501dde48

AdminS32

ApiKeys7

Appointments21

getGet a paginated and filtered list of appointments
postCreate a new appointment with schedule item
getGet a single appointment by ID with basic information
putUpdate an existing appointment and optionally its schedule item
deleteDelete an appointment and its schedule item
getGet a single appointment by ID with detailed information (vitals, forms, SOAP notes)
postImport a historical (already-occurred) visit as a Completed appointment (ITE-260). Skips the schedule-conflict check — batch imports of past history are expected to overlap each other and existing bookings. The backing schedule item is created without a location (exempt from the overlap EXCLUDE constraint, invisible to room-scoped calendar views) and stamped CreatedBySource = "import".
getGet discharge document for an appointment
postCheck in an appointment
postUndo a check-in done by mistake (status: CheckedIn → Scheduled)
postStart an appointment (move to in-progress)
postComplete an appointment
getEvaluate the "Missing Before Discharge" safety checklist for an appointment (PAW-628).
postOverride a required discharge-checklist item with a reason (PAW-628). Records an audit entry; the override unblocks the item for completion.
postCancel an appointment
postMark appointment as no-show
getGet all dispensed inventory items for an appointment
getReturns the consent audit trail for the treatment plan attached to this appointment. Returns an empty list when no plan exists. Used by the Chronicle and Schedule consent viewer modals.
patchUpdate the billing status of a dispensed item
patchUpdate a dispensed item's dispense type and prescription details
getGet the previous travel destination for a staff member on a given date. Used for chaining travel appointments (use last destination as next starting point).

AppointmentTypes10

BillableItems5

Breeds5

BulkClientExport2

BulkPatientExport2

CareQueue2

CaseMilestones6

Cases5

ChatExport1

ClientAppInvite3

ClientExport3

Clients5

ClinicConfig29

ClinicSettings2

Clocking6

Compliance1

ConsentDocuments2

DeaBooks9

DeaExport2

DiagnosisTerms1

DiscountCodes7

Drafts7

EdgePrinters3

EdgePrintJobs2

EmailVerification2

Estimates25

ExamTemplates5

Expenses6

Featurebase2

FeatureFlags1

Flowboard10

GroupCodes5

GroupVisits6

Health1

HomeAgain4

IntegrationCredentials15

InternalPrescribing1

InternalWidget1

Inventory23

InventoryApprovals5

InventoryLocations7

Invoices24

JourneyMilestones6

Kiosk4

LabPanels5

Labs16

LocationClosures4

Locations11

Logos7

MedicationRequests7

MentorMetrics5

Metrics31

NpsAnalytics3

Partners6

PatientGroups9

PatientMasses6

PatientProblems4

PatientRecordExport3

Patients20

Payments18

PaymentTokens5

Pharmacies5

Phones2

PriceRules6

Printers6

PrintJobs4

PtoRequests6

PublicNps2

PublicPriceList5

PublicQuestionnaires2

PublicSmsConsent2

PurchaseOrders11

QiEvents9

QuestionnaireResponses6

Questionnaires10

RabiesTags10

RdvmPortal22

Recordings7

RecurringExpenses5

ReferralMessages2

Referrals20

Reminders14

Reports2

RetailItems11

Roles6

RoomDayAssignments3

RxGovernance26

SavedReports5

ScheduleItems10

ServiceCatalog5

Shifts5

ShiftSwaps8

SlotConfigurations6

SmsConsent9

Species5

Subscriptions8

SurgicalRecords8

TagAssignments4

Tags5

TelnyxCallControl1

Templates10

TenantKnowledge4

TimeEntries5

Transparency3

Users11

Vaccinations9

VaccineAdministration3

VaccineCertificateRecords6

VaccineCertificates2

VaccineTypes5

Vendors6

Vitals2

VitalTypes6

Widget17

WidgetChatbot4

WorkItemRules5

WorkTasks13

Appointments

Update the billing status of a dispensed item

patch/Appointments/{id}/dispensed-items/{transactionId}/billing

Path parameters

idstring required

The appointment ID

transactionIdstring required

The inventory transaction ID

Request body

markedForBillingboolean