> ## 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 toll transaction
> Retrieve a single toll transaction by ID, including transponder, driver, unit, plaza, timestamp, amount, and the trip or load the toll is tied to.
The Retrieve Toll Transaction by ID API endpoint allows you to retrieve detailed information about a specific toll transaction using its unique ID. This endpoint provides comprehensive data about the toll transaction, facilitating effective tracking and management within the Alvys system.
### Request Parameters
The following parameters are required in the URL path:
| Parameter | Type | Required | Description |
| --------- | ------ | -------- | ---------------------------------------------- |
| version | String | Yes | The API version to use. |
| id | String | Yes | The unique identifier of the toll transaction. |
#### Example CURL request
```bash theme={null}
curl --location 'https://integrations.alvys.com/api/p/v{version}/tolls/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```
Replace `{version}` with the API version number, `{id}` with the actual toll ID, and `YOUR_ACCESS_TOKEN` with your actual Bearer token:
```bash theme={null}
curl --location 'https://integrations.alvys.com/api/p/v1/tolls/00c8d000-00c0-0000-ba60-000e0f0e0ae0' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....'
```
### Response Parameters
The following table lists the parameters included in the response for toll transaction-related requests:
| Parameter | Type | Required | Description |
| ----------------------- | ------------------ | -------- | --------------------------------------------------------------- |
| Id | String | Yes | The unique identifier of the toll transaction. |
| SubsidiaryId | String | No | The subsidiary ID associated with the transaction. |
| TransactionId | String | No | The external transaction ID from the toll provider. |
| TransponderId | String | No | The transponder ID associated with the transaction. |
| Source | String | Yes | The toll provider (e.g., PrePass, BestPass, IPass). |
| Agency | String | Yes | The tolling agency that issued the transaction. |
| UnitId | String | No | The Alvys unit ID associated with the transaction. |
| UnitNumber | String | No | The unit number associated with the transaction. |
| LicenseState | String | No | The state where the vehicle is licensed. |
| LicensePlate | String | No | The license plate of the vehicle. |
| PrePaid | Boolean | Yes | Indicates whether the toll was prepaid. |
| Service | String | No | The toll road or service (e.g., Texas Toll Roads, PA Turnpike). |
| CostCenter | String | No | The cost center associated with the transaction. |
| EntryLane | String | No | The lane used at entry. |
| EntryPlazaId | String | No | The identifier of the entry plaza. |
| EntryPlazaName | String | No | The name of the entry plaza. |
| EntryTime | String (Date-Time) | No | The date and time of entry. |
| ExitLane | String | No | The lane used at exit. |
| ExitPlazaId | String | No | The identifier of the exit plaza. |
| ExitPlazaName | String | No | The name of the exit plaza. |
| ExitTime | String (Date-Time) | No | The date and time of exit. |
| FormattedLocation | String | No | The formatted location of the toll transaction. |
| Amount | Object | Yes | The toll amount. |
| Amount.Amount | Number | Yes | The monetary value of the toll. |
| Amount.Currency | Integer | Yes | The currency identifier of the toll amount. |
| RunningBalance | Object | No | The running account balance after the transaction. |
| RunningBalance.Amount | Number | No | The monetary value of the running balance. |
| RunningBalance.Currency | Integer | No | The currency identifier of the running balance. |
| Fee | Object | No | The fee charged for the transaction. |
| Fee.Amount | Number | No | The monetary value of the fee. |
| Fee.Currency | Integer | No | The currency identifier of the fee. |
| PostedAt | String (Date-Time) | No | The date and time when the transaction was posted. |
| TransactionDate | String (Date-Time) | Yes | The date and time when the toll transaction occurred. |
#### Example Response
On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code.
#### 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](/docs/rate-limits) section.
This page is interactive, allowing you to try a request by providing the toll transaction ID in the URL path. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.
## OpenAPI
````yaml GET /api/p/v{version}/tolls/{id}
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}/tolls/{id}:
get:
tags:
- Tolls
summary: Get toll transaction
parameters:
- name: id
in: path
required: true
schema:
type: string
- 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.Tolls.TollDto'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
'403':
description: Forbidden
content:
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.Tolls.TollDto:
required:
- Agency
- Amount
- Id
- PrePaid
- Source
- TransactionDate
type: object
properties:
Id:
type: string
SubsidiaryId:
type: string
nullable: true
TransactionId:
type: string
nullable: true
TransponderId:
type: string
nullable: true
Source:
type: string
Agency:
type: string
UnitId:
type: string
nullable: true
UnitNumber:
type: string
nullable: true
LicenseState:
type: string
nullable: true
LicensePlate:
type: string
nullable: true
PrePaid:
type: boolean
Service:
type: string
nullable: true
CostCenter:
type: string
nullable: true
EntryLane:
type: string
nullable: true
EntryPlazaId:
type: string
nullable: true
EntryPlazaName:
type: string
nullable: true
EntryTime:
type: string
format: date-time
nullable: true
ExitLane:
type: string
nullable: true
ExitPlazaId:
type: string
nullable: true
ExitPlazaName:
type: string
nullable: true
ExitTime:
type: string
format: date-time
nullable: true
FormattedLocation:
type: string
nullable: true
Amount:
allOf:
- $ref: '#/components/schemas/Alvys.Money'
RunningBalance:
allOf:
- $ref: '#/components/schemas/Alvys.Money'
nullable: true
Fee:
allOf:
- $ref: '#/components/schemas/Alvys.Money'
nullable: true
PostedAt:
type: string
format: date-time
nullable: true
TransactionDate:
type: string
format: date-time
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.Money:
required:
- Amount
type: object
properties:
Amount:
type: number
format: double
Currency:
type: integer
format: int32
nullable: true
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 `.
````