v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Balances

View insurance balance

This endpoint returns a single insurance balance by its NexHealth id. Responds with a 404 when no insurance balance with this id exists or when it belongs to a location your token cannot access.

get/insurance_balances/{id}

Path parameters

idinteger required

The ID of the insurance balance

Query parameters

subdomainstring required

Used to scope the request to the specified institution

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,
    "patient_id": 115,
    "guarantor_id": 116,
    "location_id": 21,
    "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": 2
}