LUlumahealth
billingCharges

Create a balance charge for a patient

Changed on

Creates a standalone charge against a patient's balance, independent of the appointment upsert flow. Does not require an appointment.

post/billingCharges/balance

Request

Request body

patientstring required

ID of the patient this balance charge is for.

amountnumber required

The balance amount to charge. Must be a positive number.

currencystring

Currency code for the charge. Defaults to the account's payment localization currency, or USD.

appointmentstring

ID of an appointment to associate with this balance charge, if any.

Response

Successful creation

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

amountnumber

The charge amount.

currencystring

Currency code for the charge.

status'planned' | 'billable' | 'billed' | 'aborted'

Lifecycle status of the charge. planned = planned but not yet billed, billable = confirmed by staff and ready to bill, billed = sent to the patient for collection, aborted = wrongfully added or aborted.

lastStatusUpdatedAtstring date-time

When status was last changed.

lastStatusUpdatedBystring

ID of the user who last changed status.

type'copay' | 'balance' | 'custom-appointment-charge' | 'convenience-fee'

The kind of charge. copay = copay amount for the appointment, balance = patient balance tied to the appointment, custom-appointment-charge = custom value added by staff, convenience-fee = a convenience fee charge.

source'manual' | 'integrator' | 'insurance-verification' | 'fixedAmount'

Where the charge originated from. manual = added by staff, integrator = from the EHR, insurance-verification = from the insurance verification process, fixedAmount = created from a fixed copay rule.

descriptionstring

Public description of the charge, visible to the patient.

reasonstring

Internal, staff-only note about the charge. Omitted from patient-facing responses.

appointmentstring

ID of the appointment associated with this charge.

patientstring

ID of the patient associated with this charge.

insuranceVerificationstring

ID of the insurance verification this charge's copay was derived from, if any.

insurancestring

ID of the patient's insurance saved alongside the insurance verification.

paymentStatus'pending' | 'not-paid' | 'paid' | 'partially-paid' | 'refunded'

How much of the charge has been collected.

amountPaidnumber

The amount paid toward this charge so far.

billingTransactionsstring[]

IDs of the billing transactions associated with this charge.

isCreatedByAIboolean

Indicates whether this charge was created or suggested by AI.

hasDiscountboolean

Whether a prompt-pay discount was actually honoured (money captured under it) for this charge. false for a discount that was only ever offered but never paid.

Changes

  • f19aeba84a26Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • d3c75c2a2f1dRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status