API Reference

Balances

To start using these endpoints, please email [email protected]

🚧

Supported integrations

For now, balances are only supported for Dentrix, Dentrix Enterprise, Eaglesoft and Open Dental.

Overview

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

Guarantor balance represents the total amount owed, including both the guarantor's portion and the estimated insurance payment. If a guarantor has multiple dependents, their balance reflects outstanding payments across all dependents.

📘

Balance breakdown

This endpoint gives you the total balance amount, but it doesn't let you see which charges contribute to the balance. To identify unpaid charges, refer to this guide.

🚧

Patient balance

The endpoints expose a guarantor's balance across all their dependents, but they don't expose individual patient balance. To calculate that, sum together charges, payments, and adjustments.

Insurance balance represents the total amount insurers owe for a patient’s services (it does not include the guarantor’s portion). If a patient has multiple insurance subscriptions, this sums and exposes the expected amounts across all.

Example use cases

  • Use view guarantor balances to quickly identify guarantors with unpaid balances. It’s useful when building financial dashboards and digital payment collection applications.
  • Use view insurance balances to build insurance aging reports and determine which insurers you need to follow up with.

Sample response

Guarantor balance

{
  "code": false,
  "description": "Description",
  "error": "Error",
  "data": {
    "id": 113,
    "foreign_id": "1",
    "guarantor_id": 115,
    "location_id": 115,
    "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": 2
}

Insurance balance

{
  "code": false,
  "description": "Description",
  "error": "Error",
  "data": {
    "id": 113,
    "patient_id": 115,
    "guarantor_id": 115,
    "location_id": 115,
    "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": 2
}