Koppeling nieuw boekhoudsysteem: Noodzakelijke voorwaarden API boekhoudsysteem

Deze vraag is bedoeld voor software leveranciers - niet voor (web)winkeliers/restauranthouders.

Bij het koppelen naar een nieuw boekhoudsysteem dient de API van het boekhoudpakket aan de volgende voorwaarden te voldoen:

  1. We koppelen alleen met REST API.
  2. De REST API dient gedocumenteerd te zijn. In het bijzonder dient de omschrijving van de velden en het feit of een veld verplicht is, te zijn gedocumenteerd. De documentatie dient overzichtelijk te zijn en te zijn opgezet met Swagger of een vergelijkbare API documentatie tool.
  3. Authenticatie bij voorkeur met OAuth. Een voorbeeld van het opzetten van OAuth met alle requests dient uitgeschreven te zijn.
  4. Er dienen endpoints te zijn voor:
    1. Debiteuren - zoeken op emailadres
    2. Financiele transacties - zoeken op id en bij voorkeur ook op nummer en datum
    3. Indien van toepassing producten - zoeken op id en op product-code / SKU
    4. BTW tarieven
    5. Grootboekrekeningen
    6. Dagboeken - als een dagboek verplicht moet worden meegegeven
    7. Betaalcondities - als een betaalconditie verplicht moet worden meegeven
    8. Factuurprofielen - als een factuurprofiel kan worden meegegeven
  5. Responses vanuit het boekhoudsysteem dienen aan te geven of een request geslaagd of niet geslaagd is.
  6. Als een actie geslaagd is dan is de HTTP Response code 200 en bevat de response in ieder geval:
    1. De transactie-id bij het toevoegen van een financiele transactie
    2. De debiteur-id, naam, adres bij het toevoegen of uitlezen van een debiteur
    3. De productid, omschrijving en prijs bij het toevoegen of uitlezen van een product
    4. Het BTW percentage en evt BTW code bij het uitlezen van BTW tarieven
    5. De grootboekrekening-code, id en omschrijving bij het uitlezen van de grootboekrekeningen
    6. De noodzakelijke details bij het uitlezen van betaalcondities en factuurprofielen
  7. Is een actie niet geslaagd dan is de HTTP response code 400 en bevat de response een omschrijving van wat er verkeerd is gegaan.
  8. Er zijn ruime API limieten of het moet mogelijk zijn om de ruimte binnen de API limiet te berekenen.
  9. Support: wij verwachten (i) dat technische problemen via een emailalias / support tool gelogd kunnen worden, (ii) een Nederlandse contactpersoon bij support, (iii) dat we transacties uit kunnen lezen op basis van een kenmerk of een referentie en (iv) na het melden van een technisch probleem binnen 1 werkdag een antwoord. Bij grote impact op eindgebruikers is het doel eventuele problemen zsm op te lossen.

Labels: Boekhouding