GuidesAPI ReferenceChangelog
API Reference

View payments

get
https://nexhealth.info/payments

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
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

int32

Filter by the id of the associated patient

int32

Filter by the id of the associated provider

int32

Filter by the id of the associated guarantor

int32

Filter by the id of the associated charge

int32

Filter by the id of the associated claim

string

Filter by transaction id

date-time

Filter for payments updated since a specific time (UTC)

date-time

Payments with paid_at after the specified time (UTC)

boolean
Defaults to false

Include deleted payments

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
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.

Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

Updated 4 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/json

Updated 4 months ago

Did this page help you?