cursor (String!)

A cursor for use in pagination

node (APIBrownout)

The item at the end of the edge

cursor (String!)

A cursor for use in pagination

node (APIExceptionType)

The item at the end of the edge

goodsPurchase (GoodsPurchase)

Goods purchase created.

possibleErrors ([PossibleErrorType])

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountApplicationConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountApplicationType)

The item at the end of the edge

coolingOffEndDate (Date)

Last day of the cooling off period. Barring changes or objections, the account will be gained on the next business day after this date. This value will only be returned for current applications.

dateOfSale (Date)

Date at which this account decided to switch to us.

isMigrated (Boolean)

Whether this account application represents a migration into the current system or a regular gain.

migrationSource (String)

The source system for a migrated account. This could be the previous supplier or the previous account management system.

salesChannel (String!)

salesSubchannel (String)

The sales subchannel used when signing up. This could for example be a price comparison site.

status (AccountApplicationStatus!)

campaignExpiryDate (Date)

The date on which the associated campaign itself concludes.

expiryDate (Date)

The date on which the account's participation in the campaign ends.

name (String)

The name of the campaign.

slug (String)

The slug of the campaign.

startDate (Date)

The date that the account's link to the campaign started.

data (JSONString)

A JSON object containing unstructured data about the account charge.

updatedAt (DateTime)

The date and time the metadata was last updated.

cclAmount (BigInt)

The climate change levy amount of the charge.

displayNote (String)

The display note for the charge.

grossAmount (BigInt)

The gross amount of the charge.

id (ID)

The ID of the account charge.

metadata (AccountChargeMetadataType)

netAmount (BigInt)

The net amount of the charge.

note (String)

The note for the charge.

reason (String)

The reason for the charge.

salesTaxAmount (BigInt)

The sales tax amount of the charge.

data (JSONString!)

updatedAt (DateTime!)

grossAmount (BigInt!)

id (ID!)

metadata (AccountCreditMetadataType)

netAmount (BigInt!)

note (String!)

reason (String!)

salesTaxAmount (BigInt!)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountEventConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountEvent)

The item at the end of the edge

category (String!)

fetchUrl (String)

filename (String!)

id (ID!)

The ID of the object

isReady (Boolean)

Is the file ready for use / downloadable?

isUploaded (Boolean)

Is the file uploaded to S3?

sizeInBytes (Int)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountFileAttachmentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountFileAttachment)

The item at the end of the edge

isEligibleForIo (Boolean)

Whether account is eligible to register devices with Intelligent Octopus or not.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountPaymentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountPaymentType)

The item at the end of the edge

amount (BigInt!)

Amount of payment in pence

id (ID!)

paymentDate (Date!)

The date this payment is scheduled to be debited

reference (String!)

status (AccountPaymentStatusOptions)

The current status of the payment.

surchargeAmount (Int)

Surcharge amount generated by this payment.

transactionType (AccountPaymentTransactionTypeChoices)

The transaction type of the payment.

account (AccountType!)

createdAt (DateTime!)

namespace (String!)

updatedAt (DateTime!)

value (String!)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountRepaymentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountRepaymentType)

The item at the end of the edge

amount (BigInt!)

Amount of payment in pence

id (ID!)

paymentDate (Date!)

The date this payment is scheduled to be debited

status (AccountRepaymentStatusOptions)

The current status of the repayment.

accountType (AccountTypeChoices)

The type of account.

activeHardshipAgreements ([HardshipAgreementType])

List of active hardship agreements for the user when isinhardship is True.

activeReferralSchemes (ReferralSchemeTypes)

The referral schemes currently active for this account.

address (RichAddressType)

The billing address of this account, stored in the new libaddressinput-based format.

Note that name and organization are very unlikely to be supplied here; the billing_name field on the account itself is generally used for that purpose instead.

allProperties ([PropertyType])

All properties linked to the account - past, present and future.

annualStatements (AnnualStatementConnectionTypeConnection)

Fetch annual statements for the account.

applications (AccountApplicationConnectionTypeConnection)

