Invoices
Invoices on the account. When the customer has an invoice number, pass it as `identifier`: that is the sharpest lookup and returns the invoice with a breakdown (fees per kind, and charging costs per month, where a month outside the service period means delayed sessions). Without a number, always pass `type`, which customers almost always know (charging card, charging station or reimbursement), and `period` when they name a month. Lists show the 12 newest matches; every invoice shows its status and, on error, the problem. The service period is the month the invoice covers; the invoice is usually dated the month after. Payment status is not part of this tool: never say an invoice is paid or unpaid from it. Callers who can read the account's invoices see all of them except colleagues' personal reimbursements, which only that colleague sees; other callers see only their own reimbursements. Each response carries a `message` stating what it shows. Requires a verified customer: if the conversation has none yet, ask for their email and run customer-request-verification, then customer-verify.
Verified customerRequiredInput3
The kind of invoice the customer means. Pass it whenever there is no invoice number.
periodobjectOnly invoices for this service period.
Only invoices for this service period.
Without a year the period filter is ignored.
Omit to match the whole year.
An invoice number exactly as the customer wrote it, character for character, including any letters before the digits. Returns that invoice with its breakdown; the other filters are then ignored.
Output9
account: the caller can read the account's invoices. own-reimbursements: the caller sees only their own personal reimbursements; the account admin sees the other invoices.
lookupobject | nullREQUIREDSet when an invoice number was given.
Set when an invoice number was given.
colleague-reimbursement: another user's personal reimbursement, only they can see it, in their own login. no-invoice-access: the invoice exists on the account but the caller cannot read it. manual-document: INV and CM numbers are manual invoices and credit notes kept outside the platform; support can send a copy. Not-found without a reason does not prove the invoice does not exist.
subinvoiceobject | nullREQUIREDSet when the number is a country VAT invoice within a larger invoice; its own amounts.
Set when the number is a country VAT invoice within a larger invoice; its own amounts.
invoicesobject[]REQUIRED
Invoice number.
charging-card: the monthly charging card invoice (MSP): sessions charged with the card, card subscriptions and card fees. charging-station: the subscription and usage fees for charging stations the account owns (CPO). reimbursement: the payout for sessions on the account's charging stations, also called credit invoice or home charging compensation. Each type includes its delayed run, an extra invoice for sessions that arrived late.
True for the extra invoice with sessions that arrived after the regular run.
ready: generated and final. pending: still being generated. error: generation ran into a problem, see problem. excluded: excluded from billing.
problemobject | nullREQUIRED
Serial numbers of the charging stations the problem is about (at most 5), for troubleshooting.
servicePeriodobjectREQUIREDThe period the invoice covers. The invoice itself is usually dated the month after.
The period the invoice covers. The invoice itself is usually dated the month after.
Null for multi-month (e.g. 3-month) periods.
YYYY-MM-DD.
amountobjectREQUIRED
Amount excluding VAT; null when not recorded, never 0.
Amount including VAT; null when not recorded, never 0.
False while the invoice is pending or its data is fatal or incomplete: never present it as the total.
Charging sessions on the invoice; null when not recorded.
kWh on the invoice; null when not recorded.
A ready invoice of 0. These are not sent to accounting.
Reimbursements only: paid out to the caller personally, or to the account.
breakdownobject | nullOnly when looked up by invoice number. Null when not recorded.
Only when looked up by invoice number. Null when not recorded.
feesobject[]REQUIREDThe rows printed on the invoice, summed per kind across all cards and charging stations.
The rows printed on the invoice, summed per kind across all cards and charging stations.
kWh, sessions, cards or stations, depending on the kind.
Sessions behind the amount, when the kind is per session.
byMonthobject[]REQUIREDCharging costs or reimbursed sessions per month the sessions took place.
Charging costs or reimbursed sessions per month the sessions took place.
True for sessions from another month than the service period: delayed sessions.
Charging cards on the invoice.
Invoices matching the filters, of which invoices holds the newest.
How many of the matching invoices (total) are in error.
True when there are more invoices than returned: never present the list as complete.
nearestPeriodsobject[] | nullREQUIREDWhen the asked period has no invoices: the closest service periods that do.
When the asked period has no invoices: the closest service periods that do.
What this response shows, in plain facts: scope, completeness and what is missing.