Skip to main content

Input fields

address : QuoteAddressInput

Optional address information about the customer.

affiliateOrganisationId : String

The affiliate organisation ID. Used with restrict_to_affiliate_products.

affiliateSessionId : String
brandCode : String! required
electricityMeterPoints : [ElectricityMeterPointConsumptionInput]
gspGroupId : String
hasConsentedToIndustryDataSearch : Boolean

Whether the user has consented to their energy consumption estimates being retrieved from the industry vendors. This currently applies to business accounts only.

isBusiness : Boolean
paymentMethod : QuotePaymentMethodChoices default: DIRECTDEBIT

Optional parameter to select the payment method for the quote, default is direct debit.

position : PositionInput

Used to verify the position that field sales agents generate quotes from.

postcode : String! required
restrictToAffiliateProducts : Boolean

Whether to restrict the products (tariffs) to quote from to only show affiliate products. Requires affiliate_organisation_id.

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

{ "address": QuoteAddressInput, "affiliateOrganisationId": "26541515", "affiliateSessionId": "91350058", "brandCode": "whether-number-computer-economy-design", "electricityMeterPoints": ElectricityMeterPointConsumptionInput, "gasMeterPoints": GasMeterPointConsumptionInput, "gspGroupId": "86439324", "hasConsentedToIndustryDataSearch": true, "isBusiness": true, "paymentMethod": "DIRECTDEBIT", "position": PositionInput, "postcode": "rest-site-manager-hour-PM", "restrictToAffiliateProducts": true }