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.
currentDirectDebitInstructionInvalidatedWithVendor : Boolean

True if the current direct debit instruction has been invalidated by vendor. False otherwise.
debtLedger : LedgerType

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
excludeExternallyIssued : Boolean

Exclude invoices that were issued by external systems. Does not apply to legacy bills.
first : Int
invoiceId : Int

The id of the invoice.
last : Int
orderBy : _BillingDocumentsOrderBy

The order the invoices should be returned in.
ledgerType : String

The ledger type code.
name : String

The display name of the ledger.
number : String

The canonical name of the ledger.
paymentAdequacy : PaymentAdequacyDetailsType
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
paymentsWithNonConcludedRePresentation : PaymentWithNonConcludedRePresentationConnectionTypeConnection

Payments with non-concluded re-presentation.
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
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
orderBy : _BillingDocumentsOrderBy

The order the statements should be returned in.
statementId : Int

The id of billing document.
supportsInvoices : Boolean

Is it possible for this ledger to contain invoices.
supportsStatements : Boolean

Is it possible for this ledger to contain statements.
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": 33, "balance": 17, "billingTriggerConfiguration": BillingTriggerConfiguration, "creditTransferPermissionsData": CreditTransferPermissionsDataType, "currentDirectDebitInstructionInvalidatedWithVendor": true, "debtLedger": LedgerType, "invoices": InvoiceBillingDocumentConnectionTypeConnection, "ledgerType": "bag-present-field-address-Mr", "name": "modern-can-value-sit-it", "number": "couple-matter-candidate-evidence-stage", "paymentAdequacy": PaymentAdequacyDetailsType, "paymentPreferenceAtTime": PreferredInstruction, "paymentPreferences": PaymentPreferenceConnectionTypeConnection, "paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection, "refundRequests": RefundRequestConnectionTypeConnection, "repaymentRequests": RepaymentRequestConnectionTypeConnection, "statements": StatementBillingDocumentConnectionTypeConnection, "supportsInvoices": true, "supportsStatements": true, "transactions": TransactionConnectionTypeConnection, "usablePaymentInstructions": PaymentInstructionConnectionTypeConnection }