API Reference

View guarantor balances

get
https://nexhealth.info/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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Supported integrations

For now, this endpoint is only supported for Dentrix, Eaglesoft, and Open Dental.

Query Params
string
required

Used to scope the request to the specified institution

int32
required

Used to scope the request to the specified location

string

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

Available fields:

  • updated_at
  • -updated_at
int32

Filter by the id of the associated guarantor

date-time

Guarantor balances updated after the specified time (UTC)

boolean
Defaults to false

Show guarantor balances with zero total balance

string

First item of the current page. Starts empty

string

Last item of the current page. Starts empty

int32
Defaults to 5

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

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?