Get patient account balance

Request

Returns the account balance for the patient matching id, for the practice identified by X-Practice-Id. The balance is the account the patient's invoices and payments are posted to. The id is the same patient id returned when listing patients. Monetary amounts are signed. A negative amount means money is owed to the practice. A positive amount means the account is in credit. Some patients share an account, so owning_patient_id in the response is the patient who owns the account. When it differs from the id in the request path, the patient you asked for shares the account of the returned owning_patient_id, and the balances are those of that shared account. If the patient does not exist, has been deleted, or has no account, the API responds with 404. The three cases cannot be told apart. A token without the account:read scope receives 403.

Security

oauth2(Required scopes: account:read)

Path

idstring, (uuid)required

Resource identifier to filter/find.

X-Practice-Idstring, (uuid)required

UUID of the practice in whose context the request is executed. The API uses this to resolve data the caller is permitted to access for that practice.

curl -i -X GET \
  'https://docs.api.dentally.com/_mock/docs/versions/2026-01-01/nexgen/patients/{id}/account' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Account balance for the requested patient.

Bodyapplication/json

dataobject(patient-account)required

The money position of a patient account: what the patient owes the practice, or what the practice holds in credit for them. All amounts are signed. A negative amount means money is owed to the practice. A positive amount means the account is in credit.

Response

Example where the patient owes the practice: monetary amounts in this sample are negative. Accounts in credit have positive amounts.

{
  "data": {
    "owning_patient_id": "550e8400-e29b-41d4-a716-446655440004",
    "balance_amount": -125.5,
    "patient_balance_amount": -100.5,
    "pending_payments_amount": -25,
    "deposit_amount": 0,
    "created_at": "2026-01-05T09:12:44Z",
    "updated_at": "2026-10-02T14:03:10Z"
  }
}