Preview

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

BalanceTransaction

Definition of Transaction.

This page contains

    Fields

    id: ID!

    ID of the Transaction

    createdOn: DateTime!

    Creation date of this transaction

    type: String

    Type

    amount: Decimal!

    Amount of money moved in this transaction

    target: BalanceTransactionTarget PREVIEW

    Target invoice/credit memo for this transaction

    source: BalanceTransactionSource PREVIEW

    Source invoice/credit memo/payment for this transaction

    Parent objects of BalanceTransaction

    CreditMemoLineItemBalanceLedger PREVIEW

    Definition of Credit Memo Line Item Balance Ledger.

    CustomerBalanceLedger PREVIEW

    Definition of Customer Balance Ledger.

    InvoiceLineItemBalanceLedger PREVIEW

    Definition of Invoice Line Item Balance Ledger.

    PaymentBalanceLedger PREVIEW

    Definition of Payment Balance Ledger.

    Queries for BalanceTransaction

    customerTotalBalanceByAccountAndMerchant PREVIEW

    Retrieves a ledger with the total balance for account Id and Merchant of Record 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.