API Reference

View insurance balances

get
https://nexhealth.info/insurance_balances

This endpoint returns a list of insurance balances for a location: the amounts insurance is expected to pay, broken into aging buckets. You can filter by patient_id, guarantor_id or updated_since, and must provide at least one of these filters. location_id is always required, but does not satisfy the at-least-one-filter requirement on its own.

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 for balances of a specific patient

int32

Filter for balances of a specific guarantor

date-time

Insurance balances updated at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned

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?