Appointment Availability1

Appointment Reminders3

Appointment Types2

Appointments5

Charges6

Deltas1

Drugs3

Encounter Types1

Encounters4

Extended Patient Details1

Facilities1

Health Maintenance2

Inventory4

Partner Applications3

Patient Allergies1

Patient Charges3

Patient Documents5

Patient Emails1

Patient Facilities/Specialists7

Patient Free-Text Notes4

Patient Health Maintenance2

Patient Images5

Patient Invoices2

Patient Lab Results1

Patient Orders2

Patient Past Medical History1

Patient Portal4

Patient Prescriptions5

Patient Subscriptions2

Patient Supplements4

Patient Tags3

Patient Vaccines1

Patient Vitals8

Patients6

Questionnaires3

Secure Messages2

Supplements5

Tags4

Tasks4

Users3

Vitals3

Charges

Get a Single Charge by ID

Retrieve a single patient charge by its ID. This returns the transactional charge details regardless of which patient it belongs to.

get/charges/{charge_id}

Request

Base URL: https://clinic-subdomain.md-hq.com/api/v1
URL: https://clinic-subdomain.md-hq.com/api/v1/charges/{charge_id}
Auth: HTTP basic

Path parameters

charge_idinteger required

The ID of the charge to retrieve.

Query parameters

include_deletedboolean

If true, will return the charge even if it has been deleted. Useful for retrieving historical records.

Response

Successful response

object'patient_charge'

idinteger

namestring

patient_idinteger

encounter_idinteger

amountstring

quantityinteger

discount_multipliernumber

Discount level applied to the charge (1.0 = no discount)

location_identifierstring nullable

additional_detailsstring nullable

notesstring nullable

is_voidedboolean

date_voidedstring nullable

owner_idinteger

addedbyinteger

createdstring datetime

transaction_datestring date

is_deletedboolean

date_deletedstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.