commissionLedgerSummary

Requires permission commissions:commission:read.

Returns commission ledger totals by status over the whole filtered set, with entry and order counts and the roles that still have no rate. Requires permission to read commissions.

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 CommissionLedgerSummary {
  commissionLedgerSummary {
    entries
    orders
    unratedCount
    unratedRoles
    byStatus {
      status
      amount
      count
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CommissionLedgerSummary {\n  commissionLedgerSummary {\n    entries\n    orders\n    unratedCount\n    unratedRoles\n    byStatus {\n      status\n      amount\n      count\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "commissionLedgerSummary": {
      "entries": 0,
      "orders": 0,
      "unratedCount": 0,
      "unratedRoles": [
        "string"
      ],
      "byStatus": [
        {
          "status": "LOCKED",
          "amount": 0,
          "count": 0
        }
      ]
    }
  }
}

commissionLedgerSummary(
  filters: CommissionFiltersInput
): CommissionLedgerSummary!

Arguments

commissionLedgerSummary.filters ● CommissionFiltersInput input

Optional filters. The same ones as commissions.

Type

CommissionLedgerSummary object

Headline figures of the commission ledger over the whole filtered set.