WIwithterminal
IFTA

Get IFTA Summary

Changed on

Get distance driven per IFTA jurisdiction for the requested 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

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/ifta/summary
  • Auth
    HTTP bearer

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

First month to include, inclusive.

endMonthstring required

ISO 8601 month

Example:2021-01

Last month to include, inclusive.

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

How to total distance across the requested months. The default, vehicle,jurisdiction, returns one row per vehicle and jurisdiction, summed across every month from startMonth to endMonth. Use vehicle,jurisdiction,month to get one row per month.

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.25,
      "month": "2021-01",
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Changes

  • 71081936e1bdRevision changes
    • breaking

      added the pattern ^[A-Za-z0-9+/=_-]+$ to the query request parameter cursor

    • breaking

      added to the // response property oneOf list for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      removed subschema #2: Expanded Vehicle from the // response property oneOf list for the response status

    • info

      the response's property pattern ^[A-Za-z0-9+/=_-]+$ was added for the status