> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Get driver settlement statement > Retrieve a finalized driver settlement statement from Alvys by statement number, including per-trip breakdown, line items, deductions, and net pay. 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: ```bash theme={null} 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": , "Currency": }`. | 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 ```json theme={null} { "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. ## OpenAPI ````yaml GET /api/p/v{version}/driver-settlement-statements/{number} openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/driver-settlement-statements/{number}: get: tags: - Driver Settlement Statements summary: Get driver settlement statement parameters: - name: number in: path required: true schema: type: integer format: int32 - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Alvys.Models.Settlements.DriverSettlementStatementResponse '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Settlements.DriverSettlementStatementResponse: required: - Driver - LineItems - Number - PayPeriodId - PayPeriodTitle - StatementDate - Status - Totals type: object properties: Number: type: integer format: int32 Status: type: string StatementDate: type: string PayPeriodId: type: string PayPeriodTitle: type: string Driver: allOf: - $ref: >- #/components/schemas/Alvys.Models.Settlements.DriverSettlementStatementResponseDriverDto Totals: allOf: - $ref: >- #/components/schemas/Alvys.Models.Settlements.DriverSettlementStatementResponseTotalsDto LineItems: type: array items: $ref: >- #/components/schemas/Alvys.Models.Settlements.DriverSettlementStatementResponseLineItemDto additionalProperties: false Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Models.Settlements.DriverSettlementStatementResponseDriverDto: required: - Id - Name - SubsidiaryId - Type type: object properties: Id: type: string Name: type: string Type: type: string CompanyName: type: string nullable: true SubsidiaryId: type: string FleetName: type: string nullable: true additionalProperties: false Alvys.Models.Settlements.DriverSettlementStatementResponseTotalsDto: required: - Accessorials - Bonus - Credits - DailyPay - DailyPerDiem - Deductions - DriverPayment - Echecks - EmptyMiles - Escrow - Fuel - GrossIncome - HoursWorked - LineHaul - LoadedMiles - NetIncome - NumberOfTrips - Reimbursements - ServiceFee - Shortfall - StatementPerDiem - Tolls - TripValue type: object properties: GrossIncome: allOf: - $ref: '#/components/schemas/Alvys.Money' NetIncome: allOf: - $ref: '#/components/schemas/Alvys.Money' LineHaul: allOf: - $ref: '#/components/schemas/Alvys.Money' Accessorials: allOf: - $ref: '#/components/schemas/Alvys.Money' Echecks: allOf: - $ref: '#/components/schemas/Alvys.Money' ServiceFee: allOf: - $ref: '#/components/schemas/Alvys.Money' DriverPayment: allOf: - $ref: '#/components/schemas/Alvys.Money' Deductions: allOf: - $ref: '#/components/schemas/Alvys.Money' Reimbursements: allOf: - $ref: '#/components/schemas/Alvys.Money' Credits: allOf: - $ref: '#/components/schemas/Alvys.Money' Escrow: allOf: - $ref: '#/components/schemas/Alvys.Money' Fuel: allOf: - $ref: '#/components/schemas/Alvys.Money' Tolls: allOf: - $ref: '#/components/schemas/Alvys.Money' Bonus: allOf: - $ref: '#/components/schemas/Alvys.Money' Shortfall: allOf: - $ref: '#/components/schemas/Alvys.Money' DailyPay: allOf: - $ref: '#/components/schemas/Alvys.Money' DailyPerDiem: allOf: - $ref: '#/components/schemas/Alvys.Money' StatementPerDiem: allOf: - $ref: '#/components/schemas/Alvys.Money' TripValue: allOf: - $ref: '#/components/schemas/Alvys.Money' NumberOfTrips: type: integer format: int32 LoadedMiles: type: number format: double EmptyMiles: type: number format: double HoursWorked: type: number format: double additionalProperties: false Alvys.Models.Settlements.DriverSettlementStatementResponseLineItemDto: required: - Amount - Category - SubLines - Title type: object properties: Category: type: string Title: type: string PolicyName: type: string nullable: true TripNumber: type: string nullable: true LoadNumber: type: string nullable: true Amount: allOf: - $ref: '#/components/schemas/Alvys.Money' TransactionType: type: string nullable: true enum: - Deposit - Withdrawal description: >- Populated only when `Category` is `Escrow`; `null` for every other line item. `Deposit` means money moved into the driver's escrow account (negative `Amount`); `Withdrawal` means money moved out (positive `Amount`). SubLines: type: array items: $ref: >- #/components/schemas/Alvys.Models.Settlements.DriverSettlementStatementResponseSubLineDto additionalProperties: false Alvys.Money: required: - Amount type: object properties: Amount: type: number format: double Currency: type: integer format: int32 nullable: true additionalProperties: false Alvys.Models.Settlements.DriverSettlementStatementResponseSubLineDto: required: - Amount - Description - Quantity - Rate type: object properties: Description: type: string Quantity: type: string Rate: type: string Amount: allOf: - $ref: '#/components/schemas/Alvys.Money' additionalProperties: false securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- 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 `. ````