This endpoint allows you to retrieve detailed information about a specific fuel entry within the Alvys system. The data includes comprehensive details such as vehicle information, fuel card details, and additional metadata.
The endpoint for retrieving fuel information by ID requires specifying the fuel entry's unique ID and the API version in the URL path. This ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.
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 fuel entry. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v{version}/fuel/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number, {id} with the actual fuel ID, and YOUR_ACCESS_TOKEN with your actual Bearer token:
curl --location 'https://integrations.alvys.com/api/p/v1/fuel/43000ba1-b001-408d-b00f-c00f8004add' \
--header 'Authorization: Bearer eLOETt0hFmWxz_1VBt_oYx9YuSVTWCbZjjNUz8DTKN_EPhH12hs3al...'
Response Parameters
The following table lists the parameters included in the response for the fuel-related request:
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | Yes | The unique identifier of the fuel entry. |
| truckNum | String | No | The truck number associated with the fuel entry. |
| vinNumber | String | No | The Vehicle Identification Number. |
| year | Integer | No | The year of the vehicle. |
| make | String | No | The make of the vehicle. |
| model | String | No | The model of the vehicle. |
| licenseNum | String | No | The license number of the vehicle. |
| licenseState | String | No | The state where the vehicle is licensed. |
| plateExpirationDate | String (Date) | No | The expiration date of the license plate. |
| licenseExpirationDate | String (Date) | No | The expiration date of the vehicle's license. |
| status | String | No | The status of the fuel entry. |
| subsidiaryId | String | No | The subsidiary ID associated with the vehicle. |
| numberOfAxles | Integer | No | The number of axles on the vehicle. |
| fleet | Object | No | The fleet information associated with the vehicle. |
| fleet.id | String | No | The unique identifier of the fleet. |
| fleet.name | String | No | The name of the fleet. |
| fleet.invoiceNumberPrefix | String | No | The invoice number prefix for the fleet. |
| grossWeight | Object | No | The gross weight of the vehicle. |
| grossWeight.value | Integer | No | The value of the gross weight. |
| grossWeight. unitOfMeasure | String | No | The unit of measure for the gross weight (e.g., Kilograms). |
| emptyWeight | Object | No | The empty weight of the vehicle. |
| emptyWeight.value | Integer | No | The value of the empty weight. |
| emptyWeight. unitOfMeasure | String | No | The unit of measure for the empty weight (e.g., Kilograms). |
| color | String | No | The color of the vehicle. |
| fuelType | String | No | The type of fuel used by the vehicle. |
| fuelCards | Array | No | A list of fuel cards associated with the vehicle. |
| fuelCards.id | String | No | The unique identifier of the fuel card. |
| fuelCards.cardNumber | String | No | The card number of the fuel card. |
| fuelCards.provider | String | No | The provider of the fuel card. |
| fuelCards.deductFuel | Boolean | No | Indicates whether fuel is deducted. |
| fuelCards. applyFuelDiscount | Boolean | No | Indicates whether a fuel discount is applied. |
| fuelCards.deductFromId | String | No | The ID of the entity from which the fuel is deducted. |
| fuelCards.deductFromName | String | No | The name of the entity from which the fuel is deducted. |
| fuelCards. deductFromSubsidiary | String | No | The subsidiary from which the fuel is deducted. |
| fuelCards. deductFromContractorType | String | No | The contractor type from which the fuel is deducted. |
| insuranceCompany | String | No | The insurance company associated with the vehicle. |
| insurancePolicyNumber | String | No | The insurance policy number. |
| insuranceExpirationDate | String (Date) | No | The expiration date of the insurance policy. |
| inspectionExpirationDate | String (Date) | No | The expiration date of the vehicle inspection. |
| notes | Array | No | An optional list of notes related to the vehicle. |
| notes.id | String | No | The unique identifier of the note. |
| notes.description | String | No | The description of the note. |
| notes.noteType | String | No | The type of the note. |
| notes.time | String (Date-Time) | No | The time the note was created. |
| notes.user | String | No | The user who created the note. |
| createdAt | String (Date-Time) | Yes | The date and time when the fuel entry was created. |
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 section.
This page is interactive, allowing you to try a request by specifying the API version and fuel 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.