livePaymentAdequacy

Get up to date payment adequacy data.

Arguments

accountNumber : String!


            required

Kraken account number.

ledgerNumber : String

Ledger number.

policyId : String

Payment adequacy policy ID. If this argument is null then the default policy will be used.

Returns

LivePaymentAdequacyQuery

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 LivePaymentAdequacy(
  $accountNumber: String!,
  $ledgerNumber: String,
  $policyId: String
) {
  livePaymentAdequacy(
    accountNumber: $accountNumber,
    ledgerNumber: $ledgerNumber,
    policyId: $policyId
  ) {
    currentBalance
    estimatedConsumption {
      ...ConsumptionBreakdownFragment
    }
    recommendedPayment {
      ...PaymentBreakdownFragment
    }
    reviewedOn
    targetBalance
  }
}

{
  "accountNumber": "A-9054B347",
  "ledgerNumber": "yard-name-economic-institution-city",
  "policyId": "34032049"
}

{
  "data": {
    "livePaymentAdequacy": {
      "currentBalance": 44,
      "estimatedConsumption": [ConsumptionBreakdown],
      "recommendedPayment": PaymentBreakdown,
      "reviewedOn": "2007-07-10",
      "targetBalance": 10
    }
  }
}