Overzicht
De FinteQX Accounting Package API stelt boekhoudpakketten en jaarrekeningsoftware (zoals Monitr, Asperion, Audition etc.) in staat om automatisch financiële rapportages naar eBlinqx Fiscaal te sturen en de status van formulieren zoals kvk-depot op te vragen.
Base URL: https://api.finteqx.nl
API Versie: 1.0.0
Authenticatie: API Key (X-Api-Key header)
Authenticatie
Alle API calls vereisen een API Key die u kunt aanmaken in eBlinqx Fiscaal:
- Log in op eBlinqx Fiscaal
- Ga naar Instellingen → Koppelingen → Financial data API
- Klik op Nieuwe API Key → Accounting Package API
- Kopieer de gegenereerde API key
API Key gebruiken
Voeg de API key toe aan elke request als header:
X-Api-Key: uw-api-key-hier
Accept-Language: nl-NL
Endpoints
1. Bedrijven ophalen
Haal alle bedrijven op die gekoppeld zijn aan uw eBlinqx Fiscaal account.
Endpoint: GET /api/accounting-package/companies
Response: Array van bedrijven
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Voorbeeld BV",
"chamberOfCommerceNumber": "12345678",
"legalFormApplyForAnnualAccount": true,
"monitrClientId": null
}
]
Velden: - id (UUID): Unieke identifier van het bedrijf in eBlinqx Fiscaal- name (string): Naam van het bedrijf - chamberOfCommerceNumber (string, optioneel): KvK-nummer - legalFormApplyForAnnualAccount (boolean): Geeft aan of de rechtsvorm jaarrekeningplichtig is - monitrClientId (UUID, optioneel): Externe identifier uit uw boekhoudpakket
Voorbeeld request:
curl -X GET "https://api.finteqx.nl/api/accounting-package/companies" \
-H "X-Api-Key: uw-api-key" \
-H "Accept-Language: nl-NL"
2. Bedrijven koppelen
Koppel bedrijven uit uw boekhoudpakket aan bedrijven in FinteQX.
Endpoint: POST /api/accounting-package/companies
Request Body: Array van koppelingen
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"monitrClientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
]
Velden: - id (UUID, verplicht): FinteQX bedrijf ID (uit endpoint 1) - monitrClientId (UUID, optioneel): Uw externe bedrijf ID
Response: 204 No Content bij succes
Voorbeeld request:
curl -X POST "https://api.finteqx.nl/api/accounting-package/companies" \
-H "X-Api-Key: uw-api-key" \
-H "Accept-Language: nl-NL" \
-H "Content-Type: application/json" \
-d '[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"monitrClientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
]'
3. Financieel rapport uploaden
Upload een financieel rapport (jaarrekening) vanuit uw software naar eBlinqx Fiscaal.
Endpoint: POST /api/accounting-package/post-financial-report/{formType}
Path Parameters: - formType: Type formulier (zie onderstaande tabel)
Request: Multipart form-data met JSON bestand
Response: Instance ID (integer) van het aangemaakte formulier
Ondersteunde FormTypes: |
KvkKleinPub | KvK Jaarrekening Klein (publicatieplicht) | |
KvkMicroPub | KvK Jaarrekening Micro (publicatieplicht) |
Voorbeeld request:
curl -X POST "https://api.finteqx.nl/api/accounting-package/post-financial-report/Vpb" \
-H "X-Api-Key: uw-api-key" \
-H "Accept-Language: nl-NL" \
-F "monitrJson=@jaarrekening.json"
Response:
12345
Het response bevat het instance ID dat u kunt gebruiken om de status op te vragen (zie endpoint 4).
4. Status van formulier opvragen
Vraag de huidige status op van een eerder geüpload formulier.
Endpoint: GET /api/accounting-package/form/instance/{instanceId}/status
Path Parameters: - instanceId (integer): Instance ID uit endpoint 3
Response: Status enum (string) of null
Mogelijke statussen: - AccountingPackageJsonSaved: JSON bestand is opgeslagen - AccountingPackageJsonProcessed: JSON bestand is verwerkt - UserEditStarted: Gebruiker is begonnen met bewerken - ReportGenerated: Rapport is gegenereerd - DeclarationSendable: Formulier kan verzonden worden - DeclarationSent: Formulier is verzonden - DeclarationApproved: Formulier is goedgekeurd - DeclarationRejected: Formulier is afgewezen - Archived: Formulier is gearchiveerd
Voorbeeld request:
curl -X GET "https://api.finteqx.nl/api/accounting-package/form/instance/12345/status" \
-H "X-Api-Key: uw-api-key" \
-H "Accept-Language: nl-NL"
Response:
"AccountingPackageJsonProcessed"