Adjustments

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

Adjustments change a patient's balance. Practices often use them to apply discounts, subscription fees and insurance write-offs to a patient's ledger. Credits (negative adjustments) reduce the balance. Debits (positive adjustments) increase it.

📘

Debit adjustments

Every debit adjustment needs a link to a provider or a charge. When you create an adjustment, include the charge_splits or provider_splits parameter. If you send neither, the request fails.

Example use cases

• Use the view adjustments, payments and charges endpoints to calculate a patient's balance and find which charges are unpaid. This is useful for an itemized patient bill.
• Create adjustments to add recurring membership fees to a patient's ledger.

Adjustments response

{
  "code": true,
  "description": "Description",
  "error": "Error",
  "data": {
    "id": 113,
    "foreign_id": "1234-5678",
    "location_id": 10,
    "patient_id": 3,
    "guarantor_id": 5,
    "provider_id": 15,
    "updated_at": "2024-09-05T20:31:17.007Z",
    "description": "This is a description",
    "deleted_at": "2024-09-15T11:21:26.003Z",
    "adjustment_amount": {
      "amount": "62.00",
      "currency": "USD"
    },
    "adjusted_at": "2024-10-01",
    "charge_id": 1111,
    "claim_id": 2222,
    "adjustment_type_id": 5,
    "patient": {
      ...
    },
    "provider": {
      ...
    },
    "guarantor": {
      ...
    },
    "claim": {
      ...
    },
    "charge": {
      ...
    },
    "adjustment_type": {
      ...
    },
  },
  "count": 2
}