GET
/
tariffs
/
audit
/
{id}

Authorizations

Authorization
string
headerrequired

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

id
string
required

FlatPeak Location ID

Query Parameters

start_time
string

Time when data will start must be in RFC3339 format, e.g., 2023-06-15T09:00:00Z or with time offset, e.g., 2023-06-15T08:00:00+01:00. Use either Zulu time (UTC) or time offset; mixed values are not allowed.

end_time
string
required

Time when data will end, in RFC3339 format, e.g. 2023-06-15T13:00:00Z or with time offset, e.g. 2023-06-15T12:00:00+01:00. Use either Zulu time (UTC) or time offset; mixed values are not allowed. The maximum period between start_time and end_time for a single request is 90 days.

direction
string
default: IMPORT

Indicates direction you want to work with. Set to IMPORT or EXPORT. Defaults to IMPORT.

Response

200 - application/json
id
string
required

FlatPeak unique object ID for this response.

object
string
required

Represents the object’s type. I.e. tariff rate audit.

live_mode
boolean
required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

location_id
string
required

FlatPeak location ID.

location_timezone
string
required

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

currency_code
string
required

Currency at the location in ISO 4217.

direction
string
required

Direciton of tariff. Supported options are IMPORT and EXPORT.

request
object
required

Your original request.

data
object[]
required

Response data.

time_created
string
required

Time when this response was calculated. In UTC.

account_id
string
required

FlatPeak account ID.

market_sources
string[]

FlatPeak ID for market rates geographical regions. FlatPeak sets this automatically using the postal_address property of the Location object. For more information and to resolve IDs to region names see market rates regions reference.

carbon_sources
string[]

FlatPeak ID for carbon emissions geographical regions. FlatPeak sets this automatically using the postal_address property of the Location object. For more information and to resolve IDs to region names see carbon emissions regions reference.