Charge Create
Create a new Charge for a Patient.
Headers
The tenant you are making this request on behalf of
Your api key
Body
Create a Charge for a Patient. These typically come from balances owed to the Tenant by the Patient (i.e. due to a copay).
Identifier of the patient being charged.
Total outstanding amount that is yet to be paid.
Identifier of the Provider who created the charge (i.e. the Doctor, or relevant Biller).
If you want to bill for an un-itemized amount, set it here.
Description of the charge.
Any discount applied to the total outstanding.
Percentage of discount applied to the charge.
The creation date of the charge in your external system, if applicable.
External identifier for the charge, if applicable.
List of Items in the Charge.
Any additional metadata about the charge relevant to your system.
Indicates if the patient is responsible for processing fees.
Identifier for the RuleSet applied to this Charge, if any.
Current status of the charge.
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, PAYMENT_PLAN Identifier of the Subscription this charge is associated with, if any.
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.