supplyContracts

Fetch supply contracts.

Arguments

accountNumber : String!


            required

The account number linked to the supply contracts.

after : String

agreementId : ID

Fetch supply contracts related to this specific agreement.

before : String

first : Int

last : Int

marketName : FRAMarketName

Filter supply contracts by market name (FRA_ELECTRICITY or FRA_GAS).

propertyId : ID

Filter supply contracts related to this property.

supplyContractNumber : String

Specific supply contract to display.

supplyPointId : ID

Filter supply contracts related to this specific supply point.

Returns

SupplyContractConnectionTypeConnection

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

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.

query SupplyContracts(
  $accountNumber: String!,
  $after: String,
  $agreementId: ID,
  $before: String,
  $first: Int,
  $last: Int,
  $marketName: FRAMarketName,
  $propertyId: ID,
  $supplyContractNumber: String,
  $supplyPointId: ID
) {
  supplyContracts(
    accountNumber: $accountNumber,
    after: $after,
    agreementId: $agreementId,
    before: $before,
    first: $first,
    last: $last,
    marketName: $marketName,
    propertyId: $propertyId,
    supplyContractNumber: $supplyContractNumber,
    supplyPointId: $supplyPointId
  ) {
    edgeCount
    edges {
      ...SupplyContractConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "accountNumber": "A-6A328510",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "agreementId": "23059136",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "marketName": "FRA_ELECTRICITY",
  "propertyId": "82241763",
  "supplyContractNumber": "hold-kitchen-consider-large-table",
  "supplyPointId": "14886578"
}

{
  "data": {
    "supplyContracts": {
      "edgeCount": 76,
      "edges": [SupplyContractConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 25
    }
  }
}