Get fuel transaction

GET

api

{version}

fuel

{id}

Get fuel transaction

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

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/fuel/{id}",
  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}/fuel/{id}"

	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))

}

{
  "Id": "<string>",
  "TransactionId": "<string>",
  "Source": "<string>",
  "FuelTotal": {
    "Amount": 123,
    "Currency": 123
  },
  "Fees": {
    "Amount": 123,
    "Currency": 123
  },
  "Discounts": {
    "Amount": 123,
    "Currency": 123
  },
  "Advances": {
    "Amount": 123,
    "Currency": 123
  },
  "Total": {
    "Amount": 123,
    "Currency": 123
  },
  "Quantity": {
    "Value": 123
  },
  "SubsidiaryId": "<string>",
  "SubsidiaryName": "<string>",
  "TruckId": "<string>",
  "TruckNumber": "<string>",
  "DriverId": "<string>",
  "DriverName": "<string>",
  "OwnerOperatorId": "<string>",
  "OwnerOperatorName": "<string>",
  "Type": "<string>",
  "Category": "<string>",
  "Description": "<string>",
  "Location": {
    "Id": "<string>",
    "Name": "<string>",
    "City": "<string>",
    "State": "<string>",
    "Address": "<string>",
    "Country": "<string>"
  },
  "TransactionDate": "2023-11-07T05:31:56Z"
}

{
  "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>"
}

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

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	Description
Id	String	The unique identifier of the fuel transaction.
TransactionId	String	The transaction ID.
SubsidiaryId	String	The subsidiary ID associated with the transaction.
SubsidiaryName	String	The name of the subsidiary associated with the transaction.
TruckId	String	The unique identifier of the truck.
TruckNumber	String	The truck number associated with the transaction.
DriverId	String	The unique identifier of the driver.
DriverName	String	The name of the driver.
OwnerOperatorId	String	The unique identifier of the owner-operator.
OwnerOperatorName	String	The name of the owner-operator.
Source	String	The name of the fuel card provider.
Type	String	The raw fuel type provided by the fuel provider.
Category	String	The internal fuel category (e.g., Diesel, DEF, Cash Advance).
Description	String	The fuel product description provided by the fuel card provider.
Location	Object	The location details of the transaction.
Location.Id	String	The unique identifier of the location.
Location.Name	String	The name of the location.
Location.City	String	The city of the location.
Location.State	String	The state of the location.
Location.Address	String	The address of the location.
Location.Country	String	The country of the location.
FuelTotal	Object	The total fuel amount.
FuelTotal.Amount	Number	The amount of fuel.
FuelTotal.Currency	Integer	The currency of the fuel amount.
Fees	Object	The total fees.
Fees.Amount	Number	The amount of fees.
Fees.Currency	Integer	The currency of the fees amount.
Discounts	Object	The total discounts.
Discounts.Amount	Number	The amount of discounts.
Discounts.Currency	Integer	The currency of the discounts amount.
Advances	Object	The total advances.
Advances.Amount	Number	The amount of advances.
Advances.Currency	Integer	The currency of the advances amount.
Total	Object	The total amount including fuel, fees, discounts, and advances.
Total.Amount	Number	The total amount.
Total.Currency	Integer	The currency of the total amount.
Quantity	Object	Details of the fuel quantity purchased.
Quantity.Value	Number	The numeric value of the fuel purchased.
Quantity.UnitOfMeasure	String	The unit of measure (e.g., Gallons).
TransactionDate	String (date-time)	The date and time of the fuel transaction.

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.

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

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

TransactionId

string

required

Source

string

required

FuelTotal

object

required

Show child attributes

Fees

object

required

Show child attributes

Discounts

object

required

Show child attributes

Advances

object

required

Show child attributes

Total

object

required

Show child attributes

Quantity

object

required

Show child attributes

SubsidiaryId

string | null

SubsidiaryName

string | null

TruckId

string | null

TruckNumber

string | null

DriverId

string | null

DriverName

string | null

OwnerOperatorId

string | null

OwnerOperatorName

string | null

Type

string | null

Category

string | null

Description

string | null

Location

object | null

Show child attributes

TransactionDate

string<date-time> | null

⌘I

Get fuel transaction

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

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/fuel/{id}",
  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}/fuel/{id}"

	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))

}

{
  "Id": "<string>",
  "TransactionId": "<string>",
  "Source": "<string>",
  "FuelTotal": {
    "Amount": 123,
    "Currency": 123
  },
  "Fees": {
    "Amount": 123,
    "Currency": 123
  },
  "Discounts": {
    "Amount": 123,
    "Currency": 123
  },
  "Advances": {
    "Amount": 123,
    "Currency": 123
  },
  "Total": {
    "Amount": 123,
    "Currency": 123
  },
  "Quantity": {
    "Value": 123
  },
  "SubsidiaryId": "<string>",
  "SubsidiaryName": "<string>",
  "TruckId": "<string>",
  "TruckNumber": "<string>",
  "DriverId": "<string>",
  "DriverName": "<string>",
  "OwnerOperatorId": "<string>",
  "OwnerOperatorName": "<string>",
  "Type": "<string>",
  "Category": "<string>",
  "Description": "<string>",
  "Location": {
    "Id": "<string>",
    "Name": "<string>",
    "City": "<string>",
    "State": "<string>",
    "Address": "<string>",
    "Country": "<string>"
  },
  "TransactionDate": "2023-11-07T05:31:56Z"
}

{
  "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>"
}

{
  "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