Patient Payments
Get Patient Balances
Fetch patient balances from the ledger (PATIENT_AR outstanding, ledger paid, PATIENT_CASH unallocated credits) plus manual charges. Look up by external patientId.
GET
cURL
Overview
Returns patient balances from the ledger: outstanding ismax(0, PATIENT_AR) per claim, paid is ledger PATIENT_AR credits (PATIENT_PAYMENT / OPENING_BALANCE / PATIENT_CREDIT_ALLOCATION), and unallocated credits are the PATIENT_CASH balance. Also returns manual charges.
Look up the patient with your external patientId. Resolution uses the org integration patients.patientIdentifierSystem when set; otherwise Cair’s default https://fhir.cairhealth.com/fhir/identifier/customer-patient-id (cairProfessional and similar).
Authentication
JWT Bearer token from/api/token.
Query Parameters
string
required
External patient id (integration patientIdentifierSystem, or customer-patient-id
by default).
Example
Response
patientPaidAmount and paymentDetails.paymentAmount are ledger paid. netOutstandingBalance is remaining PATIENT_AR. Unallocated credit ids are ledger event ids.
