Preview

CustomerBalanceLedger is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

CustomerBalanceLedger

Definition of Customer Balance Ledger.

This page contains

    Fields

    id: ID!

    ID of the Customer Balance ledger

    createdOn: DateTime!

    Creation date of this balance

    balance: Decimal!

    Balance of the customer

    currency: Currency

    ISO 4217 currency for this ledger when known; null for synthetic aggregates

    transaction: BalanceTransaction! PREVIEW

    Transaction that created the new balance

    Parent objects of CustomerBalanceLedger

    BalanceCustomer PREVIEW

    Definition of a Customer

    Queries for CustomerBalanceLedger

    customer PREVIEW

    Retrieve a customer with the latest or all balance by id

    customerByUserAndAccountAndMerchant PREVIEW

    Retrieve a customer with the latest or all balance by user Id, account Id and Merchant of Record

    customerTotalBalanceByAccountAndMerchant PREVIEW

    Retrieves a ledger with the total balance for account Id and Merchant of Record in the marketplace default currency (company aggregate across all payers). This is a query only for powering the UI and should not be used for any other purpose as some field might not be populated.

    customerTotalBalanceByAccountAndMerchantWithCurrency PREVIEW

    Same aggregate as customerTotalBalanceByAccountAndMerchant for a specific ISO currency (company aggregate across all payers). This is a query only for powering the UI and should not be used for any other purpose as some field might not be populated.