Skip to main content
POST
Search carrier settlement statements
The Search Carrier Settlement Statements endpoint returns a paged list of finalized carrier settlement statements (the “Statements” tab), each with its per-trip breakdown, line items, payments, and totals. It mirrors the in-app carrier “Statements List and Items” report and is intended for external reporting. Only settled statements are returned - deleted and failed statements are excluded. Each statement identifies its payee (the carrier directly, or a factoring company when the carrier is factored). For carriers, Failed and Deleted are lifecycle statuses, so those statements are excluded from the export. This differs from driver settlement statements, where a Failed status reflects a downstream step failure on an otherwise-finalized statement, which is returned. This endpoint requires the carrier: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
CarrierId
string | null
SubsidiaryId
string | null

Response

OK

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