Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NexHealth Balances API

Guarantor and Insurance Balances resources

NexHealth Balances API is one of 33 APIs that NexHealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version v20240412.

Requests are made against a single base URL, https://nexhealth.info.

4 operations 4 paths 14 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v20240412
Base URL
https://nexhealth.info
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

NexHealth Balances API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Balances 4

Guarantor and Insurance Balances resources

GET
/guarantor_balances
View guarantor balances
getGuarantorBalances 10 params → 200400401403500
GET
/guarantor_balances/{id}
View guarantor balance
getGuarantorBalancesId 3 params → 200400401403404500
GET
/insurance_balances
View insurance balances
getInsuranceBalances 10 params → 200400401403500
GET
/insurance_balances/{id}
View insurance balance
getInsuranceBalancesId 3 params → 200400401403404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are API_V20240412_Entities_PatientBasic (19 properties), API_V20240412_Entities_Ledger_GuarantorBalanceDetailed (14 properties), API_V20240412_Entities_Ledger_InsuranceBalance (13 properties), API_V20240412_Entities_Ledger_GuarantorBalance (13 properties). Each schema is shown below with its type and property counts.

API_Errors_InternalServerError
object
APIErrorsInternalServerError model
4 properties
API_Errors_Forbidden
object
APIErrorsForbidden model
4 properties
API_V20240412_Entities_Ledger_GuarantorBalance
object
13 properties
API_Errors_Unauthorized
object
APIErrorsUnauthorized model
4 properties
API_V20240412_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor
object
APIV20240412EntitiesLedgerGuarantorBalanceCollectionResponseWithCursor model
5 properties
API_Errors_BadRequest
object
APIErrorsBadRequest model
4 properties
API_V20240412_Entities_Ledger_InsuranceBalance_Collection_Response_WithCursor
object
APIV20240412EntitiesLedgerInsuranceBalanceCollectionResponseWithCursor model
5 properties
API_V20240412_Entities_Ledger_GuarantorBalanceDetailed
object
14 properties
API_V20240412_Entities_Ledger_GuarantorBalanceDetailed_Response
object
APIV20240412EntitiesLedgerGuarantorBalanceDetailedResponse model
5 properties
API_V2_Entities_Price
object
2 properties
API_Errors_NotFound
object
APIErrorsNotFound model
4 properties
API_V20240412_Entities_Ledger_InsuranceBalance_Response
object
APIV20240412EntitiesLedgerInsuranceBalanceResponse model
5 properties
API_V20240412_Entities_Ledger_InsuranceBalance
object
13 properties
API_V20240412_Entities_PatientBasic
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexhealth-balances-api-openapi.yml Raw ↑

Other APIs NexHealth publishes across the network.

NexHealth Adjustment Types API
NexHealth Adjustments API
NexHealth Appointment Types API
NexHealth Appointments API
NexHealth Authenticates API
NexHealth Available Slots API
NexHealth Charges API
NexHealth Claims API
NexHealth Clinical Notes API
NexHealth Document Types API
NexHealth Fee Schedules API
NexHealth Institutions API