Charge List
Get a list of Charges. You can filter by patientId, total, totalOutstanding, description, status, and external_id.
Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
The field to sort by in snake case, i.e. created_date
The direction to sort by
asc, desc The patient ID to filter by
The status to filter by
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, PAYMENT_PLAN The external ID to filter by
The total to filter by
The total outstanding to filter by
The description to filter by
Response
The date when the charge was created.
Any un-itemized amount that makes up the charge.
Amount of discount applied to the charge.
Percentage of discount applied to the charge.
Unique identifier for the charge.
Summary details of the patient being charged.
Identifier of the patient being charged.
Indicates if the patient is responsible for processing fees.
Current status of the charge.
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, PAYMENT_PLAN Total amount of the charge.
Total outstanding amount that is yet to be paid or adjusted away.
Description of the charge.
The creation date of the charge in your external system, if applicable.
External identifier for the charge, if applicable.
Any additional metadata about the charge relevant to your system.
Identifier for the rule set applied to this charge, if any.