View 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.
Query parameters
Used to scope the request to the specified institution
Used to scope the request to the specified location
Optional comma-separated string of fields to sort on. Include a leading dash for descending order.
Available fields:
- updated_at
- -updated_at
Filter for balances of a specific patient
Filter for balances of a specific guarantor
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
First item of the current page. Starts empty
Last item of the current page. Starts empty
Number of results to return per page. Maximum allowed amount is 1000.
Headers
The NexHealth API version
Response
Successful
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"
}
}
],
"page_info": {
"has_previous_page": false,
"has_next_page": false,
"start_cursor": "AAAAA",
"end_cursor": "BBBBBB"
}
}