Applications by this account to become our customer. More recent applications will be listed first.

assistanceAgreements ([AssistanceAgreementType])

Assistance agreements for account.

balance (Int!)

The current account balance.

bill (BillInterface)

Fetch a specific issued bill (invoice/statement) for the account.

billingAddress (String)

The billing address of the account.

billingAddressLine1 (String)

billingAddressLine2 (String)

billingAddressLine3 (String)

billingAddressLine4 (String)

billingAddressLine5 (String)

billingAddressPostcode (String)

billingCountryCode (String)

billingDeliveryPointIdentifier (String)

billingEmail (String)

The billing email of the account.

billingName (String)

The billing name of the account.

billingOptions (BillingOptionsType)

Information about the account's billing cycle.

billingSubName (String)

The billing sub name of the account.

bills (BillConnectionTypeConnection)

Fetch issued bills (invoices/statements) for the account.

brand (String)

The brand of the account.

business (BusinessType)

Business info related to a business account.

businessType (BusinessTypeOptions)

The company type of a business account.

campaigns ([AccountCampaignType])

The campaigns associated with an account.

canRequestRefund (Boolean)

Whether the account can request a credit refund.

commsDeliveryPreference (CommsDeliveryPreference)

The method the account has specified they prefer we contact them.

communicationDeliveryPreference (String)

consents ([ConsentType!]!)

Consents linked to this account.

contributionAgreements ([ContributionAgreementType])

Contribution agreements for account.

createdAt (DateTime)

The datetime that the account was originally created.

debtCollectionProceedings ([DebtCollectionProceedingType])

Debt collection proceedings for account.

directDebitInstructions (DirectDebitInstructionConnectionTypeConnection)

The direct debit instructions of the account

documentAccessibility (DocumentAccessibilityChoices)

The document accessibility preference of the account.

electricityBalance (String)

The latest balance of the electricity MaLo ledger.

events (AccountEventConnectionTypeConnection)

The account events that were recorded for the account.

fileAttachments ([AccountFileAttachment])

Files attached to this account.

gasBalance (String)

The latest balance of the gas MaLo ledger.

id (ID!)

isInHardship (Boolean)

True if there is an active Hardship Agreement for this account. False otherwise.

ledgers ([LedgerType])

Ledgers provide the foundation of bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular customer account.

maximumRefund (MaximumRefundType)

The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount.

metadata ([Metadata])

Metadata associated with the account.

notes ([AccountNoteType])

Notes for the account.

number (String)

A code that uniquely identifies the account.

overdueBalance (Int)

The current account overdue balance.

paginatedFileAttachments (AccountFileAttachmentConnectionTypeConnection)

Files attached to this account.

paginatedPaymentForecast (PaymentForecastConnectionTypeConnection)

Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports last but does not guarantee 'lastness'.

paymentForecast ([PaymentForecastType])

A list displaying the payment forecast for an account. The list starts from today's date (inclusive).

paymentSchedules (PaymentScheduleConnectionTypeConnection)

The schedules that describe how we would expect to take payments for an account on a given month.

payments (AccountPaymentConnectionTypeConnection)

The payments made into an account from a payment instruction.

portfolio (PortfolioType)

The portfolio this account is linked to.

preferredLanguageForComms (String)

The language that the account preferred for communications.

properties ([PropertyType])

Properties linked to the account now and in the future.

property (PropertyType)

Fetch a specific property linked to the account.

provisionalTransactions (ProvisionalTransactionConnectionTypeConnection)

references ([AccountReferenceType])

Account references linked to this account.

referrals (ReferralConnectionTypeConnection)

The referrals created by this account.

referralsCreated (Int)

Number of referrals created by this account.

repayments (AccountRepaymentConnectionTypeConnection)

The repayments that have been requested for this account.

requestRefundEligibility (RequestRefundEligibilityType)

Details about the eligibility status for requesting a refund.

rewards ([RewardType])

The rewards applied to this account.

splitBillingAddress ([String])

List of billing address lines.

status (AccountStatus)

