Balances

Before you start

NexHealth reads financial data from the health record system only on request. To turn it on for your API key, email [email protected]. Sandbox locations have it on.
Every request needs a bearer token from POST /authenticates. See Authentication.
Requests take the practice's subdomain and, for most endpoints, a location_id. See Institutions, syncs, and locations.

Overview

The balances endpoints show how much guarantors and insurers owe the practice for a patient’s services. A guarantor is the person financially responsible for a patient.

The guarantor balance is the total amount owed. It includes the guarantor's portion and the estimated insurance payment. If a guarantor has several dependents, the balance covers outstanding payments across all of them.

📘
Balance breakdown
This endpoint gives you the total balance. It does not show which charges make up the balance. To find unpaid charges, see the Payments configuration guide.

🚧
Patient balance
The endpoints return a guarantor's balance across all their dependents. They do not return a balance for one patient. To calculate that, add up charges, payments and adjustments.

The insurance balance is the total amount insurers owe for a patient's services. It does not include the guarantor's portion. If a patient has several insurance subscriptions, it sums the expected amounts across all of them.

Example use cases

Use view guarantor balances to find guarantors with unpaid balances. This is useful for financial dashboards and digital payment collection applications.
Use view insurance balances to build insurance aging reports and find which insurers you need to follow up with.

Balances responses

Guarantor balance

{
  "code": true,
  "description": null,
  "error": null,
  "data": {
    "id": 113,
    "foreign_id": "1",
    "guarantor_id": 115,
    "location_id": 115,
    "updated_at": "2020-06-05T20:16:57.007Z",
    "write_off_estimate": {
      "amount": "62.00",
      "currency": "USD"
    },
    "total_balance": {
      "amount": "62.00",
      "currency": "USD"
    },
    "insurance_estimate": {
      "amount": "62.00",
      "currency": "USD"
    },
    "guarantor_portion": {
      "amount": "62.00",
      "currency": "USD"
    },
    "total_balance_under_30": {
      "amount": "62.00",
      "currency": "USD"
    },
    "total_balance_31_60": {
      "amount": "62.00",
      "currency": "USD"
    },
    "total_balance_61_90": {
      "amount": "62.00",
      "currency": "USD"
    },
    "total_balance_over_90": {
      "amount": "62.00",
      "currency": "USD"
    },
    "guarantor": {
      ...
    }
  },
  "count": null
}

Insurance balance

{
  "code": true,
  "description": null,
  "error": null,
  "data": {
    "id": 113,
    "patient_id": 115,
    "guarantor_id": 115,
    "location_id": 115,
 		"updated_at": "2020-06-05T20:16:57.007Z",
    "estimated_amount_under_30": {
      "amount": "62.00",
      "currency": "USD"
    },
    "estimated_amount_31_60": {
      "amount": "62.00",
      "currency": "USD"
    },
    "estimated_amount_61_90": {
      "amount": "62.00",
      "currency": "USD"
    },
    "estimated_amount_over_90": {
      "amount": "62.00",
      "currency": "USD"
    },
    "billed_amount_under_30": {
      "amount": "62.00",
      "currency": "USD"
    },
    "billed_amount_31_60": {
      "amount": "62.00",
      "currency": "USD"
    },
    "billed_amount_61_90": {
      "amount": "62.00",
      "currency": "USD"
    },
    "billed_amount_over_90": {
      "amount": "62.00",
      "currency": "USD"
    }
  },
  "count": null
}