PaymentListSummary

Totals for the payment list, counted over the whole filtered set in the organization's base currency. Only money that moved is included: not draft, cancelled, reversed or refunded payments, and not credit or debit note settlements.

type PaymentListSummary {
  month: PaymentListSummaryBucket!
  today: PaymentListSummaryBucket!
  total: PaymentListSummaryBucket!
  totalCount: Int!
  unallocatedAmount: Float!
  week: PaymentListSummaryBucket!
}

Fields

PaymentListSummary.month ● PaymentListSummaryBucket! non-null object

Cash dated this month.

PaymentListSummary.today ● PaymentListSummaryBucket! non-null object

Cash dated today.

PaymentListSummary.total ● PaymentListSummaryBucket! non-null object

Cash across all time.

PaymentListSummary.totalCount ● Int! non-null scalar

How many payments match the filter, drafts and cancelled included.

PaymentListSummary.unallocatedAmount ● Float! non-null scalar

The part of the total that no invoice has absorbed yet, in the base currency.

PaymentListSummary.week ● PaymentListSummaryBucket! non-null object

Cash dated this week, counted from Sunday.

Returned By

paymentListSummary query