Invoer
Factuur in PDF- of XML-formaat
Eén bestand per verzoek, gecodeerd in Base64
Uitvoer
Gestructureerde factuurgegevens
Kopgegevens en regelitems
Verwerking
Asynchroon
Poll met een poll-ID, maximaal om de 30 seconden
Toegang
Testomgeving en productieomgeving
Wordt apart in rekening gebracht, mogelijk gemaakt door Qvalia-ondersteuning
Een factuur in twee verzoeken vastleggen
Codeer het bestand in Base64, verstuur het met `enrichmentTypes` ingesteld op `capture` en verzamel het resultaat met de polling-ID uit het antwoord.
- Eén factuurbestand per aanvraag, in PDF- of XML-formaat
- Neem de bestandsextensie op in bestandsnaam
- Voer de poll niet vaker dan eens per 30 seconden uit
- Haal alleen het vastleggingsresultaat op via het pad `enrichmentType`
● ● ●
Sandbox-verzoek: een factuur vastleggen
# capture-request.json
{
"fileName": "invoice.pdf",
"fileContent": "<Base64-encoded PDF>",
"enrichmentTypes": "capture"
}
curl -X POST \
"https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/invoice" \
-H "Authorization: $QVALIA_API_KEY" \
-H "Content-Type: application/json" \
-d @capture-request.json
# Collect the result with the pollingId
curl "https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/$POLLING_ID/capture" \
-H "Authorization: $QVALIA_API_KEY"Probeer het eens met je eigen PDF-factuur
Upload een PDF-factuur van maximaal 4,5 MB in de gratis testversie van Qvalia en bekijk de gestructureerde gegevens die hieruit worden gegenereerd. Er is geen integratie nodig en er is een voorbeeldrapport beschikbaar als u geen bestand bij de hand hebt.
Hoe het scannen van facturen werkt
Het uploaden verloopt asynchroon. Je uploadt het bestand, Qvalia verwerkt het en je haalt het resultaat op zodra het klaar is.
Uploaden
Stuur per verzoek één PDF- of XML-factuur, gecodeerd met Base64, naar het factuur-eindpunt.
Vastleggen
Qvalia leest het document en zet de koptekstgegevens en de afzonderlijke posten om in gestructureerde factuurgegevens.
Enquête
Gebruik de polling-ID. Een 202 betekent dat de verwerking doorgaat, en een 200 geeft het resultaat weer.
Recensie
Controleer de fouten en waarschuwingen die voor elk document worden weergegeven voordat de gegevens verder worden verwerkt in uw proces.
Eindpunten vastleggen
Alle paden zijn relatief ten opzichte van de basis-URL van de sandbox of de productieomgeving en zijn gekoppeld aan uw accountregistratienummer.
| Verzoek | Eindpunt | Retourzendingen |
| Een factuur uploaden | POST /enrichment/{accountRegNo}/invoice | Enquête-ID |
| Bekijk alle resultaten | GET /enrichment/{accountRegNo}/{pollingId} | Status, of resultaten per type |
| Bekijk het resultaat van de opname | GET /enrichment/{accountRegNo}/{pollingId}/capture | Resultaat van de opname |
Sandbox: api-test.qvalia.com. Productie: api.qvalia.com. Capture maakt deel uit van de Enrichment API, waarvoor apart wordt gefactureerd en die door de Qvalia-ondersteuning wordt geactiveerd.
Waar moet je rekening mee houden bij een integratie?
De vastlegging vindt plaats buiten uw aanvraagcyclus om. Houd hier rekening mee voordat u live gaat.
- Asynchrone verwerking
Sla de polling-ID samen met het document op en voer de polling niet vaker dan eens per 30 seconden uit. - Fouten en waarschuwingen
Leid documenten met fouten door naar handmatige controle en laat waarschuwingen zichtbaar blijven voor de gebruiker. - Rate limits
Het aantal limieten geldt per account voor alle Qvalia-API’s. Bij een 429-statuscode moet je de Retry-After-periode afwachten. - Afzonderlijke omgevingen
Test eerst op api-test.qvalia.com voordat je overschakelt naar api.qvalia.com. - Verlopen polling-ID's
Een 404-foutmelding betekent dat de polling-ID onbekend is of is verlopen. Upload het document opnieuw als het resultaat nog niet is verzameld.
Kies je startpunt
In de webapplicatie
Factuur-OCR
Voer PDF-facturen in de Qvalia-webapplicatie in zonder een integratie te hoeven bouwen.
Plaatsing en indeling
Enrichment-API
Het plaatsen van suggesties en de UNSPSC-classificatie. Capture is de ondersteunende stap waarmee PDF-facturen voor beide doeleinden worden voorbereid.
Aan de slag
Snelstartgids voor de API
Stel API-toegang in en verstuur je eerste verzoek, stap voor stap.
Veelgestelde vragen over de OCR-API voor facturen
Wat is de Invoice OCR API?
Een REST-API die PDF-facturen omzet in gestructureerde factuurgegevens. Deze API wordt uitgevoerd als het vastleggingstype van de Enrichment API.
Welke bestanden kan ik versturen?
Eén PDF- of XML-factuur per aanvraag, Base64-gecodeerd in het veld `fileContent`. Vermeld de bestandsextensie in `fileName`.
Wat levert de API op?
Gestructureerde factuurgegevens met koptekstgegevens en regelitems, samen met fouten en waarschuwingen voor het document.
Hoe lang duurt het vastleggen?
De verwerking verloopt asynchroon, dus de duur varieert per document. Vraag het resultaat-eindpunt niet vaker dan eens per 30 seconden op, totdat je een 200-statuscode ontvangt.
Waarin verschilt de OCR-API van Invoice OCR?
De OCR-verwerking van facturen vindt plaats in de Qvalia-webapplicatie. Via de OCR-API kunt u de gegevens via een REST-API in uw eigen systeem importeren.
Is er een sandbox?
Ja. Gebruik api-test.qvalia.com voor testdoeleinden en api.qvalia.com in de productieomgeving.
Is de OCR-API opgenomen in andere Qvalia-API’s?
Nee. Capture maakt deel uit van de Enrichment API, waarvoor apart wordt gefactureerd. De ondersteuning van Qvalia schakelt deze functie voor uw account in.
