CODA-bestanden importeren via API : EenvoudigFactureren

EenvoudigFactureren API CODA-bestanden

CODA-bestanden kunnen via de website worden geïmporteerd en gekoppeld aan openstaande facturen. Via de API kunt u deze CODA-bestanden ook geautomatiseerd inlezen en koppelen.

Op deze pagina krijgt u een overzicht van alle technische details van de CODA-API.

Toegang

De API maakt gebruikt van REST met basic authentication. U dient dus steeds uw e-mailadres en wachtwoord op EenvoudigFactureren in te geven om toegang tot de API te hebben.

U stuurt de inhoud van een CODA-bestand door naar de API en deze zal automatisch een koppeling met openstaande facturen maken.

Het is aan te raden om een afzonderlijke gebruiker aan uw account toe te voegen die enkel bij API-toegang wordt gebruikt. Zo heeft u geen nood aan de credentials van de normale gebruikers.

Indien een gebruiker toegang heeft tot verschillende accounts kunt u de gewenste account doorgeven in de header via “X-AccountId”. Het account-nummer (AccountId) van een account kunt u opvragen langs “Account” (menu rechtsboven). Wordt er geen account-nummer opgegeven dan wordt de standaard account van de gebruiker gebruikt (in te stellen langs “Gebruiker” (menu rechtsboven).

CODA-bestand doorsturen

Een CODA-bestand is een verzameling van één of meerdere bankverrichtingen. Deze hebben een vast formaat waarbij elke lijn in het bestand exact 128 karakters lang is.

Om een CODA-bestand te importeren stuurt u de inhoud van het CODA-bestand in de body van een POST-method door naar de URL: https://eenvoudigfactureren.be/coda/import.

Resultaat

Volgende resultcodes kunnen worden teruggegeven

200: Actie verwerkt
400: Geen toegang
401: Authenticatie gebruiker niet aanvaard
500: Interne fout

Als resultaat worden de ingelezen bankverrichtingen en hun koppeling in JSON-formaat teruggegeven

Een voorbeeld:

{
  “transactions_count”: 1,
  “transactions_success_count”: 1,
  “transactions_with_error_count”: 0,
  “transactions”: [
    {
      “account”: {
        “name”: “BVBA.BAKKER PIET”,
        “number”: “BE54805480215856”,
        “bic”: “GEBCEEBB”,
        “country”: “”,
        “currency”: “EUR”,
        “summary”: “BVBA.BAKKER PIET (BE54805480215856)”,
    },
    “transaction_date”: “2014-12-25”,
    “valuta_date”: “2014-12-25”,
    “message”: “618/1416/12542 813 ANOTHER MESSAGE MESSAGE”,
    “amount”: 1767.82,
    “amount_negative”: false,
    “structured_message”: “”,
    “transaction_index”: 1,
    “document_id”: 359403,
    “payment_id”: “263566”
  }]
}

Loopt de verwerking verkeerd door een blokkerende fout (bvb. foutieve inhoud) dan wordt in het veld “error” de reden teruggegeven. (Opmerking: De resultcode is in deze situatie nog steeds 200).

{
“error”: “no content found”
}

Voorbeeld (PHP)

$email = 'luc@mymail.com';
$password = '123456';

$codaContent = file_get_contents('my_coda_file.txt');

$p = curl_init('https://eenvoudigfactureren.be/coda/import');
curl_setopt($p, CURLOPT_HTTPHEADER, ['Accept: application/json']);
curl_setopt($p, CURLOPT_USERPWD, $email . ':' . $password);
curl_setopt($p, CURLOPT_POSTFIELDS, $codaContent);
curl_setopt($p, CURLOPT_RETURNTRANSFER, TRUE);
$result = json_decode(curl_exec($p));