View payments (beta)

get

https://nexhealth.info/payments

🚧
Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query param paid_since.

This endpoint returns the ledger payments for the specified location, narrowed down by the configured filters. At least one of the following filters must be provided: provider_id, patient_id, guarantor_id, claim_id, transaction_id, updated_since, or paid_since.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

patient_id

int32

Filter by the id of the associated patient

provider_id

int32

Filter by the id of the associated provider

guarantor_id

int32

Filter by the id of the associated guarantor

charge_id

int32

Filter by the id of the associated charge

claim_id

int32

Filter by the id of the associated claim

transaction_id

string

Filter by transaction id

updated_since

date-time

Filter for payments updated since a specific time (UTC)

paid_since

date-time

Payments with paid_at after the specified time (UTC)

include_deleted

boolean

Defaults to false

Include deleted payments

sort

string

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

Available fields:

paid_at
-paid_at
updated_at
-updated_at

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

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

Headers

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error