Fields

balanceForecast : Int

The credit storage balance minus any pending source fund requests (in cents).
ledger : SupplementaryLedgerType

The credit storage ledger for the account.
pendingRequestsForPaymentReduction : SourceFundRequestConnectionTypeConnection

Fund sourcing requests that will be used to reduce next payment.
Arguments
after : String
before : String
first : Int
last : Int
targetLedgerId : ID

Id of the target ledger to filter on (e.g. charging ledger).
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
targetLedgerNumber : String

Number of the target ledger to filter on (e.g. charging ledger).
sourceFundRequestEligibilities : SourceFundRequestEligibilityConnectionTypeConnection

Eligibility to create a fund source request for each charging ledger.
Arguments
after : String
before : String
first : Int
last : Int
upcomingPaymentReductionRequest : SourceFundRequest

Fund sourcing request that has been or will be used to reduce next payment.

The possible errors that can be raised are:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-3821: Received neither ledger ID nor ledger number.
  • KT-CT-1113: Disabled GraphQL field requested.
Arguments
targetLedgerId : ID

Id of the target ledger to filter on (e.g. charging ledger).
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
targetLedgerNumber : String

Number of the target ledger to filter on (e.g. charging ledger).
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

{ "balanceForecast": 88, "ledger": SupplementaryLedgerType, "pendingRequestsForPaymentReduction": SourceFundRequestConnectionTypeConnection, "sourceFundRequestEligibilities": SourceFundRequestEligibilityConnectionTypeConnection, "upcomingPaymentReductionRequest": SourceFundRequest }