Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Balances

View guarantor balances

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

get/guarantor_balances

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • updated_at
  • -updated_at
guarantor_idinteger

Filter by the id of the associated guarantor

updated_sincestring date-time

Guarantor balances updated after the specified time (UTC)

show_zero_balancesboolean

Show guarantor balances with zero total balance

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

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.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

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"
      }
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}