Skip to main content
POST
/
v1
/
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

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.

⌘I