Get driver settlement statement

GET

api

{version}

driver-settlement-statements

{number}

Get driver settlement statement

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "Number": 123,
  "Status": "<string>",
  "StatementDate": "<string>",
  "PayPeriodId": "<string>",
  "PayPeriodTitle": "<string>",
  "Driver": {
    "Id": "<string>",
    "Name": "<string>",
    "Type": "<string>",
    "SubsidiaryId": "<string>",
    "CompanyName": "<string>",
    "FleetName": "<string>"
  },
  "Totals": {
    "GrossIncome": {
      "Amount": 123,
      "Currency": 123
    },
    "NetIncome": {
      "Amount": 123,
      "Currency": 123
    },
    "LineHaul": {
      "Amount": 123,
      "Currency": 123
    },
    "Accessorials": {
      "Amount": 123,
      "Currency": 123
    },
    "Echecks": {
      "Amount": 123,
      "Currency": 123
    },
    "ServiceFee": {
      "Amount": 123,
      "Currency": 123
    },
    "DriverPayment": {
      "Amount": 123,
      "Currency": 123
    },
    "Deductions": {
      "Amount": 123,
      "Currency": 123
    },
    "Reimbursements": {
      "Amount": 123,
      "Currency": 123
    },
    "Credits": {
      "Amount": 123,
      "Currency": 123
    },
    "Escrow": {
      "Amount": 123,
      "Currency": 123
    },
    "Fuel": {
      "Amount": 123,
      "Currency": 123
    },
    "Tolls": {
      "Amount": 123,
      "Currency": 123
    },
    "Bonus": {
      "Amount": 123,
      "Currency": 123
    },
    "Shortfall": {
      "Amount": 123,
      "Currency": 123
    },
    "DailyPay": {
      "Amount": 123,
      "Currency": 123
    },
    "DailyPerDiem": {
      "Amount": 123,
      "Currency": 123
    },
    "StatementPerDiem": {
      "Amount": 123,
      "Currency": 123
    },
    "TripValue": {
      "Amount": 123,
      "Currency": 123
    },
    "NumberOfTrips": 123,
    "LoadedMiles": 123,
    "EmptyMiles": 123,
    "HoursWorked": 123
  },
  "LineItems": [
    {
      "Category": "<string>",
      "Title": "<string>",
      "Amount": {
        "Amount": 123,
        "Currency": 123
      },
      "SubLines": [
        {
          "Description": "<string>",
          "Quantity": "<string>",
          "Rate": "<string>",
          "Amount": {
            "Amount": 123,
            "Currency": 123
          }
        }
      ],
      "PolicyName": "<string>",
      "TripNumber": "<string>",
      "LoadNumber": "<string>"
    }
  ]
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

The Get Driver Settlement Statement endpoint returns a single finalized driver or owner-operator settlement statement by its statement number, including its full breakdown of line items and totals. Only settled statements are returned. If the statement does not exist, or is still in-flight (being generated or reversed), the endpoint responds with 404 Not Found. A statement whose Status is Failed is still returned. This endpoint requires the driver:read scope.

Request Parameters

The following parameters are required in the URL path:

Parameter	Type	Required	Description
version	String	Yes	The version of the API being requested.
number	Number	Yes	The statement number to retrieve.

Example CURL Request

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

curl --location 'https://integrations.alvys.com/api/p/v1/driver-settlement-statements/10432' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....'

Response Parameters

Returns a single statement object with the same shape as each item in the Search Driver Settlement Statements response. Monetary values are objects of the form { "Amount": <number>, "Currency": <ISO 4217 numeric code, may be null> }.

Parameter	Type	Description
Number	Number	The statement number.
Status	String	`Processed` or `Failed`.
StatementDate	String	The statement date (ISO `yyyy-MM-dd`).
PayPeriodId	String	The pay period identifier.
PayPeriodTitle	String	The pay period display title.
Driver	Object	Driver details: `Id`, `Name`, `Type` (`COMPANY`, `OWNER_OPERATOR`, or `CONTRACTOR`), `CompanyName`, `SubsidiaryId`, `FleetName`.
Totals	Object	Statement totals (gross/net income, line haul, accessorials, deductions, fuel, tolls, escrow, per-diem, trip/mile counts, etc.).
LineItems	Array of Objects	The individual pay and deduction line items, each with `Category`, `Title`, `PolicyName`, `TripNumber`, `LoadNumber`, `Amount`, and `SubLines`.

Example Response