The current status of the account.

transactions (TransactionConnectionTypeConnection)

Fetch transactions that have taken place on the account.

urn (String)

Unique reference number from a 3rd party enrolment.

users ([AccountUserType!]!)

emailFormat (EmailFormats)

What format the user would like to receive their emails in.

fontSizeMultiplier (Float)

This setting allows the user to adjust the default font size of the communications sent to them.

isOptedInMeterReadingConfirmations (Boolean)

Whether the user has opted in to receive meter reading confirmation emails.

isOptedInToClientMessages (Boolean)

Whether a user has opted in to receive messages from the client or client group. For example, for Octopus Energy this describes whether a user is opted in to offers from Octopus Investments.

isOptedInToOfferMessages (Boolean)

Whether a user has opted in to receive messages offering discounts or other services not directly related to the services the client provides.

isOptedInToRecommendedMessages (Boolean)

Whether a user has opted in to receive messages we recommend they read, but are not vital to the utilities the client provides. For example, these could be reminders that the client will take a payment.

isOptedInToSmsMessages (Boolean)

Whether the user has opted in to receive SMS messages.

isOptedInToThirdPartyMessages (Boolean)

Whether a user has opted in to receive messages from the client's preferred third parties.

isOptedInToUpdateMessages (Boolean)

Whether a user has opted in to receive messages updating them on client activities.

isUsingInvertedEmailColours (Boolean)

Whether a user has opted to have inverted colours in their emails. This is currently only relevant to the Octopus Energy brand, whose emails have a dark background by default.

preferredHoldMusic (Songs)

Song which will be used as hold music for the user.

namespace (String)

The namespace for the property.

value (String)

The property value.

account (AccountType!)

id (ID!)

role (RoleString)

The account role.

user (AccountUserType!)

accountUserRoles ([AccountUserRoleType])

List of roles a user has for each account they're linked to.

accounts ([AccountInterface])

List of accounts that the user is linked to either via portfolio role or account role.

alternativePhoneNumbers ([String])

List of alternative phone numbers for the account user.

consents ([ConsentType!]!)

Consents linked to this user.

dateOfBirth (Date)

AccountUser's date of birth.

details ([AccountUserDetailType])

List of details linked to this user.

displayName (String)

We recommend you use fullName instead of this field.

email (String!)

familyName (String!)

firstName (String)

We recommend you use preferredName or fullName instead of this field.

fullName (String)

The user's full name.

givenName (String!)

hasFamilyIssues (Boolean)

Whether there are family issues.

id (ID!)

isDeceased (Boolean!)

Designates whether this user is deceased.

isInHardship (Boolean)

True if user is linked to an account with an active hardship agreement.

landline (String!)

landlinePhoneNumber (String)

The user's landline phone number.

lastName (String)

We recommend you use preferredName or fullName instead of this field.

liveSecretKey (String)

The user's secret key to access the Developer API.

mobile (String!)

portfolioId (ID)

We recommend you use portfolioIds instead of this field.

portfolioIds ([ID])

List of portfolio ids that the user is linked to via their portfolio roles.

portfolioUserRoles ([PortfolioUserRoleType])

List of roles a user has for each portfolio they're linked to.

portfolios (PortfolioConnectionTypeConnection)

List of portfolios that the user is linked to via their portfolio roles.

preferences (AccountUserCommsPreferences)

preferredName (String)

The user's preferred name.

pronouns (String)

The user's pronouns e.g. 'she/her', 'he/him', 'they/them'.

specialCircumstances (SpecialCircumstancesType)

title (String)

campaignAdded (Boolean)

Whether the campaign was successfully added.

possibleErrors ([PossibleErrorType])

agreedAt (DateTime)

The datetime when the agreement was agreed.

cosLossStatus (String)

The status of an attached cos loss process.

estimatedAnnualConsumption (Int)

The annual consumption given by the customer in kWh.

estimatedMonthlyBillInEuros (Decimal)

The estimated monthly bill in €.

id (Int)

isActive (Boolean)

Whether the agreement is active.

