curl --request POST \
  --url https://api.voltview.co.uk/v1/billValidation/validateInvoice \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --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 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filePath": "accounts/123456789/invoices/INV2024001.pdf"
}
'

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

Authorizations

x-api-key

string

header

required

VoltView API key

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

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

Parse contract Delete invoice