Skip to main content
GET
cURL

Overview

Returns patient balances from the ledger: outstanding is max(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.

Query Parameters

patientId
string
required

External patient id (org patients.patientIdentifierSystem, or customer-patient-id by default)

Response

Balances fetched successfully

success
boolean
data
object