Get a fuel surcharge table with its entry in force on a date

This endpoint reads the fuel surcharge rates of a table in force on a date; read it before updating one of
its entries. date is a day of the tenant (yyyy-MM-dd), today by default. mode and rate are the table
defaults. fuelSurcharges holds the entry in force on that date: the one with the latest startDate on or
before it, or the earliest entry if none; it is empty when the table has no entry. The entry has a
fuelSurchargeId, its startDate and VehicleSurcharges, one per vehicle type, with vehicleTypeId,
isOverridden, mode, rate, fuelPricesId and fuelSurchargeCalculatorId. mode: 0 FixedPercentage, rate in
percent; 1 FixedPricePerDistance, rate per distance unit; 2 CalculatedPercentage and
3 CalculatedPricePerDistance, rate null, computed from the fuel prices fuelPricesId with the calculator
fuelSurchargeCalculatorId. An unknown id returns a 404. Requires an administrator; other users get a 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The id of the table, as returned by GET api/v1/fuelsurcharges/tables or as the fuelSurchargeTableId of a schedule.

Query Params
date

A day of the tenant (yyyy-MM-dd). Today in the tenant's time zone when empty.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

No fuel surcharge table found for the given id.

500

An error occurred while trying to get the fuel surcharge table.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json