Get mileage summary
curl --request GET \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary', 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://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary",
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://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary"
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))
}HttpResponse<String> response = Unirest.get("https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"years": [
{
"year": 123,
"miles": "<string>",
"business_miles": "<string>",
"personal_miles": "<string>",
"uncategorized_miles": "<string>",
"estimated_deduction": 123,
"trips": 123,
"business_trips": 123,
"personal_trips": 123,
"uncategorized_trips": 123,
"months": [
{
"month": 6,
"miles": "<string>",
"business_miles": "<string>",
"personal_miles": "<string>",
"uncategorized_miles": "<string>",
"estimated_deduction": 123,
"trips": 123,
"business_trips": 123,
"personal_trips": 123,
"uncategorized_trips": 123,
"deduction_rate": 123
}
]
}
]
}
}{
"type": "InvalidParameters",
"description": "<string>",
"error_enum": "InvalidPayload",
"meta": {}
}Reports
Get mileage summary
Returns a summary of mileage statistics grouped by year and month, including total miles, business miles, personal miles, uncategorized miles, trip counts, and estimated deductions.
GET
/
v1
/
businesses
/
{businessId}
/
mileage
/
summary
Get mileage summary
curl --request GET \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary', 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://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary",
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://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary"
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))
}HttpResponse<String> response = Unirest.get("https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"years": [
{
"year": 123,
"miles": "<string>",
"business_miles": "<string>",
"personal_miles": "<string>",
"uncategorized_miles": "<string>",
"estimated_deduction": 123,
"trips": 123,
"business_trips": 123,
"personal_trips": 123,
"uncategorized_trips": 123,
"months": [
{
"month": 6,
"miles": "<string>",
"business_miles": "<string>",
"personal_miles": "<string>",
"uncategorized_miles": "<string>",
"estimated_deduction": 123,
"trips": 123,
"business_trips": 123,
"personal_trips": 123,
"uncategorized_trips": 123,
"deduction_rate": 123
}
]
}
]
}
}{
"type": "InvalidParameters",
"description": "<string>",
"error_enum": "InvalidPayload",
"meta": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json.
Path Parameters
The UUID of the business.
Query Parameters
Include deleted trips in the summary.
Filter by trip purpose. Can be specified multiple times for multiple purposes.
Available options:
UNREVIEWED, BUSINESS, PERSONAL Comma-separated list of vehicle UUIDs to filter by.
Filter trips on or after this date (YYYY-MM-DD).
Filter trips on or before this date (YYYY-MM-DD).
Filter trips by year.
Response
Mileage summary statistics.
Show child attributes
Show child attributes