Invoices
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
Invoices API
Get My Invoices
Returns invoices for the authenticated user.
User sessionAPI credentialRequest bodyapplication/json
500sortobjectdefault {"field":"createdAt","order":"desc"}
{"field":"createdAt","order":"desc"}ascdesc200OK application/json
dataInvoiceResource[]
Access token that grants access to the invoice PDF. Treat as a secret.
The account the invoice was issued to, populated when available.
ID of the account the invoice was issued to.
Billing period the invoice covers.
Bookable invoice amount, excluding VAT. Prefer netAmount, which carries the same value.
Bookable invoice amount, including VAT. Prefer grossAmount, which carries the same value.
When the invoice was created.
ISO 4217 currency code of the invoice.
Whether the invoice is excluded from further processing.
Gross invoice amount, including VAT.
Whether an error occurred while generating the invoice.
Unique identifier of the invoice.
Human-readable invoice number.
Invoice date in YYYY-MM-DD format.
Whether the invoice has been paid.
Whether the invoice has been fully generated and is ready.
Month the invoice applies to (1-12).
Net invoice amount, excluding VAT.
When the invoice was marked as paid.
Payment method used for the invoice.
Payment term of the invoice, in days.
The provider that issued the invoice, populated when available.
Whether the invoice was issued in an MSP or CPO context.
ID of the provider that issued the invoice.
Total accounting fees on the invoice.
Total invoice amount, excluding VAT. Prefer netAmount, which carries the same value.
Total invoice amount, including VAT. Prefer grossAmount, which carries the same value.
Total charge session costs, excluding VAT.
Number of charge sessions billed on the invoice.
Total reimbursed amount, excluding VAT. Used by reimbursement invoices. Prefer netAmount, which carries the same value.
Total reimbursed amount, including VAT. Used by reimbursement invoices. Prefer grossAmount, which carries the same value.
Total energy billed on the invoice, in kWh.
Total platform fees on the invoice.
Invoice type: cpo-usage, cpo-credit, cpo-credit-delayed-sessions, msp-usage or msp-usage-delayed-sessions.
When the invoice was last updated.
The user the invoice belongs to, populated when available.
ID of the user the invoice belongs to, for user-based invoices.
Year the invoice applies to.
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Get My Credit Invoices
Returns credit invoices for the authenticated user.
User sessionAPI credentialRequest bodyapplication/json
500sortobjectdefault {"field":"createdAt","order":"desc"}
{"field":"createdAt","order":"desc"}ascdesc200OK application/json
dataInvoiceResource[]
Access token that grants access to the invoice PDF. Treat as a secret.
The account the invoice was issued to, populated when available.
ID of the account the invoice was issued to.
Billing period the invoice covers.
Bookable invoice amount, excluding VAT. Prefer netAmount, which carries the same value.
Bookable invoice amount, including VAT. Prefer grossAmount, which carries the same value.
When the invoice was created.
ISO 4217 currency code of the invoice.
Whether the invoice is excluded from further processing.
Gross invoice amount, including VAT.
Whether an error occurred while generating the invoice.
Unique identifier of the invoice.
Human-readable invoice number.
Invoice date in YYYY-MM-DD format.
Whether the invoice has been paid.
Whether the invoice has been fully generated and is ready.
Month the invoice applies to (1-12).
Net invoice amount, excluding VAT.
When the invoice was marked as paid.
Payment method used for the invoice.
Payment term of the invoice, in days.
The provider that issued the invoice, populated when available.
Whether the invoice was issued in an MSP or CPO context.
ID of the provider that issued the invoice.
Total accounting fees on the invoice.
Total invoice amount, excluding VAT. Prefer netAmount, which carries the same value.
Total invoice amount, including VAT. Prefer grossAmount, which carries the same value.
Total charge session costs, excluding VAT.
Number of charge sessions billed on the invoice.
Total reimbursed amount, excluding VAT. Used by reimbursement invoices. Prefer netAmount, which carries the same value.
Total reimbursed amount, including VAT. Used by reimbursement invoices. Prefer grossAmount, which carries the same value.
Total energy billed on the invoice, in kWh.
Total platform fees on the invoice.
Invoice type: cpo-usage, cpo-credit, cpo-credit-delayed-sessions, msp-usage or msp-usage-delayed-sessions.
When the invoice was last updated.
The user the invoice belongs to, populated when available.
ID of the user the invoice belongs to, for user-based invoices.
Year the invoice applies to.
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Download My Invoice Sessions
Download sessions associated with one of the authenticated user's invoices.
User sessionAPI credentialPath parameters1
200CSV file text/csv
text/csvA delimited text file. Each row is one record and the columns are the fields below.