paymentSummary

Requires the permissions payments:invoice:list and payments:payment:list.

Returns the headline payment figures for the whole organization, the same numbers as paymentsDashboard. The filter argument is not used.

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 PaymentSummary {
  paymentSummary {
    collectionsCount
    overdueAmount
    overdueCount
    paymentsCount
    pendingInvoicesAmount
    pendingInvoicesCount
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PaymentSummary {\n  paymentSummary {\n    collectionsCount\n    overdueAmount\n    overdueCount\n    paymentsCount\n    pendingInvoicesAmount\n    pendingInvoicesCount\n  }\n}"
}
EOF

Response:

{
  "data": {
    "paymentSummary": {
      "collectionsCount": 0,
      "overdueAmount": 0,
      "overdueCount": 0,
      "paymentsCount": 0,
      "pendingInvoicesAmount": 0,
      "pendingInvoicesCount": 0
    }
  }
}

paymentSummary(
  supplierId: ID
): PaymentSummary!

Arguments

paymentSummary.supplierId ● ID scalar

Not used: the summary always covers all payments.

Type

PaymentSummary object

Headline payment figures for the payments dashboard, in the organization's base currency.