v1

latestOpenAPI 3.0.3Proprietary2026-07-136748169.6 KB
Bill Validation

Validate invoice

Validates an invoice against contract data and optional user-provided consumption data. Performs comprehensive validation including consumption matching, meter reading verification, and check against contract.

Validation Rules:

  • Meter Reading Logic: Current reading must be ≥ previous reading
  • Contract Matching: Invoice date must fall within contract period
  • MPAN Matching: At least one MPAN must match between invoice and contract

Data Sources:

  • Manual uploads from parseInvoice endpoint
  • Invoices from Supplier Integration system
  • User-provided consumption and meter reading data
post/v1/billValidation/validateInvoice

Request body

filePathstring required

File path to the invoice document to validate. Can be from a manually uploaded invoice (parseInvoice endpoint) or from an invoice retrieved via Supplier Integration endpoints.

Example request

{
  "filePath": "accounts/123456789/invoices/INV2024001.pdf",
  "userConsumptionData": {
    "fromDate": "2024-06-01T00:00:00.000Z",
    "toDate": "2024-07-01T00:00:00.000Z",
    "consumption": {
      "activeImportKwh": 5223
    },
    "meterReadings": {
      "previousReading": 100000,
      "currentReading": 105223,
      "previousReadingDate": "2024-06-01T00:00:00.000Z",
      "currentReadingDate": "2024-07-01T00:00:00.000Z"
    }
  }
}

Response

Validation completed - may return passed, failed, or pending status

filePathstring

File path to the validated invoice document

status'passed' | 'failed' | 'pending'

Validation status - passed means all validations succeeded, failed means discrepancies were found, pending means validation could not be completed (e.g., missing contract data)