Skip to main content
POST
Search deductions
This endpoint provides detailed information about each deduction that matches the specified search criteria, enabling efficient management and retrieval of deduction records. Deductions are asset-specific financial adjustments and can be associated with either a driver or a truck, but not both simultaneously. Only deductions are returned. Driver credits created through Create driver credit do not appear in these results — this route always filters to deduction-type records, so a credit’s ExternalId never matches either; read a credit by id with Get deduction.
Primary filters are DriverId, TruckId, OwnerOperatorId, and DateRange — at least one of these, or ExternalId, is required. ExternalId narrows an existing search down to the deduction a Create one-time deduction call returned that reference id for, matched on the trimmed value so surrounding whitespace still matches. It can also be sent on its own, without any primary filter, when you only know the reference id.

Request Body Parameters

The following parameters are accepted in the request body:

Example CURL Request

ExternalId sent on its own, without any primary filter:

Response Body Parameters

The following parameters are included in the response body:

Example Response


Versioning

The version parameter in the URL path specifies which version of the API you are using. Including the version number ensures that your integration remains stable as the API evolves. For more details, refer to the Versioning page.

Rate Limits

All endpoints are subject to standard rate limits to ensure consistent API performance. For details, see the Rate Limits section.

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
IncludePaid
boolean
required
DateRange
object | null
DriverId
string | null
TruckId
string | null
OwnerOperatorId
string | null
ExternalId
string | null

Filters to the deduction created with this exact reference id. Matched on the normalized (trimmed) value, same as on create, so surrounding whitespace does not stop a match. This route only returns deductions — a credit created through credits/driver never matches.

Response

OK

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