Implemented by

Fields

acceptsPayments : Boolean

Whether payments can be posted onto this ledger.
affectsAccountBalance : Boolean

Whether this ledger's balance contributes to the account's balance.
agreements : AgreementConnection

The charged supply agreements of the ledger.
Arguments
after : String
before : String
first : Int
last : Int
amountOwedByCustomer : Int

The amount owed from the customer perspective. A positive value implies the customer owes the business, while a negative amount implies the customer is in credit.
balance : Int

The current balance on the ledger in minor units of currency.
billingTriggerConfiguration : BillingTriggerConfiguration

The active billing trigger configuration for the ledger.

The possible errors that can be raised are:

  • KT-CT-9709: Billing trigger configuration only supports SupplementaryLedger type.
  • KT-CT-1113: Disabled GraphQL field requested.
creditTransferPermissionsData : CreditTransferPermissionsDataType

Permissions data for credit transfers involving the given ledger.
debtLedger : LedgerInterface

The debt ledger assigned to this ledger.
id : ID
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.
invoices : InvoiceBillingDocumentConnectionTypeConnection

An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.
Arguments
after : String
before : String
first : Int
last : Int
paymentForecast : PaymentForecastConnectionTypeConnection

Paginated payment forecasts for this ledger. Starts from today's date (inclusive). The interface supports last but does not guarantee 'lastness'.
Arguments
after : String
before : String
dateTo : Date

The end date (inclusive) to retrieve forecasts for.
first : Int
last : Int
paymentPlans : PaymentPlanConnectionTypeConnection

The payment plans for this ledger.
Arguments
after : String
before : String
first : Int
last : Int
paymentPreferenceAtTime : PaymentPreferenceUnion

The customer's preferred payment method at a point in time.

The possible errors that can be raised are:

  • KT-CT-3976: The ledger has no configured payment preference.
  • KT-CT-3977: Ledger was not accepting payments at this time.
  • KT-CT-1113: Disabled GraphQL field requested.
Arguments
atTime : DateTime! required

The time at which to know the payment preference.
paymentPreferences : PaymentPreferenceConnectionTypeConnection

The customer's preferred payment methods.
Arguments
after : String
before : String
first : Int
last : Int
payments : AccountPaymentConnectionTypeConnection

The payments made into this ledger.
Arguments
after : String
before : String
first : Int
includePromises : Boolean default: True

Whether to include payment promises (of any kind: made, broken or fulfilled) or not. The default is to include them.
last : Int
reason : PaymentReasonOptions

Filter for payments that were taken for a particular reason.
status : AccountPaymentStatusOptions

Filter for payments by their status.
paymentSchedules : ScheduleConnectionTypeConnection

The payment schedules for this ledger. These schedules describe how we would expect to take payments on a given month.
Arguments
after : String
before : String
first : Int
last : Int
refundRequests : RefundRequestConnectionTypeConnection

Refund requests for a given ledger.
Arguments
after : String
before : String
first : Int
last : Int
repaymentRequests : RepaymentRequestConnectionTypeConnection

Repayment requests for a given ledger.
Arguments
after : String
before : String
first : Int
last : Int
repayments : AccountRepaymentConnectionTypeConnection

The repayments that have been requested for this ledger.
Arguments
after : String
before : String
first : Int
last : Int
statuses : [AccountRepaymentStatusOptions]

Only return repayments whose status matches one of these statuses.
statements : StatementBillingDocumentConnectionTypeConnection

A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Arguments
after : String
before : String
first : Int
last : Int
transactions : TransactionConnectionTypeConnection

Transactions on the given ledger.
Arguments
after : String
before : String
first : Int
fromDate : Date

Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
last : Int
orderBy : TransactionsOrderBy default: POSTED_DATE_DESC

The order in which to return the transactions.
toDate : Date

Optional date representing the end of the postedDate range filter. This date value is exclusive.
transactionTypes : [TransactionTypeFilter]

Include only these specific transaction types in the result.
usablePaymentInstructions : PaymentInstructionConnectionTypeConnection

The usable payment instructions for this ledger.
Arguments
after : String
before : String
first : Int
last : Int
usableAt : DateTime

The time at which the payment instructions should be usable.
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

{ "acceptsPayments": true, "affectsAccountBalance": true, "agreements": AgreementConnection, "amountOwedByCustomer": 73, "balance": 52, "billingTriggerConfiguration": BillingTriggerConfiguration, "creditTransferPermissionsData": CreditTransferPermissionsDataType, "debtLedger": LedgerInterface, "invoices": InvoiceBillingDocumentConnectionTypeConnection, "ledgerType": "peace-evidence-minute-share-mention", "name": "information-mission-son-method-serve", "number": "range-them-yet-author-fact", "paymentAdequacy": PaymentAdequacyDetailsType, "paymentForecast": PaymentForecastConnectionTypeConnection, "paymentPlans": PaymentPlanConnectionTypeConnection, "paymentPreferenceAtTime": PreferredInstruction, "paymentPreferences": PaymentPreferenceConnectionTypeConnection, "payments": AccountPaymentConnectionTypeConnection, "paymentSchedules": ScheduleConnectionTypeConnection, "refundRequests": RefundRequestConnectionTypeConnection, "repaymentRequests": RepaymentRequestConnectionTypeConnection, "repayments": AccountRepaymentConnectionTypeConnection, "statements": StatementBillingDocumentConnectionTypeConnection, "transactions": TransactionConnectionTypeConnection, "usablePaymentInstructions": PaymentInstructionConnectionTypeConnection }