Skip to main content

InvoiceListSummary

Totals for the invoice list, counted over the whole filtered set in the organization's base currency.

type InvoiceListSummary {
  draftCount: Int!
  dueAmount: Float!
  issuedCount: Int!
  overdueAmount: Float!
  overdueCount: Int!
  paidAmount: Float!
  totalAmount: Float!
  totalCount: Int!
}

Fields​

InvoiceListSummary.draftCount ● Int! non-null scalar​

How many matching invoices are drafts.

InvoiceListSummary.dueAmount ● Float! non-null scalar​

The amount still owed on issued invoices, in the base currency.

InvoiceListSummary.issuedCount ● Int! non-null scalar​

How many matching invoices are issued, meaning not draft, cancelled or voided.

InvoiceListSummary.overdueAmount ● Float! non-null scalar​

The amount still owed on overdue invoices, in the base currency.

InvoiceListSummary.overdueCount ● Int! non-null scalar​

How many issued invoices are past their due date.

The amount paid on issued invoices, in the base currency.

InvoiceListSummary.totalAmount ● Float! non-null scalar​

The total of issued invoices, in the organization's base currency.

InvoiceListSummary.totalCount ● Int! non-null scalar​

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

Returned By​

invoiceListSummary query