paymentsDashboard

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

Returns the headline payment and invoice figures shown on the payments dashboard. Needs both the payment list and invoice list permissions.

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 PaymentsDashboard {
  paymentsDashboard {
    cashFlow {
      balance
      date
      inflow
      outflow
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PaymentsDashboard {\n  paymentsDashboard {\n    cashFlow {\n      balance\n      date\n      inflow\n      outflow\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "paymentsDashboard": {
      "cashFlow": [
        {
          "balance": 0,
          "date": "string",
          "inflow": 0,
          "outflow": 0
        }
      ]
    }
  }
}

paymentsDashboard: PaymentDashboard!

Type

PaymentDashboard object

The payments dashboard: headline totals, recent payments and breakdowns.