Balances

View guarantor balance (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data.guarantor.address, data.guarantor.address.city, data.guarantor.address.line_1, data.guarantor.address.line_2 (+12 more); removes response fields data.guarantor.bio, data.guarantor.last_sync_time.

This endpoint returns a single guarantor balance by its NexHealth ID, with optional sideloading of the associated guarantor.

get/guarantor_balances/{id}

Request

Base URL
https://nexhealth.info
URL
https://nexhealth.info/guarantor_balances/{id}
Auth
API key in header Authorization

Path parameters

idinteger required

NexHealth ID of the guarantor balance

Query parameters

include[]string[]

Resources to be included in the response

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "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": {
      "id": 415,
      "email": "anthony.smith@nexhealth.com",
      "first_name": "John",
      "middle_name": "Anthony",
      "last_name": "Smith",
      "name": "John Smith",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "institution_id": 1,
      "foreign_id": "532e7f8c",
      "foreign_id_type": "--DataSource-",
      "cell_phone_number": "5163042196",
      "preferred_phone_number": "5163042196",
      "billing_type": "Standard Billing - finance charges",
      "chart_id": "017407",
      "preferred_language": "es",
      "gender": "Female",
      "non_patient": true,
      "date_of_birth": "1964-05-03",
      "address": {
        "line_1": "333 Bush Street",
        "line_2": "Apt 4B",
        "postal_code": "20814",
        "city": "New York",
        "region": "NY"
      }
    }
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.