v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Balances

View guarantor balance

This endpoint returns a single guarantor balance

get/guarantor_balances/{id}

Path parameters

idinteger required

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": "Amy.Ramos@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": 105,
      "foreign_id": "100437",
      "foreign_id_type": "--DataSource-",
      "bio": {
        "city": "New York",
        "state": "NY",
        "gender": "Female",
        "zip_code": "20814",
        "new_patient": false,
        "non_patient": true,
        "phone_number": "5163042196",
        "date_of_birth": "1964-05-03",
        "address_line_1": "",
        "address_line_2": "",
        "street_address": "",
        "cell_phone_number": "",
        "home_phone_number": "",
        "work_phone_number": ""
      },
      "last_sync_time": "2024-04-12T10:30:00Z",
      "guarantor_id": 472,
      "billing_type": "Standard Billing - finance charges",
      "chart_id": "017407",
      "preferred_language": "es",
      "provider_id": 23
    }
  },
  "count": 2
}