Get Charges

get/billing/charge/list

Query parameters

patient_idstring nullable

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

idstring nullable

A unique identifier for the charge. Auto-generated if not provided.

patientIdstring required

Identifier of the patient being charged.

totalinteger

Total amount of the charge.

totalOutstandinginteger required

Total outstanding amount that is yet to be paid.

descriptionstring nullable

Description of the charge.

discountAmountinteger nullable

Any discount applied to the total outstanding.

discountPercentagenumber nullable

Percentage of discount applied to the charge.

externalIdstring nullable

External identifier for the charge, if applicable.

externalCreatedDatestring date-time nullable

The creation date of the charge in your external system, if applicable.

ruleSetIdstring nullable

Identifier for the RuleSet applied to this Charge, if any.

createdDatestring date-time nullable

The date when the charge was created.

creatorIdstring nullable

Identifier of the Provider who created the charge (i.e. the Clinician, or relevant Biller).

locationIdstring nullable

Identifier of the Location where the charge was created.

eventIdstring nullable

Identifier of the Event this charge is associated with, if any.

memberIdstring nullable

Identifier of the Member this charge is associated with, if any.

commentstring nullable

Any additional comments about the charge.

metaobject nullable

Any additional metadata about the charge relevant to your system.

merchantAccountIdstring nullable

Identifier of the MerchantAccount this charge is associated with.

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