API Reference

Charges

This endpoint is in beta and as such all content below is subject to change.

🚧

Supported Integrations

For now, charges are only supported for Open Dental and Dentrix.

Charges represent a patient or their insurance plan being charged money for a service provided. Charges are a "debit" meaning they add to the patient balance, increasing the amount the patient owes the practice.

📘

Understanding Charges, Procedures and Appointment relationships

If a charge is associated with a completed procedure, the procedure id may be viewed by adding the query parameter include\[]=procedures to your requests to /charges. However, not all EHRs enforce or even allow this mapping.

Where charges include procedure ids, you may use the procedure id to further associate the charge to a completed appointment (charge.procedure_id -> procedure.appointment_id). For records which have null procedures, you may use the date of the charge as a heuristic to find a corresponding appointment.

Including other associated entities

Similar to associated procedures, associated entity objects can be returned for patient, guarantor, provider, and claim(s) by adding the equivalent query parameter include[] with any combination of patient, provider, guarantor, claims as well as aforementioned procedure(only applicable to single :id query)

For collection queries (/charges), only the id of the associated entities are returned in the response.

Monetary values returned

Charge query response will included the fee value associated with the charge.
In addition, the charge(s) query response may include summed monetary totals, payment_estimate_total, write_off_estimate_total, and write_off_totalassociated with the charge. These values are summed from the insurance claims associated with the charge, dependent on the equivalent values being available in the EHR.

Charge Response Object

For the expected response object definitions, please refer to the 200 response object for View charges and View charge queries.