Skip to main content
POST
Search driver settlement statements
The Search Driver Settlement Statements endpoint returns a paged list of finalized driver and owner-operator settlement statements (the “Statements” tab), each with its full breakdown of line items and totals. It mirrors the in-app “Statements List and Items” report and is intended for external reporting (e.g. building your own dashboards in Power BI). Only settled statements are returned: in-flight statements still being generated or reversed are excluded, and each returned statement carries a Status of Processed or Failed so you can filter downstream. Open and Draft statements are never returned. A statement that failed a downstream step (for example, an accounting sync) is still a finalized statement on the Statements tab, so it is returned here with a Failed status rather than hidden. This differs from carrier settlement statements, where Failed and Deleted are lifecycle statuses and such statements are excluded. This endpoint requires the driver:read scope.

Request Parameters

The following parameter is required in the URL path:

Request Body

Example CURL Request

Use the current API version number and replace the Authorization header value with your actual Bearer token:

Response Parameters

The response is a paged envelope. Each item is a finalized statement. Monetary values are objects of the form { "Amount": <number>, "Currency": <ISO 4217 numeric code, may be null> }.

Example Response


Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section. This page is interactive, allowing you to try a request by completing the fields for the parameters below. As you fill out the parameters, the CURL command on the right side of the page will be automatically updated.

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Body

Page
integer<int32>
required
PageSize
integer<int32>
required
StatementDateRange
object
required
DriverType
string | null
DriverId
string | null

Response

OK

Page
integer<int32>
required
PageSize
integer<int32>
required
Total
integer<int64>
required
Items
object[]
required
Facets
object | null