API ReferenceCharge Capture BundlesV1

Get all Charge Capture Bundles

Beta

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional

Maximum number of entities per page, defaults to 100.

sortenumOptional

Defaults to created_at

Allowed values:
sort_directionenumOptional

Sort direction. Defaults to descending order if not provided.

Allowed values:
page_tokenstringOptional
patient_external_idstringOptional

The patient ID from the external EMR platform for the patient

bundle_statusenumOptional

the status of the charge capture bundle, refers to whether it was able to create an encounter.

charge_statusenumOptional

the status of the charge captures

charge_external_idstringOptional

A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.

date_of_servicedateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

has_charge_capture_updatesbooleanOptional

If true, only return bundles that have charge captures that have been updated since the bundle has had a status of BILLED. See the updates property on ChargeCapture for more details.

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstringOptional
prev_page_tokenstringOptional