.png)
API Fidly · v1.0
Koppel uw tools aan Fidly.
Webshop, CRM, kassa, ERP of vakapplicatie: de Fidly-API maakt uw facturen aan, verstuurt ze via Peppol, importeert uw documenten en synchroniseert uw relaties. Geen dubbele invoer meer, uw wettelijke facturatie blijft gecentraliseerd in Fidly.
✓ REST-API in JSON
✓ OAuth2, rechten per resource
✓ Geïsoleerde sandbox
✓ Peppol-verzending via API
In het kort
01
Uw software praat automatisch met Fidly.
Met de Fidly-API kan uw software, of die van een partner, de gegevens van uw onderneming lezen en schrijven: documenten, relaties, bankrekeningen, dagboeken en huisstijlen. Wat u in de applicatie doet, kan uw code ook.
01
Factureren vanuit uw tools
Een verkoop in uw webshop of CRM maakt de factuur aan in Fidly en verstuurt ze via Peppol.
02
Uw documenten importeren
Pdf, afbeeldingen of Peppol-XML: Fidly analyseert ze zoals bij slepen en neerzetten.
03
Uw gegevens synchroniseren
Klanten, leveranciers, leveringsadressen, rekeningen en dagboeken, zonder dubbele invoer.
04
Statussen opvolgen
Betaling, Peppol-verzending, doorsturen naar de boekhouder: alles is realtime leesbaar.
Aan de slag
02
Vier stappen tot uw eerste factuur via API.
1
Maak een sleutel aan
Instellingen, tabblad API: naam, omgeving (productie of sandbox), geldigheidsduur en rechten.
2
Vraag een token aan
Uw client_id en client_secret worden ingeruild voor een toegangstoken dat een uur geldig is en verlengd kan worden.
3
Test in de sandbox
Demogegevens, dezelfde validaties en foutcodes als in productie, zonder iets te wijzigen.
4
Ga naar productie
Een productiesleutel, en uw integratie werkt met uw echte gegevens.
Aanmaken en via Peppol versturen, in één oproep
POST https://api.fidly.be/documents?send_peppol=true
Authorization: Bearer eyJhbGciOi…
{
"type": "sale_invoice",
"relation_id": "8f3c2a…",
"lines": [{
"item_name": "Advies",
"quantity": 4,
"unit_price": 95,
"vat_code": "standard",
"vat_rate": 21
}]
}
→ 201: nummer, btw, totalen en gestructureerde mededeling berekend door Fidly
Wat de API dekt
03
De reikwijdte van de API, resource per resource.
01
Documenten
Lezen · aanmaken · wijzigen · verwijderen
–
Types
Verkoopfacturen en creditnota’s, selfbilling, proforma’s en alle ontvangen documenten (Peppol, e-mail, upload…).
Aanmaak
U geeft de relatie en de lijnen (tot 500); Fidly berekent nummer, btw, totalen, vervaldag en gestructureerde mededeling.
Btw
Normaal tarief, vrijstelling, 0 %, verlegging, intracommunautair, export, niet-btw-plichtig. Kortingen en toeslagen per lijn of per document.
Peppol-verzending
Bij aanmaak of later, met opvolging van de status: verzonden, aanvaard, geweigerd. Een mislukte verzending kan opnieuw.
Bestanden
Download van de pdf en de UBL-XML, bijlagen (pdf, afbeeldingen, csv, spreadsheets), import van documenten die automatisch geanalyseerd worden.
Betalingen
Registratie van een ontvangst die Fidly niet ziet (contant, niet-opgevolgde rekening), ook op een al verzonden document.
Beveiligingen
Een document dat verzonden of naar de boekhouder doorgestuurd is, kan niet meer gewijzigd worden; alleen het laatste nummer van een reeks kan verwijderd worden.
02
Relaties
Lezen · aanmaken · wijzigen · verwijderen
–
Bedrijven en contacten
Eén resource voor uw klanten en leveranciers, met adres, taal, btw-nummer en Peppol-ID.
Dubbels
Een bedrijf dat al bekend is (zelfde btw-nummer, ID of Peppol-adres) wordt gemeld in plaats van verdubbeld.
Leveringsadressen
Opgeslagen bij de relatie en herbruikbaar op haar documenten, met hun Peppol-ID (GLN).
03
Bankrekeningen
Lezen · aanmaken · wijzigen
–
Lezen
Gekoppelde rekeningen (PSD2), uit CODA-uittreksels of manueel, met hun saldo wanneer Fidly het synchroniseert.
Beheer
Aanmaak van manuele rekeningen (gecontroleerde IBAN) en keuze van de standaardrekening op de documenten.
04
Dagboeken
Lezen · aanmaken · wijzigen
–
Nummering
Vrij formaat (code, jaar, maand, boekjaar, teller) en reset per maand, per jaar of per boekjaar.
Standaarddagboek
Eén per categorie (verkopen, creditnota’s, aankopen, inkomend); het ontvangt de documenten die zonder dagboek aangemaakt worden.
05
Huisstijlen en referentielijsten
Lezen
–
Huisstijlen
De huisstijlen van uw documenten, en de keuze van de standaardstijl.
Referenties
Eenheden, munten en landen, vertaald in het Frans, Nederlands, Engels en Duits.
06
Beveiliging en conventies
Voor uw ontwikkelaars
–
Authenticatie
OAuth2 client credentials, token van een uur, refresh token voor eenmalig gebruik. Secrets worden gehasht opgeslagen bij Fidly.
Sleutels
Tot 10 actieve sleutels, geldig van 30 dagen tot 1 jaar of onbeperkt, onmiddellijk in te trekken.
Rechten
Aanmaken, lezen, wijzigen, verwijderen: elke actie wordt per resource toegestaan.
Conventies
JSON, gepagineerde en filterbare lijsten, alles-of-niets-verzoeken, fouten met een leesbare code en een request-ID voor de support.
Goed om te weten
04
Voor u begint.
Formule
De API zit in de Growth-formule
Samen met prestaties, automatische herinneringen en e-mailcampagnes. Een sandboxsleutel volstaat om uw integratie te ontwikkelen en te testen.
Goed om te weten
De API gaat verder dan de applicatie
Ze aanvaardt combinaties die de interface niet toont, zoals niet-Belgische btw-tarieven of meerdere kortingen per lijn. Verzenden per e-mail is nog niet beschikbaar via de API: verzenden gebeurt via Peppol.
FAQ
05
Vragen over de API.
Welke formule bevat de API?
De Growth-formule. U kunt een sandboxsleutel aanmaken om uw integratie te ontwikkelen en te testen voor u naar productie gaat.
Hoe krijg ik mijn sleutels?
In uw instellingen, tabblad API, knop “Nieuwe sleutel”. Het client secret wordt maar één keer getoond: bewaar het op een veilige plek.
Kan ik testen zonder aan mijn gegevens te komen?
Ja. Een sandboxsleutel werkt met demogegevens, met precies dezelfde validaties en foutcodes als in productie, maar er wordt niets opgeslagen.
Kan ik mijn facturen via Peppol versturen met de API?
Ja, bij de aanmaak of later, en u volgt de verzendstatus tot de ontvanger aanvaardt. Verzenden per e-mail is nog niet beschikbaar via de API.
Hoe beperk ik wat een integratie mag doen?
Elke sleutel heeft zijn eigen rechten (aanmaken, lezen, wijzigen, verwijderen) per resource, een geldigheidsduur, en kan op elk moment ingetrokken worden vanuit de interface.
Welke formule bevat de API?
De Growth-formule. U kunt een sandboxsleutel aanmaken om uw integratie te ontwikkelen en te testen voor u naar productie gaat.
Hoe krijg ik mijn sleutels?
In uw instellingen, tabblad API, knop “Nieuwe sleutel”. Het client secret wordt maar één keer getoond: bewaar het op een veilige plek.
Kan ik testen zonder aan mijn gegevens te komen?
Ja. Een sandboxsleutel werkt met demogegevens, met precies dezelfde validaties en foutcodes als in productie, maar er wordt niets opgeslagen.
Kan ik mijn facturen via Peppol versturen met de API?
Ja, bij de aanmaak of later, en u volgt de verzendstatus tot de ontvanger aanvaardt. Verzenden per e-mail is nog niet beschikbaar via de API.
Hoe beperk ik wat een integratie mag doen?
Elke sleutel heeft zijn eigen rechten (aanmaken, lezen, wijzigen, verwijderen) per resource, een geldigheidsduur, en kan op elk moment ingetrokken worden vanuit de interface.
Welke formule bevat de API?
De Growth-formule. U kunt een sandboxsleutel aanmaken om uw integratie te ontwikkelen en te testen voor u naar productie gaat.
Hoe krijg ik mijn sleutels?
In uw instellingen, tabblad API, knop “Nieuwe sleutel”. Het client secret wordt maar één keer getoond: bewaar het op een veilige plek.
Kan ik testen zonder aan mijn gegevens te komen?
Ja. Een sandboxsleutel werkt met demogegevens, met precies dezelfde validaties en foutcodes als in productie, maar er wordt niets opgeslagen.
Kan ik mijn facturen via Peppol versturen met de API?
Ja, bij de aanmaak of later, en u volgt de verzendstatus tot de ontvanger aanvaardt. Verzenden per e-mail is nog niet beschikbaar via de API.
Hoe beperk ik wat een integratie mag doen?
Elke sleutel heeft zijn eigen rechten (aanmaken, lezen, wijzigen, verwijderen) per resource, een geldigheidsduur, en kan op elk moment ingetrokken worden vanuit de interface.
Hallo, ik ben Chloé,
Een vraag over Fidly, de functies of de opstart? Ik adviseer en begeleid u graag.
Neem contact opEen vraag over Fidly, de functies of de opstart? Ik adviseer en begeleid u graag.