v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Payment Plans

View payment plans

get/payment_plans

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • updated_at
  • -updated_at
start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

patient_idinteger

Filter by patient

guarantor_idinteger

Filter by guarantor

updated_sincestring date-time

Filter for payment plans updated since a specific time

Response

Successful