API Reference

View payment plans

get
https://nexhealth.info/payment_plans

This endpoint returns a list of payment plans. You can filter by patient, guarantor, or updated_since. You must provide at least one filter.

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
Defaults to null

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

Responses

Updated about 1 month ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.Nexhealth+json;version=2
Updated about 1 month ago