List settlement entries across the organization

get

https://api.zondahealth.com/v1/billing/settlements/entries

Returns a paginated, organization-wide table of settlement entries with statement and professional context. Filters can be combined and are bound to the opaque cursor. Entries are ordered by createdAt and id descending.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

statementId

string

Restricts results to entries belonging to this statement.

periodId

string

Restricts results to entries belonging to statements in this settlement period.

professionalId

string

Restricts results to entries belonging to this professional.

statementStatus

string

enum

Restricts results to entries whose parent statement has this workflow status.

Allowed:

appointmentId

string

Restricts results to entries generated for this appointment.

serviceDateFrom

date

Inclusive lower bound for the entry service date.

serviceDateTo

date

Inclusive upper bound for the entry service date. Must not be earlier than serviceDateFrom.

level

string

enum

Restricts results to entries calculated or adjusted at this level.

Allowed:

componentId

string

Restricts results to entries generated by this policy component.

inclusionStatus

string

enum

Restricts results to entries with this review inclusion decision.

Allowed:

outcomeStatus

string

enum

Restricts results to entries with this calculation outcome.

Allowed:

cursor

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.

limit

integer

Defaults to 50

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

Responses

400

Invalid filters, cursor, or page limit

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Settlement entries