Validatietool voorzien van API

3 december 2018

Via de Ketenstandaard Validatie API (Application Programming Interface) is het voor softwareontwikkelaars mogelijk om SALES Standaard Berichten te valideren in de eigen programmaomgeving. Er hoeft met deze API niet meer via de website van Ketenstandaard ingelogd te worden, maar er wordt door de software een rechtstreekse connectie opgezet met de validatietool. 

Door het aanroepen van de Validatie API kan een SALES Standaard Bericht technisch en op een aantal businessrules worden gevalideerd en is daarmee in functionaliteit gelijk aan de bekende webversie van de validatietool.

Na het aanroepen van de API wordt het aangeboden SALES Standaard Bestand gevalideerd en geeft de API antwoord in de vorm van een JSON-string. In dit antwoord staat, naast het aantal fouten en waarschuwingen, het type bestand (factuur/order/..), het formaat (INSBOU/SALES) en welke versie (003/004/005):

  "documentType": "Bouw-Installatie Factuur 003",
  "format": "INSBOU",
  "version": "003",
  "type": "INVOIC",
  "totalErrorsFound": 5,
  "totalWarningsFound": 7,

Mocht u gebruik maken van de SALES Standaard Messageservice; de samenstelling van de velden is zo opgesteld dat een vergelijking mogelijk is met data uit de Messageservice. Vervolgens krijgt u een gedetailleerd validatieresultaat zodat het bestand kan worden aangepast om te voldoen aan de SALES Standaard:

{
"businessRule": "InvoiceTotalAmounts",
"xPath": "/Invoice/InvoiceTotals/TotalInvoiceAmount",
"lineNumber": 137,
"linePosition": 4,
"message": "InvoiceTotal InvoiceAmount 145 is ongelijk aan de optelsom van de onderdelen 147.9",
"severity": "Error"
},
{
"businessRule": "InvoiceVatRegistrationNumber_Valid",
"xPath": "//VATRegistrationNumber",
"lineNumber": 34,
"linePosition": 4,
"message": "VATRegistration (BTW8712345-0001) mag maximaal 14 karakters bevatten",
"severity": "Error"
},
{
"businessRule": "ProjectNumberRequired",
"xPath": "//ProjectNumber",
"message": "Projectnummer ontbreekt",
"severity": "Warning"
}

Voor gebruik van de API dient er bij Ketenstandaard een set inloggegevens aangevraagd te worden, deze zijn niet gelijk aan de inloggegevens voor de website! Bij deze aanvraag krijgt u ook documentatie aangeleverd over hoe de API aangeroepen moet worden. Ook bij vragen over de voorwaarden en mogelijkheden informeren we u graag!

info@ketenstandaard.nl
088-1500800

Agenda

Laden...