Skip to main content

Fields

agentContracts : [GasAgentContractType]

A list of agents responsible for management of the meterpoint.

Arguments

Filter the contracts by status.

agreements : [GasAgreementType]

A list of gas agreements belonging to an account that is linked to the viewer. Filters out expired agreements by default.

Arguments
excludeFuture : Boolean

Exclude agreements starting in the future.

includeInactive : Boolean
validAfter : DateTime
canRenewTariff : Boolean

Whether it is possible to renew the meter point's tariff.

confirmationReference : Int
currentDmSoq : Int

Rolling SOQ

currentNdmSoq : Int

Rolling SOQ

currentSupplierMpid : String

The current MPID for this meter point.

endUserCategory : Int
enrolment : EnrolmentType

Details of an ongoing enrolment process.

eucIdentifier : String

The End User Category (EUC) identifier. This field is no longer populated.

Deprecation
The 'eucIdentifier' field is deprecated.

It is no longer populated.

- Marked as deprecated on 2026-07-29.
- Scheduled for removal on or after 2027-01-28.
exitCapacityChargeRate : Decimal
exitZone : String! required
formulaYearSmpAq : Int

AQ fixed for year

formulaYearSmpSoq : Int

SOQ fixed for year

hasOpenClosingReadDispute : Boolean! required
hasOpenOpeningReadDispute : Boolean! required
id : ID! required
igtCheckedAt : DateTime
igtIdentifier : String! required
installCode : String

The installation code of the smart meter device associated with this meter point.

isDueTariffRenewal : Boolean

Whether the meter point is due to renew their tariff.

ldz : String! required

Local distribution zone - Distribution charges are based upon this

ldzCapacityChargeRate : Decimal
ldzCommodityChargeRate : Decimal
ldzCustomerChargeRate : Decimal
marketCategory : GasMeterPointMarketCategory
marketSectorCode : GasMeterPointMarketSectorCode
meterOwnershipType : GasMeterPointMeterOwnershipType
meterReadBatchFrequency : String! required
meters : [GasMeterType]
Arguments
id : Int
includeInactive : Boolean
mprn : String
mrfType : String! required
newSupplierId : String
nominationShipperReference : String! required
nominationType : String! required
ntsExitCommodityChargeRate : Decimal
oldSupplierId : String
requiresEnrolment : Boolean! required
requiresWithdrawal : Boolean! required
smartStartDate : Date
status : String
statusUpdatedAt : DateTime
supplyClass : Int! required
supplyEndDate : Date
supplyPointCategory : String! required
targetSsd : Date
unbilledReadings : [GasMeterReadingType]

A list of unbilled gas readings for the meterpoint.

xoserveStatus : String

Industry status code

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

{ "agentContracts": [GasAgentContractType], "agreements": [GasAgreementType], "canRenewTariff": true, "confirmationReference": 95, "currentDmSoq": 17, "currentNdmSoq": 34, "currentSupplierMpid": "61027323", "endUserCategory": 15, "enrolment": EnrolmentType, "exitCapacityChargeRate": "1.0", "exitZone": "task-field-interesting-early-newspaper", "formulaYearSmpAq": 43, "formulaYearSmpSoq": 44, "hasOpenClosingReadDispute": true, "hasOpenOpeningReadDispute": true, "id": "78359790", "igtCheckedAt": "2014-05-04T16:48:46.148421+00:00", "igtIdentifier": "88401986", "installCode": "loss-can-spring-model-next", "isDueTariffRenewal": true, "ldz": "such-ok-mind-air-woman", "ldzCapacityChargeRate": "1.0", "ldzCommodityChargeRate": "1.0", "ldzCustomerChargeRate": "1.0", "marketCategory": "SSP", "marketSectorCode": "D", "meterOwnershipType": "T", "meterReadBatchFrequency": "yard-sea-customer-home-food", "meters": [GasMeterType], "mprn": "important-call-ask-feel-sometimes", "mrfType": "move-individual-five-evening-see", "newSupplierId": "79806990", "nominationShipperReference": "may-moment-chance-trial-for", "nominationType": "foreign-attention-woman-look-tree", "ntsExitCommodityChargeRate": "1.0", "oldSupplierId": "61073566", "requiresEnrolment": true, "requiresWithdrawal": true, "smartStartDate": "2016-02-25", "status": "understand-two-soon-care-model", "statusUpdatedAt": "2002-07-27T17:05:06.480929+00:00", "supplyClass": 33, "supplyEndDate": "2014-05-11", "supplyPointCategory": "reflect-second-gun-walk-poor", "targetSsd": "1992-10-11", "unbilledReadings": [GasMeterReadingType], "xoserveStatus": "let-woman-mother-cold-chance" }