curl --request POST \
  --url https://api.voltview.co.uk/v1/billValidation/validateInvoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filePath": "accounts/123456789/invoices/INV2024001.pdf"
}
'

{
  "filePath": "accounts/123456789/invoices/INV2024001.pdf",
  "status": "passed",
  "errors": []
}

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

billValidation

validateInvoice

curl --request POST \
  --url https://api.voltview.co.uk/v1/billValidation/validateInvoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filePath": "accounts/123456789/invoices/INV2024001.pdf"
}
'

{
  "filePath": "accounts/123456789/invoices/INV2024001.pdf",
  "status": "passed",
  "errors": []
}

Authorizations

Authorization

string

header

required

JWT token obtained from /v1/requestToken endpoint

Body

application/json

filePath

string

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:

"accounts/123456789/invoices/INV2024001.pdf"

userConsumptionData

object

Optional user-provided consumption data to validate against the invoice

Show child attributes

userConsumptionData.fromDate

string<date-time>

Start date of consumption period (ISO 8601)

Example:

"2024-06-01T00:00:00.000Z"

userConsumptionData.toDate

string<date-time>

End date of consumption period (ISO 8601)

Example:

"2024-07-01T00:00:00.000Z"

userConsumptionData.utilityType

enum<string>

Type of utility

Available options:

ELECTRICITY,

GAS,

BMS

userConsumptionData.consumption

object

Consumption values for the period

Show child attributes

userConsumptionData.consumption.activeImportKwh

number

Active energy imported (main consumption) in kWh

Example:

5223

userConsumptionData.consumption.activeExportKwh

number

Active energy exported in kWh (for sites with generation)

userConsumptionData.consumption.dayConsumption

number

Day/peak consumption in kWh (for dual-rate tariffs)

userConsumptionData.consumption.nightConsumption

number

Night/off-peak consumption in kWh (for dual-rate tariffs)

userConsumptionData.consumption.reactiveImportKvarh

number

Reactive energy imported in kvarh (electricity only)

userConsumptionData.consumption.reactiveExportKvarh

number

Reactive energy exported in kvarh (electricity only)

userConsumptionData.consumption.apparentKvah

number

Apparent energy consumption in kVAh (electricity only)

userConsumptionData.meterReadings

object

Optional meter reading information

Show child attributes

userConsumptionData.meterReadings.previousReading

number

Previous meter reading

Example:

100000

userConsumptionData.meterReadings.currentReading

number

Current meter reading

Example:

105223

userConsumptionData.meterReadings.previousReadingDate

string<date-time>

Date of previous reading (ISO 8601)

Example:

"2024-06-01T00:00:00.000Z"

userConsumptionData.meterReadings.currentReadingDate

string<date-time>

Date of current reading (ISO 8601)

Example:

"2024-07-01T00:00:00.000Z"

userConsumptionData.meterReadings.previousReadingType

enum<string>

Type of previous reading

Available options:

actual,

estimated,

customer,

smart

userConsumptionData.meterReadings.currentReadingType

enum<string>

Type of current reading

Available options:

actual,

estimated,

customer,

smart

Response

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

filePath

string

File path to the validated invoice document

status

enum<string>

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

Available options:

passed,

failed,

pending

errors

object[]

Array of validation errors found. Empty array indicates validation passed.

Show child attributes

errors.type

enum<string>

Type of validation error detected

Available options:

consumptionMismatch,

rateMismatch,

standingChargeError,

dayRateMismatch,

nightRateMismatch,

capacityChargeError,

vatError,

cclError,

dateMismatch,

other

errors.description

string

Human-readable description of the validation error

errors.expected

string

Expected value or condition

errors.actual

string

Actual value found that caused the validation error

Parse contract Delete invoice

⌘I

API Documentation

Authentication

User

Sites

Meters

Emissions

Specific Site

Energy Consumption

Supplier Integration

LOA Management

Bill Validation

Validate invoice

Authorizations

Body

Response