Skip to main content
GET
/
ifta
/
summary
Get IFTA Summary
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/ifta/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "provider": "geotab",
      "distance": 100,
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "jurisdiction": "TN",
      "month": "2021-01",
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}
Currently can only increment by full months. Note: data may change for a few days after the month. We will continue to update those reports to ensure you get accurate results.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

​
cursor
string<cursor>

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
expand
enum<string>

Expand resources in the returned response

Available options:
vehicle
​
raw
boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

​
startMonth
string
required

The month from which to start including vehicle reports ISO 8601 month

Example:

"2021-01"

​
endMonth
string
required

Include vehicle reports up to and including this month ISO 8601 month

Example:

"2021-01"

​
groupBy
enum<string>
default:vehicle,jurisdiction

Computes the total distance traversed within a specified month range, with the results grouped by either jurisdiction, vehicle, or both. If no grouping parameter is provided, the default grouping is vehicle,jurisdiction.

Available options:
jurisdiction,
vehicle,
vehicle,jurisdiction,
vehicle,jurisdiction,month

Response

OK

​
results
IFTA Summary · object[]
required
​
next
string<cursor>

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"