Functie - Enrichment API

Uitbreidings-API voor het boeken van facturen en productclassificatie

Twee verrijkingen via één REST-API: voorgestelde accountcodering voor leveranciersfacturen en UNSPSC-classificatie van factuurregels, catalogi en prijslijsten. Capture ondersteunt beide door PDF-facturen eerst om te zetten in gestructureerde gegevens. Verzoeken worden asynchroon uitgevoerd en je haalt elk resultaat op met een polling-ID.

Facturen boeken en producten classificeren via Qvalia

Verrijkingen

Plaatsing en indeling

Aangevraagd per document

Ondersteuningsstap

Vastleggen

PDF-facturen naar gestructureerde gegevens

Taxonomie

UNSPSC

Resultaten weergegeven per product-ID

Verwerking

Asynchroon

Maximaal om de 30 seconden een peiling uitvoeren

Twee verrijkingen, met opvang als ondersteuning

Het plaatsen en classificeren zijn de verrijkingen. Het vastleggen is de stap waarbij een PDF-factuur wordt omgezet in gestructureerde gegevens, zodat beide processen kunnen worden uitgevoerd.

Suggesties plaatsen

Voorgestelde boekingscodes voor elke regel van een leveranciersfactuur, op basis van de boekingsgeschiedenis van uw organisatie. Uw team bevestigt elk voorstel.

Productclassificatie

UNSPSC-codes voor factuurregels en voor producten uit catalogi en prijslijsten, die elk worden weergegeven met uw eigen ID.

Vastleggen als ondersteuning

Wanneer een factuur als PDF binnenkomt, moet je eerst de koptekstgegevens en de regelitems vastleggen, zodat de boeking en classificatie kunnen werken met gestructureerde gegevens.

Resultaten verzamelen

Elk verzoek levert een polling-ID op. Verzamel de resultaten per verrijkingstype en voer de polling niet vaker dan eens per 30 seconden uit.

Een productlijst in twee verzoeken indelen

Stuur productnamen met uw eigen ID’s, bijvoorbeeld artikelen uit een catalogus, een prijslijst of uw artikelregister. In het antwoord ontvangt u een polling-ID, en het resultaat bevat elke product-ID met de bijbehorende UNSPSC-classificatie.

  • Uw product-ID's worden in het resultaat weergegeven
  • Meld je aan met een API-sleutel of een JWT uit de Account-API
  • Voer de poll niet vaker dan eens per 30 seconden uit
  • Aparte basis-URL’s voor de testomgeving en de productieomgeving

● ● ●

Sandbox-verzoek: producten classificeren

curl -X POST \ “https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/categorisation” \ -H “Authorization: $QVALIA_API_KEY” \ -H “Content-Type: application/json” \ -d ‘{ “enrichmentTypes”: “unspsc”, “products”: [ { “id”: 1, “product_name”: “Nitrile gloves, size M” }, { “id”: 2, “product_name”: “A4 copy paper, 80 g” } ] }’ # Collect the result with the pollingId curl “https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/$POLLING_ID” \ -H “Authorization: $QVALIA_API_KEY”
curl -X POST \
"https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/categorisation" \
-H "Authorization: $QVALIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "enrichmentTypes": "unspsc",
  "products": [
    { "id": 1, "product_name": "Nitrile gloves, size M" },
    { "id": 2, "product_name": "A4 copy paper, 80 g" }
  ]
}'

# Collect the result with the pollingId
curl "https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/$POLLING_ID" \
-H "Authorization: $QVALIA_API_KEY"

Eindpunten voor verrijking

Alle paden zijn relatief ten opzichte van de basis-URL van de sandbox of de productieomgeving en zijn gekoppeld aan uw accountregistratienummer.

