GuidesAPI ReferenceChangelog
API Reference

View payment plans

get
https://nexhealth.info/payment_plans

This endpoint returns payment plans for the specified location; at least one of guarantor_id, patient_id, or updated_since 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
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.

int32

Filter by patient

int32

Filter by guarantor

date-time

Filter for payment plans updated since a specific time

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Updated 3 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/vnd.Nexhealth+json;version=2

Updated 3 months ago

Did this page help you?