isAffectedByPriceBrake (Boolean)

Whether the agreement is affected by the price brakes.

isRevoked (Boolean)

Whether the agreement is revoked.

isTerminated (Boolean)

Whether the agreement is terminated.

monthlyStandingCharge (Decimal)

The monthly standing charge in €.

netMonthlyStandingCharge (Decimal)

The net monthly standing charge in €.

product (Product)

standingChargeGrossRateInformation ([GrossRateInformation])

A list of gross rate information which is relevant to the standing charge (€/month).

unitRateGrossRateInformation ([GrossRateInformation])

A list of the gross rate information which is relevant to the unit rate (ct/kWh).

unitRateInformation (UnitRateInformation!)

The unit rate information.

unitRatePerKwh (Decimal)

The unit rate per kWh in €.

validFrom (DateTime)

The datetime when the agreement is valid from.

validTo (DateTime)

The datetime when the agreement is valid to.

type (LineLinkErrorType!)

The type of error that occurred.

payment (AccountPaymentType)

possibleErrors ([PossibleErrorType])

accessibilityHidden (Boolean)

Whether the element is hidden from view.

accessibilityLabel (String)

Accessible description of the element.

horizontalAlignment (Alignment)

The horizontal alignment of the media.

id (ID)

Unique identifier of the object.

mediaUrl (String!)

The resource URL of the media.

typename (String)

The name of the object's type.

width (ItemSizeType)

The measurement of the element.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AnnualStatementConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AnnualStatementType)

The item at the end of the edge

id (ID)

pdfUrl (String)

periodEndsAt (DateTime!)

periodStartsAt (DateTime!)

orderAnnulled (Boolean)

Whether the order annulment was successful.

possibleErrors ([PossibleErrorType])

annulledBillingDocumentId (Int!)

ID of the billing document annulled by this annulment.

firstIssued (DateTime)

First time the annulment was issued.

id (Int!)

pdfUrl (String)

URL to the PDF of the annulment.

activeFrom (Date)

The start datetime of the agreement.

activeTo (Date)

The end datetime of the agreement, if any.

assistanceType (String)

The type of assistance provided by the agreement.

authorizationUri (String)

The URL to redirect the user to for authorization.

id (ID)

A unique identifier for this onboarding step.

redirectUri (String)

The URI where the auth flow is going to redirect back to at the end.

electricity (SupplyTypeSpecificSpinsType)

The remaining spins resulting from an electricity agreement.

gas (SupplyTypeSpecificSpinsType)

The remaining spins resulting from an gas agreement.

action (ActionType)

An action to perform.

possibleErrors ([PossibleErrorType])

eventId (String!)

The ID of the event to trigger.

id (ID)

Unique identifier of the object.

params ([BackendScreenParam]!)

List of key-value pairs to pass as parameters to the event.

typeName (String)

The name of the action object's type.

typename (String)

The name of the object's type.

key (String!)

value (String!)

accountHolder (String)

Get the account holder name of the client's bank account.

bankName (String)

Get the name of the client's bank.

bic (String)

Get the BIC/SWIFT code for the client's bank account.

iban (String)

Get the IBAN of the client's bank account.

paymentReference (BankTransferReference)

Get the payment reference the customer should use to transfer monies.

reference (String)

Get bank transfer payment reference for customer, based on the ledger they transfer monies for.

meterId (Int)

The meter id this reading belongs to.

origin (String)

readAt (DateTime!)

registerObisCode (String)

typeOfRead (String)

value (String!)

edgeCount (Int!)

Number of nodes in the edge.