VerzoekEindpuntRetourzendingen
Een factuur aanvullenPOST /enrichment/{accountRegNo}/invoiceEnquête-ID
Producten classificerenPOST /enrichment/{accountRegNo}/categorisationEnquête-ID
Bekijk alle resultatenGET /enrichment/{accountRegNo}/{pollingId}Status, of resultaten per type
Eén resultaat weergevenGET /enrichment/{accountRegNo}/{pollingId}/{enrichmentType}Resultaat van vastlegging, boeking of classificatie

Sandbox: api-test.qvalia.com. Productie: api.qvalia.com. De Enrichment API wordt apart in rekening gebracht, en de ondersteuning van Qvalia zorgt ervoor dat de verrijkingen die uw account gebruikt, beschikbaar zijn.

Wanneer verrijkte gegevens worden gebruikt

Het plaatsen van suggesties en UNSPSC-codes vormt de basis voor andere processen, zowel op uw eigen platform als in Qvalia.

  • Crediteuren
    De bevestigde rekeningcodering wordt samen met de factuur doorgevoerd naar de goedkeurings- en boekingsfase.
  • Catalogi en prijslijsten
    Voeg een UNSPSC-code toe aan artikelen in de catalogus en prijslijst die er nog geen hebben.
  • Met de UNSPSC-codes van de uitgavenanalyse
    kunt u aankopen per segment, productgroep en klasse groeperen, ongeacht de leverancier.
  • Uw eigen platform
    Geef suggesties en classificaties weer aan uw gebruikers in uw eigen interface.

Kies je startpunt

Bericht plaatsen

Boekhoud-API

Hoe suggesties voor berichten door uw team worden getraind, gecontroleerd en bevestigd.

Productgegevens

UNSPSC-classificatie

Hoe Qvalia factuurregels en productgegevens classificeert met behulp van UNSPSC.

Vastleggen

OCR-API

Alleen de invoerstap, met een gratis test voor uw eigen PDF-factuur.

Veelgestelde vragen over de Enrichment API

Wat is de Enrichment API?

Een REST-API met twee aanvullende functies: het aanbrengen van boekingsvoorstellen voor leveranciersfacturen en de UNSPSC-classificatie van factuurregels en producten. Capture is een ondersteunende stap waarbij PDF-facturen worden omgezet in gestructureerde gegevens voordat de boekings- en classificatieprocedure wordt uitgevoerd.

Waarom is ‘capture’ een ondersteunende stap?

Boekings- en classificatiewerkzaamheden op basis van gestructureerde gegevens. Facturen die binnenkomen als Peppol- of andere XML-documenten beschikken hier al over. Een PDF-factuur wordt eerst ingelezen, zodat de koptekstgegevens en de regelitems kunnen worden geboekt en geclassificeerd. Het inlezen is ook afzonderlijk mogelijk via de OCR-API.

Hoe werken suggesties voor berichten?

Ze worden getraind op basis van facturen die uw organisatie al heeft geboekt. Voor elke nieuwe leveranciersfactuur worden per regel voorstellen voor de rekeningcodering gedaan, die vervolgens door uw team worden bevestigd. Lees meer op de pagina over de Accounting API.

Kan ik catalogi en prijslijsten indelen?

Ja. Het classificatieverzoek vereist een lijst met producten, elk met een eigen ID en een productnaam, dus artikelen uit een catalogus, een prijslijst, een artikelregister of factuurregels worden op dezelfde manier verzonden.

Welke taxonomie wordt bij de classificatie gebruikt?

UNSPSC. Het resultaat geeft elke product-ID samen met de bijbehorende classificatie weer, zodat u deze kunt koppelen aan uw eigen gegevens.

Is er een sandbox?

Ja. Gebruik api-test.qvalia.com voor testdoeleinden en api.qvalia.com in de productieomgeving.

Is de Enrichment API opgenomen in andere Qvalia-API’s?

Nee. De Enrichment API wordt apart in rekening gebracht en vereist aanvullende machtigingen. De ondersteuning van Qvalia zorgt ervoor dat de verrijkingen die uw account gebruikt, worden geactiveerd.

Alle functies van het platform