API Reference

List settlement evaluation runs

get
https://api.zondahealth.com/v1/billing/settlements/runs

Returns settlement evaluation runs ordered by requestedAt descending and id descending. Filters are preserved in the opaque cursor and must remain unchanged when requesting the next page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Restricts results to runs requested for the selected evaluation scope.

Allowed:
string

Restricts results to runs associated with this appointment.

string

Restricts results to runs associated with this settlement period.

string

Restricts results to runs associated with this professional.

string

Opaque, URL-safe cursor returned in page.nextCursor. It is bound to the endpoint, tenant, and normalized filters and cannot be reused after filters change.

integer
Defaults to 50

Maximum number of items to return. Defaults to 50 and must be between 1 and 200.

Responses

400

Invalid cursor or page limit

Updated 3 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?