Get Patient Balance

Returns the patient's total debt, payments, refunds, and outstanding balance grouped by currency. Use it after creating a collection to verify the updated current-account balance.

GET

/:tenantId/patients/:patientId/balance

Query Parameters

Parameter	Type	Description
filter[type]	string	Limits the calculation to debt, income, or refund. Normally omit this to calculate the full balance.
filter[payment_method_id]	integer	Limits the calculation to a payment method.
filter[fulfilled_date][from]	date	Beginning of the transaction date range.
filter[fulfilled_date][to]	date	End of the transaction date range.
filter[has_undistributed_amount]	boolean	Filters records with an undistributed amount.

Response

HTTP 200 OK

{
  "data": [
    {
      "currency": "TRY",
      "total_tab": "2500.00",
      "total_paid": "1000.00",
      "total_refund": "0.00",
      "outstanding_balance": "1500.00",
      "base_amount": false
    },
    {
      "currency": "TRY",
      "total_tab": "2500.00",
      "total_paid": "1000.00",
      "total_refund": "0.00",
      "outstanding_balance": "1500.00",
      "base_amount": true
    }
  ]
}

base_amount: true identifies the row converted to the tenant's default currency. Financial values may be masked when the authenticated user does not have finance permissions.