Customer
Returns an account-wide overview: account-level credit limits and charging activity this month (both the charging-cards and charge-points sides) with per-user limits, plus charge-point counts and fleet health and charging-card counts. Stats only: this tool does NOT list the individual charge points or charging cards, so for those call charge-points-summary or charging-cards-summary instead. Access is per section: account-level user read unlocks the other users and the account verifications; account-level card read makes the card stats cover the account rather than only the caller; charge-point stats are account-wide for every caller. For individual session records use charge-points-sessions or charging-cards-sessions.
Input
Output5
accountobject | nullREQUIRED
limitsobjectREQUIRED
currentMonthobjectREQUIRED
Credit limit; null when none is set.
Usage within the period named by the holding field.
verificationsobject | nullREQUIRED
completedobject[]REQUIRED
The e-mail / phone, or the IBAN masked to its last 4 characters (e.g. "**** 1234"); null when not provided.
ISO timestamp when verified; null when not yet verified.
remainingobject[]REQUIRED
The e-mail / phone, or the IBAN masked to its last 4 characters (e.g. "**** 1234"); null when not provided.
ISO timestamp when verified; null when not yet verified.
sessionsobjectREQUIRED
chargingCardsobjectREQUIRED
currentMonthobjectREQUIRED
chargePointsobject | nullREQUIRED
currentMonthobjectREQUIRED
revenueobject[]REQUIRED
usersobject[]REQUIRED
True for the calling user.
limitsobjectREQUIRED
currentMonthobjectREQUIRED
Credit limit; null when none is set.
Usage within the period named by the holding field.
sessionsobjectREQUIRED
currentMonthobjectREQUIRED
chargePointsobjectREQUIRED
statsobject | nullREQUIRED
Distinct locations the account's charge points sit at.
Charge points with connectivityState "connected".
Charge points not currently connected.
Charge points offline, reboot-required or disabled.
Charge points where roaming is on, i.e. a charge card from outside this platform is accepted. This is NOT a count of publicly listed or map-visible charge points; that is the location publishingMode, a separate setting.
Total active (unresolved) issues across the account's charge points.
Connector count keyed by status.
chargingCardsobjectREQUIRED
statsobject | nullREQUIRED
chargingCardsobjectREQUIRED
Charging cards with status "active".
Charging cards whose token is blocked.