Overzicht van de API
Voorstelling van de REST-API NovaFisko v1, de omgevingen, de formaten en de tools waarmee u uw oplossing koppelt.
De NovaFisko-API is de interface die de applicatie zelf gebruikt op het web, op de computer en op mobiel. Alles wat u ziet in de tabbladen Boekingen, Documenten, Bank, Btw, Exports of Peppol loopt via deze API. Uw integratie heeft dus exact dezelfde mogelijkheden: een dossier aanmaken, een factuur met haar pdf doorsturen, het grootboek lezen, het volledige dossier van een boekjaar downloaden of de wijzigingen continu volgen.
In het kort
| Element | Waarde |
|---|---|
| Basis-URL | https://api.novafisko.com/v1 |
| Stijl | REST, JSON-body in UTF-8 |
| Authenticatie | Bearer-token (Authorization: Bearer ...) |
| Versie | v1, opgenomen in het pad |
| Talen van de berichten | fr, nl, en, de |
| Specificatie | OpenAPI 3.1 |
Met een minimale aanroep, zonder authenticatie, controleert u of de dienst antwoordt:
curl https://api.novafisko.com/v1/status
{
"ok": true,
"time": "2026-10-05T08:12:44+00:00"
}
GET /v1/ping geeft dezelfde informatie terug in de vorm {"ok": true, "server_time": "..."} zonder de database te raadplegen. Gebruik deze route als connectiviteitstest.
Omgevingen
| Omgeving | Basis-URL | Gebruik |
|---|---|---|
| Productie | https://api.novafisko.com/v1 |
Echte gegevens van de kantoren |
| Demo | https://api.novafisko.com/v1 met een demotoken |
Sandbox, fictieve gegevens die elke nacht worden gereset |
Er bestaat geen afzonderlijke testhost. De sandbox is een demokantoor dat op dezelfde API draait: u krijgt een token met één aanroep, zonder een account aan te maken.
curl -X POST https://api.novafisko.com/v1/auth/demo \
-H "Content-Type: application/json" \
-d '{"locale": "fr", "device_name": "integration-sandbox"}'
{
"token": "412|Qm9uam91ciBsZSBtb2RlIGTDqW1v",
"user": {
"id": 9034,
"name": "Visiteur démo",
"email": "demo-7f3a9c@demo.novafisko.com",
"locale": "fr",
"is_platform_admin": false,
"is_demo": true,
"firms": [
{"public_token": "Fd7hQ2mN8sXa", "name": "Fiduciaire Démo", "role": "manager"}
],
"managed_firms": [
{"public_token": "Fd7hQ2mN8sXa", "name": "Fiduciaire Démo"}
]
},
"demo": {
"firm": {"public_token": "Fd7hQ2mN8sXa", "name": "Fiduciaire Démo"},
"companies": [
{"public_token": "k3Jd9fPq2LmX", "code": "COMPTOIR", "name": "Le Comptoir Montois SRL"},
{"public_token": "Pw8sTz4YbN1c", "code": "PIXELWERK", "name": "Pixelwerk SRL"},
{"public_token": "Lb5vRe7HuK2d", "code": "LAMBERT", "name": "Lambert Électricité"},
{"public_token": "Sc2oUv9XaM6e", "code": "SCENES", "name": "Scènes Ouvertes ASBL"}
],
"expires_at": "2026-10-06T08:12:44+00:00",
"resets_at": "2026-10-06T03:15:00+02:00"
}
}
Het demokantoor bevat vier fictieve Belgische dossiers met twee boekjaren, boekingen, bankafschriften, btw-aangiften en te valideren documenten. U kunt er vrij in schrijven.
In demomodus wordt elk extern effect geblokkeerd met een antwoord 403 en de code demo_mode: Peppol-registratie, verzending naar Novadesko, e-mails, integraties, licentiesleutels, webhooks en het verwijderen van een dossier. De gegevens worden elke nacht om 03:15 (Brusselse tijd) gereset en een demotoken blijft hoogstens 24 uur geldig.
Als het demokantoor tijdelijk niet beschikbaar is, antwoordt de aanroep 503 met de code demo_unavailable.
Formaten
- De request-body's zijn in JSON (
Content-Type: application/json), behalve bij het uploaden van bestanden, waarvoormultipart/form-datawordt gebruikt. - De antwoorden zijn altijd in JSON, ook de fouten, behalve de exports (PDF, XLSX, CSV, ZIP, XML), die het bestand teruggeven.
- De datums volgen het formaat ISO 8601, de bedragen zijn decimale strings met een punt. De details staan in Conventies.
- De fouten volgen één enkele vorm
{message, code, errors}, beschreven in Fouten en limieten.
Beschikbare tools
| Tool | Adres |
|---|---|
| OpenAPI 3.1-specificatie (JSON) | https://docs.novafisko.com/openapi/novafisko-v1.json |
| OpenAPI 3.1-specificatie (YAML) | https://docs.novafisko.com/openapi/novafisko-v1.yaml |
| Postman-collectie | https://docs.novafisko.com/openapi/novafisko-v1.postman_collection.json |
| Interactieve referentie | API-referentie |
De specificatie beschrijft elke route met haar parameters, schema's en voorbeelden. U kunt ze importeren in Postman, Insomnia of Bruno, of een client genereren met de tool van uw keuze.
Vul in de Postman-collectie de variabelen base_url en token één keer in. Alle requests hergebruiken ze.
Wat de API dekt
| Domein | Voorbeelden van routes |
|---|---|
| Authenticatie | auth/login, auth/me, auth/tokens, auth/demo |
| Kantoor | firms/{firm}, team, licentie, activiteit, webhooks |
| Dossiers | companies, instellingen, integriteit |
| Stamgegevens | rekeningen, dagboeken, derden, btw-codes, boekjaren en periodes |
| Boekingen | entries, entries/invoice, tegenboeking |
| Documenten | documents, document-imports (PDF, afbeeldingen, XML, ZIP) |
| Bank | verrichtingen, afpunting, regels, CODA-bestanden |
| Btw | aangiften, Intervat-XML, listings |
| Afsluiting en staten | proef- en saldibalans, grootboek, jaarrekening, vaste activa |
| Exports | boeken in PDF, XLSX, CSV en volledig dossier in ZIP |
| Peppol | registratie, transport, directory, status van de derden |
| Geschiedenis | revisies, terugdraaien, prullenbak, activiteit |
| Synchronisatie | sync/bootstrap, sync/pull, sync/push |
Waar te beginnen
- Vraag een token aan: lees Authenticatie.
- Neem de Conventies door om valkuilen rond formaten te vermijden.
- Volg een use case, bijvoorbeeld Een aankoopfactuur doorsturen.
- Sluit de webhooks aan om op de hoogte te worden gebracht van wijzigingen in plaats van de API te bevragen.