agreements

Additional data for french agreements.

Arguments

accountNumber : String!


            required

The account number linked to the agreements.

activeAt : DateTime

Filter agreements on the date (valid_from <= date <= valid_to).

after : String

agreementId : ID

Fetch this specific agreement.

before : String

first : Int

last : Int

propertyId : ID

Filter agreements related to this property.

supplyContractNumber : String

The supply contract number linked to the agreements.

supplyPointId : ID

Filter agreements related to this specific supply point.

validFromBefore : DateTime

Filter agreements where valid_from is less than or equal to this date (excludes future agreements).

Returns

AgreementConnectionTypeConnection

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 Agreements(
  $accountNumber: String!,
  $activeAt: DateTime,
  $after: String,
  $agreementId: ID,
  $before: String,
  $first: Int,
  $last: Int,
  $propertyId: ID,
  $supplyContractNumber: String,
  $supplyPointId: ID,
  $validFromBefore: DateTime
) {
  agreements(
    accountNumber: $accountNumber,
    activeAt: $activeAt,
    after: $after,
    agreementId: $agreementId,
    before: $before,
    first: $first,
    last: $last,
    propertyId: $propertyId,
    supplyContractNumber: $supplyContractNumber,
    supplyPointId: $supplyPointId,
    validFromBefore: $validFromBefore
  ) {
    edgeCount
    edges {
      ...AgreementConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "accountNumber": "A-88C91D3B",
  "activeAt": "1976-03-20T23:19:02.007250+00:00",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "agreementId": "42290301",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "propertyId": "38859927",
  "supplyContractNumber": "today-ever-after-much-war",
  "supplyPointId": "45130803",
  "validFromBefore": "1996-10-12T16:56:30.753277+00:00"
}

{
  "data": {
    "agreements": {
      "edgeCount": 52,
      "edges": [AgreementConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 91
    }
  }
}