customerInvoiceSummary

Requires a customer (portal or buyer app) session.

Invoices-screen KPI tiles (per-currency outstanding / not-yet-due / overdue) + server-computed available credit. screen 10.

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 CustomerInvoiceSummary {
  customerInvoiceSummary {
    availableCredit
    creditCurrency
    creditLimitEnabled
    creditUnlimited
    onAccountAvailable
    buckets {
      currency
      invoicedTotal
      notYetDue
      outstanding
      overdue
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerInvoiceSummary {\n  customerInvoiceSummary {\n    availableCredit\n    creditCurrency\n    creditLimitEnabled\n    creditUnlimited\n    onAccountAvailable\n    buckets {\n      currency\n      invoicedTotal\n      notYetDue\n      outstanding\n      overdue\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "customerInvoiceSummary": {
      "availableCredit": 0,
      "creditCurrency": "string",
      "creditLimitEnabled": true,
      "creditUnlimited": true,
      "onAccountAvailable": true,
      "buckets": [
        {
          "currency": "string",
          "invoicedTotal": 0,
          "notYetDue": 0,
          "outstanding": 0,
          "overdue": 0
        }
      ]
    }
  }
}

customerInvoiceSummary: CustomerInvoiceSummary!

Type

CustomerInvoiceSummary object

Invoices-screen KPI tiles + server-computed available credit.