Preview

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

BalanceCustomer

Definition of a Customer

This page contains

    Fields

    id: ID!

    ID of the customer

    createdOn: DateTime!

    Creation date of the customer in customer balance service

    payer: Payer! PREVIEW

    User that has to pay to a merchant. It can be a account or a user in the context of a account

    merchantOfRecord: MerchantOfRecord! PREVIEW

    Merchant of record. Either the selling party or marketplace (tenant)

    balanceLedgers(withHistory: Boolean): [CustomerBalanceLedger]

    List customer balances. If withHistory is enabled, it will return the full history of balances for this customer

    payments(first: Int, after: String, last: Int, before: String): BalancePaymentConnection

    List of customer's payments

    invoices(first: Int, after: String, last: Int, before: String): BalanceInvoiceConnection

    List of customer's invoices

    unpaidInvoices(first: Int, after: String, last: Int, before: String): BalanceInvoiceConnection

    List of customer's unpaid invoices

    creditMemos(first: Int, after: String, last: Int, before: String): BalanceCreditMemoConnection

    List of customer's credit memos

    Parent objects of BalanceCustomer

    BalanceCustomerConnection PREVIEW
    CreditMemo PREVIEW

    Definition of an credit memo

    Invoice PREVIEW

    Definition of an invoice

    Payment PREVIEW

    Definition of a payment

    Queries for BalanceCustomer

    creditMemo PREVIEW
    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

    customersForMerchantOfRecord PREVIEW

    Retrieve all customer with the latest balance by Merchant of Record

    invoice PREVIEW

    Retrieve an invoice by id

    payment PREVIEW

    Retrieve a payment by id

    paymentByPaymentNumber PREVIEW

    Retrieve a payment by payment number