edges ([BillConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (BillInterface)

The item at the end of the edge

edgeCount (Int!)

Number of nodes in the edge.

edges ([BillingAttachmentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (BillingAttachmentType)

The item at the end of the edge

filename (String)

The name of the file.

temporaryUrl (String)

The TemporaryURL type represents a temporary URL at which the file is available.It is intended for redirection purposes, NOT persistence in any form. (e.g. inclusion in emails or the body of a web page).

temporaryUrlExpiresAt (DateTime)

The expiry datetime field of the temporary URL.

currentBillingPeriodEndDate (Date)

The date on which the current billing cycle will end. Null if the account is on flexible billing.

currentBillingPeriodStartDate (Date)

The date on which the current billing cycle started.

isFixed (Boolean!)

If true, this account is billed on specific day of a regular cycle. If false, the billing schedule is flexible, depending on when meter readings are submitted.

nextBillingDate (Date)

The next date on which this account will next be billed. This is the same as the start date for their next bill cycle. Null if the account is on flexible billing.

periodLength (AccountBillingOptionsPeriodLength)

periodLengthMultiplier (Int)

periodStartDay (Int)

The day of the month on which the account's billing period should start.

businessType (BusinessTypeOptions)

The company type of a business account.

linkedAccountNumber (ID!)

Account number linked to this business.

name (String!)

number (String!)

cancelledContract (Boolean)

Whether the contract cancellation was successful.

lastDayOfSupply (Date)

The last day of supply.

possibleErrors ([PossibleErrorType])

repaymentRequest (CancelRepaymentRequestOutputType)

The cancelled repayment/refund request.

requestId (String)

The ID of the cancelled request.

status (RepaymentRequestStatus)

The current status of the cancelled request.

possibleErrors ([PossibleErrorType])

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

accessibilityHidden (Boolean)

Whether the element is hidden from view.

accessibilityLabel (String)

Accessible description of the element.

id (ID)

Unique identifier of the object.

items ([CardItemType]!)

The list of components.

typename (String)

The name of the object's type.

cards ([CardComponentType]!)

The list of cards.

id (ID)

Unique identifier of the object.

typename (String)

The name of the object's type.

accountNumber (String)

Unique identifier of the account the transaction belongs to.

amount (Int)

Gross amount including tax (when payable). Refer to the amounts field for a breakdown of this information.

amounts (TransactionAmountType)

The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned.

balanceCarriedForward (Int)

The customer's resulting balance after this transaction has been applied, in the smallest unit of currency.

billingDocumentIdentifier (ID)

The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document.

consumption (Consumption)

If this charge is for consumption of a good or service, this field will contain details of how much was consumed. Omitted in cases where the charge is not for consumption, or where consumption information is not available (e.g. for some older records).

createdAt (DateTime)

The date time when the transaction is created.

hasStatement (Boolean)

Returns True if the transaction is linked with a statement.

id (ID)

isAccountCharge (Boolean)

Deprecated.

isAccountPayment (Boolean)

Deprecated.

isCredit (Boolean)

Deprecated.

isHeld (Boolean)

Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction.

isIssued (Boolean)

Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents.

isReversed (Boolean!)

note (String)

Returns the note field value for the transaction, which contains additional info.

postedDate (Date)

statementId (ID)

Returns None if a statement is not linked with the transaction.

title (String)

make (String)

models ([ChargePointModelsType])

model (String)

powerInKw ([String])

amperage (Int)

Supply amperage. Used in markets where customers are more familiar with amps than power output.

integrationStatus (IntegrationStatus)

Shows the availability status of an integration.

isIntegrationLive (Boolean)

model (String)

powerInKw (Decimal)

variantId (Int)

make (String)

models ([ChargePointVariantModelType])

code (String)

The charge reason code.

display (String)

The charge reason display text.

group (String)

The group the charge reason belongs to (if applicable).

isDeprecated (Boolean)

Whether the charge reason is deprecated.

isHidden (Boolean)

Whether the charge reason is hidden.

isTaxExempt (Boolean)

Whether the charge reason is sales tax exempt.

accessibilityHidden (Boolean)

Whether the element is hidden from view.

accessibilityLabel (String)

Accessible description of the element.

id (ID)

Unique identifier of the object.

typeName (String)

The name of the action object's type.

typename (String)

The name of the object's type.

payment (AccountPaymentType)

Details about the collected payment. Note that we might not be able to collect the payment (e.g. if there is no usable payment instruction), in which case the status of the returned payment might be failed or cancelled.

possibleErrors ([PossibleErrorType])

attachments (BillingAttachmentConnectionTypeConnection)

billType (BillTypeEnum)

The type of the bill.

constituents (ConstituentConnection)

Constituents of the bill.

fromDate (Date)

The date of the bill is covered from.

id (ID)

The ID of the bill.

issuedDate (Date)

The date the bill was sent to the customer.

temporaryUrl (String)

Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead.

toDate (Date)

The date of the bill is covered to.

fieldSpecificRateLimits (FieldSpecificRateLimitInformationConnectionTypeConnection!)

Information about the current state of the rate limiting for rate limited fields at the time of the request.

pointsAllowanceRateLimit (PointsAllowanceRateLimitInformation)

Information about points-allowance rate limit for viewer.

possibleErrors ([PossibleErrorType])

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

possibleErrors ([PossibleErrorType])

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

accessibilityHidden (Boolean)

Whether the element is hidden from view.

accessibilityLabel (String)

Accessible description of the element.

id (ID)

Unique identifier of the object.

items ([ItemType]!)

The list of components.

name (String!)

The name of the screen.

refreshFrequency (Int)

The refresh / polling frequency in milliseconds.

screenData (String)

Serialized JSON representation of the screen.

typename (String)

The name of the object's type.

code (String)

Unique code given to this consent type.

id (BigInt)

id of the consent.

value (ConsentValue)

Value of the consent.

edgeCount (Int!)

Number of nodes in the edge.

edges ([ConstituentEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (ConstituentInterface)

The item at the end of the edge

endDate (Date)

quantity (Decimal)

startDate (Date)

supplyCharge (Int)

unit (ConsumptionUnit)

usageCost (Int)

activeFrom (DateTime)

The start datetime of the agreement.

activeTo (DateTime)

The end datetime of the agreement, if any.

amount (Int)

The amount contributed per interval. Note, this is in the smallest domination that the currecy support. e.g. Pence, Cents, Yen, etc.

contributionScheme (ContributionSchemeType)

The scheme to which the agreement contributes.

id (ID!)

interval (Interval)

The frequency of contributions.

periods (ContributionPeriodConnection)

The periods over which contributions have been made.

edgeCount (Int!)

Number of nodes in the edge.

edges ([ContributionPeriodEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (ContributionPeriodType)

The item at the end of the edge

agreement (ContributionAgreementType!)

fulfilledAt (DateTime)

When the contribution was fulfilled

id (ID!)

periodFrom (DateTime)

The datetime the marks the beginning of the period.

periodTo (DateTime)

The datetime the marks the end of the period.

acceptingContributions (Boolean!)

Is this scheme currently accepting contributions?

code (String!)

displayName (String!)

id (ID!)

taxable (Boolean!)

Are contributions to this scheme taxable?

latitude (Float)

longitude (Float)

costOfChargeId (String)

isSmartCharge (Boolean)

krakenflexDeviceId (String)

reportDate (Date)

totalConsumption (Float)

Consumption in kWh.

totalCostExclTax (Float)

Cost in pence (excl. tax).

totalCostInclTax (Float)

Cost in pence (incl. tax).

possibleErrors ([PossibleErrorType])

schedule (PaymentScheduleType!)

New payment schedule.

accountReference (AccountReferenceType)

possibleErrors ([PossibleErrorType])

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

possibleErrors ([PossibleErrorType])

directDebitInstruction (PaymentInstructionType)

The payment instruction.

possibleErrors ([PossibleErrorType])

numberOfReadingsCreated (Int)

possibleErrors ([PossibleErrorType])

readingDate (Date)

numberOfReadingsCreated (Int)

possibleErrors ([PossibleErrorType])

readingDate (Date)

goodsPurchase (GoodsPurchase)

Goods purchase created.

possibleErrors ([PossibleErrorType])

goodsQuote (GoodsQuote)

Goods quote created for the customer.

possibleErrors ([PossibleErrorType])

goodsQuote (GoodsQuote)

Goods quote created for the customer.

possibleErrors ([PossibleErrorType])