Fields

agreedFrom : DateTime

The datetime the agreement was entered.
agreedTo : DateTime

The datetime the agreement was terminated.
billingFrequency : Int

The frequency (in month periods) of the agreement.
billingName : String

The billing name of the account associated with the agreement.
chargingLedger : SupplementaryLedgerType

The ledger used for charging.
consents : IndustryConsentData

The industry consents related to supply_point.
currentDirectDebitInstruction : DirectDebitInstructionType

The current direct debit instruction linked to the agreement.
currentPaymentInstruction : PaymentInstructionType

The current payment instruction linked to the payment_schedule on agreement.
energySupplyRate : EnergySupplyRate

Product detailed cost information, including both standing and consumption rates.
id : Int

The ID of the agreement.
industryConsentData : FraConsentData

Data related to the industry consents.
isActive : Boolean

Whether the agreement is active right now.
isRevoked : Boolean

Whether the agreement is revoked.
nextPaymentForecast : PaymentForecastType

The next payment forecast for the agreement.
nextPaymentOrRepayment : FraPaymentsInterface

The next payment or repayment for the agreement.
paymentScheduleInstructionType : ScheduleType

The payment schedule instruction type linked to the most recent payment_schedule on agreement.
product : Product

The product associated with the agreement.
ratesAgreedAt : DateTime

The datetime the rates were agreed.
rescissionDeadlineAt : DateTime

The deadline datetime for rescinding the agreement.
salesChannel : String

Sales channel.
salesSubchannel : String

Sales subchannel.
status : ActivationProcessStatus

The status of the agreement (based on the activation process).
supplyContractNumber : String

The supply contrat number related to the agreement.
supplyPoint : SupplyPointType

Data related to the supply point.
validFrom : DateTime

The starting date and time for the agreement.
validTo : DateTime

The ending date and time for the agreement.
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

{ "agreedFrom": "2021-04-10T09:19:24.799820+00:00", "agreedTo": "2010-01-22T11:24:08.053877+00:00", "billingFrequency": 50, "billingName": "produce-military-sport-official-rise", "chargingLedger": SupplementaryLedgerType, "consents": IndustryConsentData, "currentDirectDebitInstruction": DirectDebitInstructionType, "currentPaymentInstruction": PaymentInstructionType, "energySupplyRate": EnergySupplyRate, "id": 26225777, "industryConsentData": FraConsentData, "isActive": true, "isRevoked": true, "nextPaymentForecast": PaymentForecastType, "nextPaymentOrRepayment": FraPaymentsInterface, "paymentScheduleInstructionType": "BACS_TRANSFER", "product": Product, "ratesAgreedAt": "2015-10-06T02:27:11.548429+00:00", "rescissionDeadlineAt": "2025-10-22T14:28:42.582008+00:00", "salesChannel": "none-production-nation-discover-also", "salesSubchannel": "cold-provide-never-do-improve", "status": "NEW", "supplyContractNumber": "event-product-huge-management-protect", "supplyPoint": SupplyPointType, "validFrom": "2017-03-09T09:50:28.726659+00:00", "validTo": "1980-07-25T02:12:58.781025+00:00" }