paymentsAndRepayments

Fetch the payments and repayments for an account.

Arguments

accountNumber : String!


            required

ID of the account.

after : String

before : String

first : Int

fromDate : Date

Optional date representing the beginning of the search results. This date value is inclusive.

last : Int

paymentReason : PaymentReasonOptions

Filter for payments that were taken for a particular reason.

paymentStatus : AccountPaymentStatusOptions

Filter on the payments status.

propertyId : ID

Filter payments and repayments related to this property.

repaymentStatuses : [AccountRepaymentStatusOptions]

Only return repayments whose status matches one of these statuses.

supplyContractNumber : String

Filter bills related to this supply contract.

supplyPointId : ID

The ID of the supply point.

toDate : Date

Optional date representing the end of the search results. This date value is exclusive.

Returns

FraAccountPaymentConnectionTypeConnection

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 PaymentsAndRepayments(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $first: Int,
  $fromDate: Date,
  $last: Int,
  $paymentReason: PaymentReasonOptions,
  $paymentStatus: AccountPaymentStatusOptions,
  $propertyId: ID,
  $repaymentStatuses: [AccountRepaymentStatusOptions],
  $supplyContractNumber: String,
  $supplyPointId: ID,
  $toDate: Date
) {
  paymentsAndRepayments(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    fromDate: $fromDate,
    last: $last,
    paymentReason: $paymentReason,
    paymentStatus: $paymentStatus,
    propertyId: $propertyId,
    repaymentStatuses: $repaymentStatuses,
    supplyContractNumber: $supplyContractNumber,
    supplyPointId: $supplyPointId,
    toDate: $toDate
  ) {
    edgeCount
    edges {
      ...FraAccountPaymentConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "accountNumber": "A-3AC53379",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "fromDate": "1976-06-11",
  "last": 10,
  "paymentReason": "BALANCE_THRESHOLD_CROSSED",
  "paymentStatus": "SCHEDULED",
  "propertyId": "19699736",
  "repaymentStatuses": "REQUESTED",
  "supplyContractNumber": "significant-job-everybody-fight-will",
  "supplyPointId": "54968050",
  "toDate": "2012-09-17"
}

{
  "data": {
    "paymentsAndRepayments": {
      "edgeCount": 48,
      "edges": [FraAccountPaymentConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 53
    }
  }
}