> ## 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 carrier settlement statement > Retrieve a finalized carrier settlement statement from Alvys by statement number, including per-trip breakdown, line items, payments, and totals. The Get Carrier Settlement Statement endpoint returns a single finalized carrier settlement statement by its statement number, including its per-trip breakdown, line items, payments, and totals. Only settled statements are returned. If the statement does not exist, or is deleted/failed, the endpoint responds with `404 Not Found`. This endpoint requires the `carrier: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/carrier-settlement-statements/1042' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....' ``` ### Response Parameters Returns a single statement object with the same shape as each item in the Search Carrier Settlement Statements response. Monetary values are objects of the form `{ "Amount": , "Currency": }`. | Parameter | Type | Description | | --------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Number | Number | The statement number. | | Status | String | The statement status (e.g. `Processed`, `Paid`). | | StatementDate | String (Date-Time) | The statement date. | | RemittanceDate | String (Date-Time) | The scheduled remittance date. Null if not set. | | SubsidiaryId | String | The subsidiary the statement belongs to. | | Payee | Object | Who gets paid: `Type` (`Carrier` or `FactoringCompany`), `Id`, `Name`, `McNumber`, `DotNumber`. | | RemitTo | String | The resolved remit-to name. Null if not set. | | PaymentProvider | String | The payment provider (e.g. `Standard`, `TriumphPay`). | | NetAmount | Money | The statement net (payable) amount. | | PaidAmount | Money | The amount paid so far. | | RemainingAmount | Money | The amount still outstanding. | | Trips | Array of Objects | Per-trip breakdown, each with `TripId` (stable unique trip identifier, always present), `TripNumber`, `LoadNumber`, `Origin`, `Destination`, pickup/delivery + invoice fields, trip totals, and an `Items` array (`Description`, `Type`, `Amount`, `AccountingTag`). | | Payments | Array of Objects | Recorded payments: `Id`, `Amount`, `PaymentDate`, `PaymentMethod`, `ReferenceNumber`, `CheckNumber`. | ### Example Response ```json theme={null} { "Number": 1042, "Status": "Processed", "StatementDate": "2026-06-15T12:00:00+00:00", "RemittanceDate": "2026-06-20T00:00:00+00:00", "SubsidiaryId": "a1b2c3d4-0000-0000-0000-000000000001", "Payee": { "Type": "FactoringCompany", "Id": "f1a2b3c4-5555-6666-7777-888899990000", "Name": "Factor LLC", "McNumber": null, "DotNumber": null }, "RemitTo": "Factor LLC", "PaymentProvider": "TriumphPay", "NetAmount": { "Amount": 1150.00, "Currency": 840 }, "PaidAmount": { "Amount": 1150.00, "Currency": 840 }, "RemainingAmount": { "Amount": 0.00, "Currency": 840 }, "Trips": [ { "TripId": "b2c3d4e5-1111-2222-3333-444455556666", "TripNumber": "TRIP-1", "LoadNumber": "L-55021", "Origin": "Chicago, IL", "Destination": "Atlanta, GA", "NetAmount": { "Amount": 1150.00, "Currency": 840 }, "LineHaulAmount": { "Amount": 1000.00, "Currency": 840 }, "AccessorialsAmount": { "Amount": 150.00, "Currency": 840 }, "Items": [ { "Description": "Line Haul", "Type": "LineHaul", "Amount": { "Amount": 1000.00, "Currency": 840 }, "AccountingTag": "Carrier Rate" } ] } ], "Payments": [ { "Id": "c3d4e5f6-2222-3333-4444-555566667777", "Amount": { "Amount": 1150.00, "Currency": 840 }, "PaymentDate": "2026-06-21T00:00:00+00:00", "PaymentMethod": "ACH", "ReferenceNumber": "REF-9001", "CheckNumber": null } ] } ```
### 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}/carrier-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}/carrier-settlement-statements/{number}: get: tags: - Carrier Settlement Statements summary: Get carrier 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.CarrierSettlementStatementResponse '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.CarrierSettlementStatementResponse: required: - NetAmount - Number - PaidAmount - Payee - PaymentProvider - Payments - RemainingAmount - StatementDate - Status - SubsidiaryId - Trips type: object properties: Number: type: integer format: int32 Status: type: string StatementDate: type: string format: date-time RemittanceDate: type: string format: date-time nullable: true SubsidiaryId: type: string Payee: allOf: - $ref: >- #/components/schemas/Alvys.Models.Settlements.CarrierSettlementStatementResponsePayeeDto RemitTo: type: string nullable: true PaymentProvider: type: string NetAmount: allOf: - $ref: '#/components/schemas/Alvys.Money' PaidAmount: allOf: - $ref: '#/components/schemas/Alvys.Money' RemainingAmount: allOf: - $ref: '#/components/schemas/Alvys.Money' Trips: type: array items: $ref: >- #/components/schemas/Alvys.Models.Settlements.CarrierSettlementStatementResponseTripDto Payments: type: array items: $ref: >- #/components/schemas/Alvys.Models.Settlements.CarrierSettlementStatementResponsePaymentDto 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.CarrierSettlementStatementResponsePayeeDto: required: - Id - Name - Type type: object properties: Type: type: string Id: type: string Name: type: string McNumber: type: string nullable: true DotNumber: type: string nullable: true 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.CarrierSettlementStatementResponseTripDto: required: - AccessorialsAmount - Items - LineHaulAmount - LoadNumber - NetAmount - TripId - TripNumber type: object properties: TripId: type: string TripNumber: type: string LoadNumber: type: string Origin: type: string nullable: true Destination: type: string nullable: true PickedUpAt: type: string format: date-time nullable: true DeliveredAt: type: string format: date-time nullable: true InvoiceNumber: type: string nullable: true InvoiceDueDate: type: string format: date-time nullable: true NetAmount: allOf: - $ref: '#/components/schemas/Alvys.Money' LineHaulAmount: allOf: - $ref: '#/components/schemas/Alvys.Money' AccessorialsAmount: allOf: - $ref: '#/components/schemas/Alvys.Money' Items: type: array items: $ref: >- #/components/schemas/Alvys.Models.Settlements.CarrierSettlementStatementResponseLineItemDto additionalProperties: false Alvys.Models.Settlements.CarrierSettlementStatementResponsePaymentDto: required: - Amount - Id - PaymentDate type: object properties: Id: type: string Amount: allOf: - $ref: '#/components/schemas/Alvys.Money' PaymentDate: type: string format: date-time PaymentMethod: type: string nullable: true ReferenceNumber: type: string nullable: true CheckNumber: type: string nullable: true additionalProperties: false Alvys.Models.Settlements.CarrierSettlementStatementResponseLineItemDto: required: - AccountingTag - Amount - Description - Type type: object properties: Description: type: string Type: type: string Amount: allOf: - $ref: '#/components/schemas/Alvys.Money' AccountingTag: type: string 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 `. ````