invoiceListSummary

Requires at least one of the permissions payments:invoice:list or purchase:purchase_invoice:list.

Returns summary totals for the same filters as invoices, covering every matching invoice rather than one page.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query InvoiceListSummary {
  invoiceListSummary {
    draftCount
    dueAmount
    issuedCount
    overdueAmount
    overdueCount
    paidAmount
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query InvoiceListSummary {\n  invoiceListSummary {\n    draftCount\n    dueAmount\n    issuedCount\n    overdueAmount\n    overdueCount\n    paidAmount\n  }\n}"
}
EOF

Response:

{
  "data": {
    "invoiceListSummary": {
      "draftCount": 0,
      "dueAmount": 0,
      "issuedCount": 0,
      "overdueAmount": 0,
      "overdueCount": 0,
      "paidAmount": 0
    }
  }
}

invoiceListSummary(
  filter: InvoiceFilterInput
): InvoiceListSummary!

Arguments

invoiceListSummary.filter ● InvoiceFilterInput input

The same filters as invoices. Totals cover every invoice that matches.

Type

InvoiceListSummary object

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