paymentListSummary

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

Returns summary totals for the same filters as payments, covering every matching payment 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 PaymentListSummary {
  paymentListSummary {
    totalCount
    unallocatedAmount
    month {
      amount
      count
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PaymentListSummary {\n  paymentListSummary {\n    totalCount\n    unallocatedAmount\n    month {\n      amount\n      count\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "paymentListSummary": {
      "totalCount": 0,
      "unallocatedAmount": 0,
      "month": {
        "amount": 0,
        "count": 0
      }
    }
  }
}

paymentListSummary(
  filter: PaymentFilterInput
): PaymentListSummary!

Arguments

paymentListSummary.filter ● PaymentFilterInput input

The same filters as payments. Totals cover every payment that matches.

Type

PaymentListSummary object

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.