GET
/
tariffs
/
audit
/
{id}
curl --request GET \
  --url https://api.flatpeak.com/tariffs/audit/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "tra_65e42cdd73e9f861edda35d7",
  "object": "tariff_rate_audit",
  "live_mode": true,
  "location_id": "loc_65e42ce4d3b813479b252160",
  "location_timezone": "Europe/Berlin",
  "currency_code": "EUR",
  "direction": "IMPORT",
  "request": {
    "direction": "IMPORT",
    "start_time": "2024-05-24T14:15:22Z",
    "end_time": "2024-05-24T15:15:22Z"
  },
  "market_sources": [
    "mrs_65792b4df61b16685ebd2e78"
  ],
  "carbon_sources": [
    "reg_64a94563544268484146f1f4"
  ],
  "data": [
    {
      "valid_from": "2024-12-28T01:00:00Z",
      "valid_to": "2024-12-28T02:00:00Z",
      "tariff_rate": {
        "commodity": {
          "market": 4.998,
          "fixed": 0.124,
          "percentage": 0.11,
          "tier": 100,
          "aggregate": 17.994
        },
        "non_commodity": {
          "fixed": 7.122,
          "tier": 10000
        },
        "total": 25.116,
        "confidence": 0.8
      }
    }
  ],
  "time_created": "2024-05-24T15:15:22Z",
  "account_id": "acc_661677911f2197045e6cf1b1"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

​
id
string
required

FlatPeak Location ID

Example:

"loc_66879edb94bf861548cb7428"

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; if time offsets differ end_time takes priority.

Example:

"2023-06-15T09:00:00Z"

​
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; if time offsets differ end_time takes priority. The maximum period between start_time and end_time for a single request is 90 days.

Example:

"2023-06-15T23:00:00Z"

​
direction
string
default:IMPORT

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

Example:

"IMPORT"

Response

200
application/json
​
id
string
required

FlatPeak unique object ID for this response.

Example:

"tra_65e42cdd73e9f861edda35d7"

​
object
string
required

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

Example:

"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.

Example:

"loc_65e42ce4d3b813479b252160"

​
location_timezone
string
required

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

Example:

"Europe/Berlin"

​
currency_code
string
required

Currency at the location in ISO 4217.

Example:

"EUR"

​
direction
string
required

Direciton of tariff. Supported options are IMPORT and EXPORT.

Example:

"IMPORT"

​
request
object
required

Your original request.

​
data
object[]
required

Response data.

​
time_created
string
required

Time when this response was calculated. In UTC.

Example:

"2024-05-24T15:15:22Z"

​
account_id
string
required

FlatPeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

​
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.

Was this page helpful?

Suggest editsRaise issue