{
  "Number": 10432,
  "Status": "Processed",
  "StatementDate": "2026-06-20",
  "PayPeriodId": "5d2c1b7a-9f3e-4c8a-8b1d-1a2b3c4d5e6f",
  "PayPeriodTitle": "Jun 16 - Jun 30, 2026",
  "Driver": {
    "Id": "2e17c4d3-202d-4f27-b2fa-711c57435c5b",
    "Name": "John Carter",
    "Type": "OWNER_OPERATOR",
    "CompanyName": "Carter Trucking LLC",
    "SubsidiaryId": "a1b2c3d4-0000-0000-0000-000000000001",
    "FleetName": "West Fleet"
  },
  "Totals": {
    "GrossIncome": { "Amount": 4200.00, "Currency": 840 },
    "NetIncome": { "Amount": 3560.50, "Currency": 840 },
    "LineHaul": { "Amount": 4000.00, "Currency": 840 },
    "Accessorials": { "Amount": 200.00, "Currency": 840 },
    "Deductions": { "Amount": 639.50, "Currency": 840 },
    "Fuel": { "Amount": 400.00, "Currency": 840 },
    "NumberOfTrips": 2,
    "LoadedMiles": 1180.0,
    "EmptyMiles": 95.0,
    "HoursWorked": 0.0
  },
  "LineItems": [
    {
      "Category": "Per Trip",
      "Title": "Line Haul",
      "PolicyName": "OO 70% Line Haul",
      "TripNumber": "TRIP-88213",
      "LoadNumber": "L-55021",
      "Amount": { "Amount": 2800.00, "Currency": 840 },
      "SubLines": [
        { "Description": "70% of $4,000.00", "Quantity": "1", "Rate": "0.70", "Amount": { "Amount": 2800.00, "Currency": 840 } }
      ]
    }
  ]
}

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.

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

number

integer<int32>

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

Number

integer<int32>

required

Status

string

required

StatementDate

string

required

PayPeriodId

string

required

PayPeriodTitle

string

required

Driver

object

required

Show child attributes

Totals

object

required

Show child attributes

LineItems

object[]

required

Show child attributes

⌘I

Get driver settlement statement

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/driver-settlement-statements/{number}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "Number": 123,
  "Status": "<string>",
  "StatementDate": "<string>",
  "PayPeriodId": "<string>",
  "PayPeriodTitle": "<string>",
  "Driver": {
    "Id": "<string>",
    "Name": "<string>",
    "Type": "<string>",
    "SubsidiaryId": "<string>",
    "CompanyName": "<string>",
    "FleetName": "<string>"
  },
  "Totals": {
    "GrossIncome": {
      "Amount": 123,
      "Currency": 123
    },
    "NetIncome": {
      "Amount": 123,
      "Currency": 123
    },
    "LineHaul": {
      "Amount": 123,
      "Currency": 123
    },
    "Accessorials": {
      "Amount": 123,
      "Currency": 123
    },
    "Echecks": {
      "Amount": 123,
      "Currency": 123
    },
    "ServiceFee": {
      "Amount": 123,
      "Currency": 123
    },
    "DriverPayment": {
      "Amount": 123,
      "Currency": 123
    },
    "Deductions": {
      "Amount": 123,
      "Currency": 123
    },
    "Reimbursements": {
      "Amount": 123,
      "Currency": 123
    },
    "Credits": {
      "Amount": 123,
      "Currency": 123
    },
    "Escrow": {
      "Amount": 123,
      "Currency": 123
    },
    "Fuel": {
      "Amount": 123,
      "Currency": 123
    },
    "Tolls": {
      "Amount": 123,
      "Currency": 123
    },
    "Bonus": {
      "Amount": 123,
      "Currency": 123
    },
    "Shortfall": {
      "Amount": 123,
      "Currency": 123
    },
    "DailyPay": {
      "Amount": 123,
      "Currency": 123
    },
    "DailyPerDiem": {
      "Amount": 123,
      "Currency": 123
    },
    "StatementPerDiem": {
      "Amount": 123,
      "Currency": 123
    },
    "TripValue": {
      "Amount": 123,
      "Currency": 123
    },
    "NumberOfTrips": 123,
    "LoadedMiles": 123,
    "EmptyMiles": 123,
    "HoursWorked": 123
  },
  "LineItems": [
    {
      "Category": "<string>",
      "Title": "<string>",
      "Amount": {
        "Amount": 123,
        "Currency": 123
      },
      "SubLines": [
        {
          "Description": "<string>",
          "Quantity": "<string>",
          "Rate": "<string>",
          "Amount": {
            "Amount": 123,
            "Currency": 123
          }
        }
      ],
      "PolicyName": "<string>",
      "TripNumber": "<string>",
      "LoadNumber": "<string>"
    }
  ]
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Example CURL Request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Response

Request Parameters

Example CURL Request

Response Parameters

Example Response

Rate Limits