latestOpenAPI 3.0.02026-08-232861531.0 MB
d3c75c2a2f1d
billingCharges
List billing charges
get/billingCharges
Query parameters
status'planned' | 'billable' | 'billed' | 'aborted'
type'copay' | 'balance' | 'custom-appointment-charge' | 'convenience-fee'
source'manual' | 'integrator' | 'insurance-verification' | 'fixedAmount'
paymentStatus'pending' | 'not-paid' | 'paid' | 'partially-paid' | 'refunded'
patientstring
ID of a patient.
appointmentstring
ID of an appointment.
userstring
The ID of the root account user.
deleted0 | 1
Flag for logical deletion where 1 means deleted.
createdBystring
The ID of the user who created this object.
updatedBystring
The ID of the user who updated this object.
createdAtstring date-time
The date/time when this object was created.
updatedAtstring date-time
The date/time when this object was updated.
pageinteger
limitinteger
How many items to fetch per page
_populatestring
Response properties which will be replaced by the referenced objects, separated by commas.
_selectstring
Response properties that should be returned, separated by commas.
Response
List of billing charges. When the caller is authenticated as a patient, the reason field (staff-only) is omitted from each charge.