Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
IFTA

Get IFTA Summary

Get all vehicle IFTA reports for the requested time span.

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.

get/ifta/summary

Query parameters

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

expand'vehicle'

Expand resources in the returned response

rawboolean

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

startMonthstring required

ISO 8601 month

Example:2021-01

The month from which to start including vehicle reports

endMonthstring required

ISO 8601 month

Example:2021-01

Include vehicle reports up to and including this month

groupBy'jurisdiction' | 'vehicle' | 'vehicle,jurisdiction' | 'vehicle,jurisdiction,month'

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.

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "jurisdiction": "TN",
      "distance": 100,
      "month": "2021-01",
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}