---
title: "View guarantor balances"
method: GET
path: "/guarantor_balances"
tags: ["Balances"]
---

# View guarantor balances

`GET /guarantor_balances`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/guarantor_balances`
- Auth: API key in header `Authorization`

This endpoint returns the guarantor balances for the specified location. At least one of the guarantor_id or updated_since filters must be provided

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `sort` string
- `guarantor_id` integer
- `updated_since` string, date-time
- `show_zero_balances` boolean
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesLedgerGuarantorBalanceCollectionResponseWithCursor: API_V20240412_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV20240412EntitiesLedgerGuarantorBalance[]
    - `id` integer: Resource id
    - `foreign_id` string: EHR id
    - `guarantor_id` integer, nullable: The ID of the person responsible for paying this balance
    - `location_id` integer, nullable: Guarantor accounts receivable location ID
    - `updated_at` string, date-time: Guarantor Balance update date in UTC
    - `write_off_estimate` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `total_balance` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `insurance_estimate` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `guarantor_portion` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `total_balance_under_30` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `total_balance_31_60` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `total_balance_61_90` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `total_balance_over_90` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
  - `page_info` object: Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api/revisions/a180e830b672?raw)