Enrichment API

Upload an Invoice PDF

post

API accepts a single invoice file (PDF or XML) and processes it asynchronously. Returns a polling ID to check the status of enrichment. Send the pollingId to the enrchment GET endpoint to get the status or completed result.

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia.

Default: ""

Header parameters

LocationstringOptional

URL to poll the status.

Default: ""

Body

fileNamestringOptional

Optional name of the file being uploaded, including extension (e.g., invoice.pdf).

Example: invoice.pdf

fileContentstring · byteRequired

The Base64 encoded content of the file.

Example: UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==

enrichmentTypesstringRequired

types of enrichment tasks to perform. Ex; "peppol"

Example: peppol

Responses

202

File accepted for processing.

application/json

400

Invalid file or request.

application/json

post

HTTPcURLJavaScriptPython

POST /{accountRegNo}/invoice HTTP/1.1
Host: api.qvalia.comenrichment
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "fileName": "invoice.pdf",
  "fileContent": "UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==",
  "enrichmentTypes": "peppol"
}

{
  "status": "text",
  "data": {
    "pollingId": "text"
  }
}

Poll for and get enrichment

get

This endpoint allows clients to check the status of an invoice file’s enrichment process using a polling ID. Since enrichment is an asynchronous operation, this endpoint should be used to monitor progress and retrieve results once processing is complete.

Polling Behavior

• If the enrichment process is still ongoing, the API will return HTTP 202 (Accepted), indicating that the request was received and is still being processed.

• Once the enrichment is complete, the API will return HTTP 200 (OK) along with the final result.

• Clients must limit polling requests to once every 30 seconds. Requests made at a higher frequency may be rate-limited or rejected

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia.

Default: ""

pollingIdstringRequired

The unique polling ID for the file.

Default: ""

Responses

200

Enrichment complete, result available.

application/json

202

Enrichment still in progress.

application/json

400

Invalid or expired polling ID.

application/json

404

Invalid or expired polling ID.

application/json

429

The client has exceeded the polling frequency limit. The request is rejected, and the client should wait before retrying.

application/json

get

HTTPcURLJavaScriptPython

GET /{accountRegNo}/{pollingId} HTTP/1.1
Host: api.qvalia.comenrichment
Accept: */*

{
  "status": "text",
  "data": {
    "peppol": {
      "result": {
        "Invoice": {}
      },
      "errors": [],
      "warnings": []
    }
  }
}

Get individual enrichment result

get

Get the enrichment result using the polling ID. Returns the result in the format requested.

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia.

Default: ""

pollingIdstringRequired

The unique polling ID for the file.

Default: ""

enrichmentTypestringRequired

The enrichment type returned in the polling endpoint.

Default: ""

Responses

200

Enrichment complete, result available.

application/json

404

Invalid or expired polling ID.

application/json

get

HTTPcURLJavaScriptPython

GET /{accountRegNo}/{pollingId}/{enrichmentType} HTTP/1.1
Host: api.qvalia.comenrichment
Accept: */*

{
  "status": "text",
  "data": {}
}