Skip to main content

Input fields

calculatedAt : DateTime! required

Date at which the rate was calculated.

contractIdentifier : ID

ID linked to the contract in Kraken.

Deprecation
The 'importTrancheRate' field is deprecated.

The `contract_identifier` field is contract specific. Use `target_identifier` instead.

- Marked as deprecated on 2026-08-20.
- Scheduled for removal on or after 2027-02-20.
costOfEnergyReport : String

S3 path to the document that breaks the tranche rate down into individual components (e.g. Cost of Energy report).

marketName : TrancheMarketName! required

Market name for the tranche target.

periodFrom : DateTime! required

Start of the period for which the rate was calculated.

periodTo : DateTime! required

End of the period for which the rate was calculated.

pricePerUnit : String! required

Price per unit (e.g. 5 pence per KWh).

targetIdentifier : ID

ID linked to the contract or contract group.

targetType : TargetType

Type of the target for the rate (e.g: BUSINESS_CONTRACT, CONTRACT_GROUP).

unit : TrancheRateUnit! required

Unit by which the rate is paid by (e.g: pence/KWh or pence/MWh). The API will work out the minor unit of the local currency (.e.g: pence, cents, ...).

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "calculatedAt": "1971-08-03T01:11:55.463854+00:00", "costOfEnergyReport": "director-concern-once-technology-sometimes", "marketName": "SIMPLE_SERVICES", "periodFrom": "2015-03-05T00:02:01.672899+00:00", "periodTo": "2016-04-08T07:30:56.653266+00:00", "pricePerUnit": "effort-success-pull-bar-admit", "targetIdentifier": "11954206", "targetType": "BUSINESS_CONTRACT", "unit": "PER_KWH" }