VWvwala
Intake

Analyze an uploaded energy invoice

Changed on

Accepts a single energy-invoice PDF (multipart/form-data, field 'file'), validates it is a genuine energy invoice, extracts its structured figures (per-energy-type consumption, injection, billed cost, billing period, merchant, EAN), and — when annualize=true — also returns figures rescaled to a full year. A readable PDF that is not an energy invoice returns 200 with status 'rejected'. Nothing is stored: the consumer owns any persistence. Each non-2xx response is an RFC 7807 Problem whose type says exactly what went wrong — see the individual error responses below.

post/v1/invoices/analyze

Request

Query parameters

annualizestring

When true, also return figures rescaled to a full year (365 days), per energy type, so a partial- or multi-year bill can be compared against yearly market contracts.

Request body multipart/form-data

filestring binary required

The energy invoice PDF to analyze (max 10 MB, single file).

Response

Default Response

OR

Changes

  • d5942334de4eRevision changes
    • info

      added the required property ///// to the response with the status

  • 1673faf11a0fRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status