{ "info": { "_postman_id": "b7c1f0a2-6d1e-4c57-9a35-0f1e2d3c4b5a", "name": "NovaFisko API v1", "description": "Generated from the OpenAPI specification (php artisan novafisko:openapi).\n\nSet the collection variables `token` (bearer token), `company` and `firm` (public tokens).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "1.0.0" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.novafisko.com", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "company", "value": "XBVD5O1L29HC", "type": "string" }, { "key": "firm", "value": "NDTQVQU4AUAV", "type": "string" } ], "item": [ { "name": "Meta", "description": "Service status, connectivity probe and country packs.", "item": [ { "name": "API root", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/", "host": [ "{{base_url}}" ], "path": [] }, "description": "Name and version of the API.\n\nPublic endpoint: no bearer token.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Service status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/status", "host": [ "{{base_url}}" ], "path": [ "v1", "status" ] }, "description": "Public endpoint: no bearer token.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Connectivity probe", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/ping", "host": [ "{{base_url}}" ], "path": [ "v1", "ping" ] }, "description": "Cheap probe without database access. The apps call it to leave offline mode; integrations can use it as a health check and to read the server clock.\n\nPublic endpoint: no bearer token.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Available country packs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/country-packs", "host": [ "{{base_url}}" ], "path": [ "v1", "country-packs" ] }, "description": "Country packs (chart of accounts, VAT codes, journals) a company file can be created with.\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Auth", "description": "Sign-in, account of the user, demo session.", "item": [ { "name": "Sign in", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/login", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "login" ] }, "description": "Exchanges an e-mail and a password for a session token (all abilities). Novadesko fiduciary users sign in with their Novadesko credentials: firm, team and company files are mirrored at each sign-in. Ten failed attempts per IP lock the sign-in for five minutes.\n\nPublic endpoint: no bearer token.\n\nRate limit: 20 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"email\": \"claire.dumont@fiduciaire-dumont.be\",\n \"password\": \"correct horse battery staple\",\n \"device_name\": \"ERP connector\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Sign in to the demo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/demo", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "demo" ] }, "description": "Creates an ephemeral user attached to the demo firm (« Fiduciaire Démo », four realistic Belgian company files) and returns its token. Local bookkeeping is allowed (entries, lettering, VAT declarations, exports, history, recycle bin, synchronisation); every external effect answers 403 `demo_mode`: Peppol, Novadesko, e-mails and reminders, integrations, licence keys, team and firm management, company creation and deletion, webhooks and integration tokens, company lookups and VIES, uploads and analysis of the document importer, SEPA files (operations flagged `x-demo-blocked`). A demo user never reaches anything outside the demo firm (404). The demo data is reset every night and demo users are purged after 24 hours.\n\nPublic endpoint: no bearer token.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `demo_unavailable`: the demo data set is not available right now", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"locale\": \"fr\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/me", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "me" ] }, "description": "User behind the token, with the firms it belongs to and `is_demo`.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Sign out", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/logout", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "logout" ] }, "description": "Revokes the token used for the request.\n\nIntegration tokens need the `write` ability." }, "response": [] }, { "name": "Ask for a password reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "forgot-password" ] }, "description": "Always answers the same generic message, whether the account exists or not.\n\nPublic endpoint: no bearer token.\n\nRate limit: 5 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"email\": \"claire.dumont@fiduciaire-dumont.be\",\n \"locale\": \"fr\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reset the password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "reset-password" ] }, "description": "With the token of the reset mail. Every device is signed out.\n\nPublic endpoint: no bearer token.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"token\": \"XBVD5O1L29HC\",\n \"email\": \"claire.dumont@fiduciaire-dumont.be\",\n \"password\": \"string\",\n \"password_confirmation\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Confirm an e-mail address", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/email/verify/:id/:hash", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "email", "verify", ":id", ":hash" ], "query": [ { "key": "format", "value": "json", "description": "Answer JSON instead of redirecting.", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." }, { "key": "hash", "value": "5f2b8c…", "description": "SHA-1 of the e-mail address being confirmed." } ] }, "description": "Signed link of the verification mail. Opened in a browser it redirects to the app; with `format=json` it answers JSON.\n\nAuthorised by the signature of the URL (query parameters `signature` and `expires`), not by a bearer token. The URL is issued by another endpoint and expires.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Change the password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/change-password", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "change-password" ] }, "description": "Refused for accounts whose password is managed by Novadesko.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"current_password\": \"string\",\n \"password\": \"string\",\n \"password_confirmation\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Change the e-mail address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/change-email", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "change-email" ] }, "description": "The current password is asked again; the new address replaces the old one once confirmed.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 6 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"email\": \"claire.dumont@fiduciaire-dumont.be\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Send the confirmation mail again", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/email/resend", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "email", "resend" ] }, "description": "Session token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 6 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Mail notification preferences", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/notification-preferences", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "notification-preferences" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Update the notification preferences", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/notification-preferences", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "notification-preferences" ] }, "description": "Locked categories and unknown keys are ignored.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.", "body": { "mode": "raw", "raw": "{\n \"prefs\": {\n \"documents\": true,\n \"billing\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Integration tokens", "description": "Long-lived tokens for server-to-server integrations, limited to the abilities `read`, `write` and `sync`.", "item": [ { "name": "List the integration tokens", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/tokens", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "tokens" ] }, "description": "Integration tokens of the current user. The secret is never returned again.\n\nSession token only: integration tokens are refused with 403 `session_token_required`." }, "response": [] }, { "name": "Create an integration token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/tokens", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "tokens" ] }, "description": "Long-lived token for a server-to-server integration, limited to the chosen abilities:\n\n- `read`: every GET;\n- `write`: POST, PUT, PATCH and DELETE;\n- `sync`: the offline synchronisation endpoints (`sync/bootstrap`, `sync/pull`, `sync/push`, `sync/status`, `sync/conflicts`).\n\nThe token acts with the rights of the user who created it (same firms, same company files). The plain token is shown once: store it in a secret manager.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 20 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `token_limit_reached`: 50 integration tokens per user at most", "body": { "mode": "raw", "raw": "{\n \"name\": \"ERP connector\",\n \"abilities\": [\n \"read\",\n \"sync\"\n ],\n \"expires_in_days\": 365\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Revoke an integration token", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/auth/tokens/:token", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "tokens", ":token" ], "variable": [ { "key": "token", "value": "57", "description": "Id of the integration token." } ] }, "description": "Only the integration tokens of the current user; anything else answers 404.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] } ] }, { "name": "Firms", "description": "Accounting firm: identity, team, assignment of the company files, activity.", "item": [ { "name": "Firm, team and company files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}" ] }, "description": "Any active member of the firm can read it.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Update the identity of the firm", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}" ] }, "description": "Admins and managers of the firm.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"+32 65 31 42 18\",\n \"website\": \"https://www.fiduciaire-dumont.be\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Resynchronise the firm from Novadesko", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/sync", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "sync" ] }, "description": "Identity, members and company files of a firm linked to Novadesko. 422 when the firm is not linked, 503 when Novadesko does not answer.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 6 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Add a member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/members", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "members" ] }, "description": "Attaches an existing user (by e-mail) or creates the account (`password` required then). 201 when the account was created, 200 when an existing user was attached.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `user_limit_reached`: the licence does not allow one more user", "body": { "mode": "raw", "raw": "{\n \"email\": \"thomas.peeters@fiduciaire-dumont.be\",\n \"name\": \"Thomas Peeters\",\n \"password\": \"S3cure-Pass!\",\n \"role\": \"encoder\",\n \"company_tokens\": [\n \"XBVD5O1L29HC\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a member", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/members/:user", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "members", ":user" ], "variable": [ { "key": "user", "value": "12", "description": "Id of the user (member of the firm)." } ] }, "description": "Role, activation, name, password. The last active admin cannot lose its role.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.", "body": { "mode": "raw", "raw": "{\n \"role\": \"manager\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove a member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/members/:user", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "members", ":user" ], "variable": [ { "key": "user", "value": "12", "description": "Id of the user (member of the firm)." } ] }, "description": "Detaches the user from the firm and from its company files. The user account itself is kept.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] }, { "name": "Replace the company files of a member", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/members/:user/companies", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "members", ":user", "companies" ], "variable": [ { "key": "user", "value": "12", "description": "Id of the user (member of the firm)." } ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.", "body": { "mode": "raw", "raw": "{\n \"company_tokens\": [\n \"XBVD5O1L29HC\",\n \"K7MPL2QX9ZTA\"\n ],\n \"role\": \"encoder\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace the members of a company file", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/companies/{{company}}/members", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "companies", "{{company}}", "members" ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.", "body": { "mode": "raw", "raw": "{\n \"members\": [\n {\n \"user_id\": 12,\n \"role\": \"manager\"\n },\n {\n \"user_id\": 15,\n \"role\": \"encoder\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Activity of the firm", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/activity", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "activity" ], "query": [ { "key": "company", "value": "XBVD5O1L29HC", "description": "Restrict to one company file.", "disabled": true }, { "key": "user_id", "value": "12", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "type", "value": "string", "description": "Action or subject type.", "disabled": true }, { "key": "source", "value": "audit", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Audit trail and history merged, newest first, for every company file of the firm. Admins and managers only (404 otherwise).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Signed relay of a firm file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/files/view", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "files", "view" ], "query": [ { "key": "url", "value": "https://api.novafisko.com/v1/companies/XBVD5O1L29HC", "description": "Relayed file.", "disabled": false } ] }, "description": "Serves the logo of a firm stored on Novadesko with CORS headers. The signed URL is found in `logo_url` of the firm payload.\n\nAuthorised by the signature of the URL (query parameters `signature` and `expires`), not by a bearer token. The URL is issued by another endpoint and expires.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Licence & pricing", "description": "Licence of a firm, activation keys, public price list and simulator.", "item": [ { "name": "Licence of the firm", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/licence", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "licence" ], "query": [ { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "Plan, status, usage of the month, estimate of the next invoice, entitlements and limits.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Activate a licence key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/licence/activate", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "licence", "activate" ] }, "description": "Creates or replaces the subscription of the firm.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `invalid_key`: unknown key\n- `expired_key`: key past its validity\n- `exhausted_key`: every activation of the key is used\n- `key_reserved`: key reserved for another firm\n- `already_active`: the key is already active on this firm", "body": { "mode": "raw", "raw": "{\n \"key\": \"NVFK-7Q2M-X4TA-9LDP\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Release the licence key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/licence/activation", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "licence", "activation" ] }, "description": "The subscription that depends on the key is cancelled.\n\nSession token only: integration tokens are refused with 403 `session_token_required`.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] }, { "name": "Public price list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/pricing", "host": [ "{{base_url}}" ], "path": [ "v1", "pricing" ], "query": [ { "key": "locale", "value": "fr", "description": "", "disabled": true } ] }, "description": "Plans, tiers and options, excl. VAT, per month. Cached five minutes.\n\nPublic endpoint: no bearer token.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Price simulator", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/pricing/simulate", "host": [ "{{base_url}}" ], "path": [ "v1", "pricing", "simulate" ], "query": [ { "key": "companies", "value": "25", "description": "Number of company files.", "disabled": false }, { "key": "client_portal", "value": "1", "description": "Clients with the portal option.", "disabled": true }, { "key": "client_invoicing", "value": "1", "description": "Clients with the invoicing option.", "disabled": true }, { "key": "yearly", "value": "0", "description": "Yearly billing.", "disabled": true }, { "key": "locale", "value": "fr", "description": "", "disabled": true } ] }, "description": "Public endpoint: no bearer token.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Companies", "description": "Company files (dossiers): creation with accounting set-up, identity, settings, integrity.", "item": [ { "name": "List the company files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies", "host": [ "{{base_url}}" ], "path": [ "v1", "companies" ] }, "description": "Every company file the user can open: all files of the firms it administers or manages, plus the files it is assigned to.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Create a company file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies", "host": [ "{{base_url}}" ], "path": [ "v1", "companies" ] }, "description": "Creates the file and initialises its accounting: chart of accounts of the country pack (PCMN for BE), VAT codes, journals (ACH, NCA, VEN, NCV, OD, CAI and one financial journal per bank) and the first fiscal year with its periods. `firm` is optional when the user manages exactly one firm; without a firm the file is standalone.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `company_limit_reached`: the licence or the plan does not allow one more company file", "body": { "mode": "raw", "raw": "{\n \"firm\": \"NDTQVQU4AUAV\",\n \"country_pack\": \"BE\",\n \"code\": \"COMPTOIR\",\n \"name\": \"Le Comptoir Montois SRL\",\n \"enterprise_number\": \"0477.472.701\",\n \"legal_form_code\": \"610\",\n \"vat_regime\": \"quarterly\",\n \"street\": \"Grand-Place\",\n \"house_number\": \"14\",\n \"postal_code\": \"7000\",\n \"city\": \"Mons\",\n \"fiscal_year\": {\n \"code\": \"2026\",\n \"starts_on\": \"2026-01-01\",\n \"ends_on\": \"2026-12-31\"\n },\n \"banks\": [\n {\n \"code\": \"BNP\",\n \"label\": \"BNP Paribas Fortis\",\n \"iban\": \"BE68 5390 0754 7034\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Company file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}" ] }, "description": "With its fiscal years, periods and journals.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Update a company file", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}" ] }, "description": "Identity and / or `settings`. Settings are merged key by key: send only the keys to change; only known keys are accepted.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"vat_regime\": \"monthly\",\n \"settings\": {\n \"vat\": {\n \"office_number\": \"0420\"\n },\n \"auto_entries\": {\n \"reconciliation_difference\": {\n \"max_amount\": 2.5\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a company file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}" ] }, "description": "Soft delete: the file disappears from every list.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] }, { "name": "Integrity check", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrity", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrity" ] }, "description": "Sum of debits and credits over every entry of the file.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Resolved settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/settings", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "settings" ] }, "description": "Settings of the file with the journals available for the selectors.\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Lookup", "description": "Company detection (CompanySearch for BE and FR, VIES elsewhere), legal forms, NACE codes, address autocompletion.", "item": [ { "name": "Company sheet of the file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sheet", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sheet" ] }, "description": "Sheet stored on the file (last detection), structured address, legal form, NACE codes and map links.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Fill the file from a company sheet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/apply-sheet", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "apply-sheet" ] }, "description": "Looks the company up and copies name, legal form, address, NACE codes and VAT number to the file (empty fields only unless `overwrite`).\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"0477472701\",\n \"refresh\": true,\n \"overwrite\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Company sheet of a third party", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/sheet", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "sheet" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Fill a third party from a company sheet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/apply-sheet", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "apply-sheet" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"0477472701\",\n \"refresh\": true,\n \"overwrite\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Legal forms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/reference/legal-forms", "host": [ "{{base_url}}" ], "path": [ "v1", "reference", "legal-forms" ], "query": [ { "key": "country", "value": "BE", "description": "ISO country, BE by default.", "disabled": true }, { "key": "q", "value": "srl", "description": "Code, abbreviation or label.", "disabled": true }, { "key": "common", "value": "1", "description": "Only the common forms.", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "Official nomenclature of legal forms (KBO / BCE for Belgium).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "NACE codes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/reference/nace", "host": [ "{{base_url}}" ], "path": [ "v1", "reference", "nace" ], "query": [ { "key": "country", "value": "BE", "description": "", "disabled": true }, { "key": "q", "value": "restauration", "description": "", "disabled": true }, { "key": "limit", "value": "1", "description": "1 to 200, 30 by default.", "disabled": true }, { "key": "level", "value": "1", "description": "1 to 7.", "disabled": true }, { "key": "edition", "value": "2025", "description": "", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "Search in the NACE-BEL nomenclature by code or words.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Lookup capabilities of a country", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/lookup/capabilities", "host": [ "{{base_url}}" ], "path": [ "v1", "lookup", "capabilities" ], "query": [ { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "What the detection can do for a country: BE and FR through CompanySearch (search, sheet, cities, streets), other EU countries through VIES (VAT check only).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Search a company by name or number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/lookup/search", "host": [ "{{base_url}}" ], "path": [ "v1", "lookup", "search" ], "query": [ { "key": "q", "value": "comptoir montois", "description": "2 characters at least.", "disabled": false }, { "key": "country", "value": "BE", "description": "", "disabled": true }, { "key": "limit", "value": "1", "description": "1 to 25.", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "Integration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Company sheet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/lookup/companies/:identifier", "host": [ "{{base_url}}" ], "path": [ "v1", "lookup", "companies", ":identifier" ], "query": [ { "key": "country", "value": "BE", "description": "", "disabled": true }, { "key": "refresh", "value": "1", "description": "Ignore the cache.", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true } ], "variable": [ { "key": "identifier", "value": "0477472701", "description": "Enterprise number or VAT number of the company to look up." } ] }, "description": "Normalised sheet of a company, cached 24 hours.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Check a VAT number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/lookup/vat", "host": [ "{{base_url}}" ], "path": [ "v1", "lookup", "vat" ], "query": [ { "key": "vat", "value": "BE0477472701", "description": "", "disabled": false }, { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "Format, check digits and existence, with the Peppol status when known.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "City autocompletion", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/lookup/cities", "host": [ "{{base_url}}" ], "path": [ "v1", "lookup", "cities" ], "query": [ { "key": "q", "value": "Mons", "description": "", "disabled": false }, { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "Integration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Street autocompletion", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/lookup/streets", "host": [ "{{base_url}}" ], "path": [ "v1", "lookup", "streets" ], "query": [ { "key": "zipcode", "value": "7000", "description": "Four digits.", "disabled": false }, { "key": "q", "value": "Grand", "description": "", "disabled": true }, { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "Integration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Lookup capabilities of a country", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/lookup/capabilities", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "lookup", "capabilities" ], "query": [ { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "What the detection can do for a country: BE and FR through CompanySearch (search, sheet, cities, streets), other EU countries through VIES (VAT check only). The call is attributed to the company file.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Search a company by name or number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/lookup/search", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "lookup", "search" ], "query": [ { "key": "q", "value": "comptoir montois", "description": "2 characters at least.", "disabled": false }, { "key": "country", "value": "BE", "description": "", "disabled": true }, { "key": "limit", "value": "1", "description": "1 to 25.", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "The call is attributed to the company file.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Company sheet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/lookup/companies/:identifier", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "lookup", "companies", ":identifier" ], "query": [ { "key": "country", "value": "BE", "description": "", "disabled": true }, { "key": "refresh", "value": "1", "description": "Ignore the cache.", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true } ], "variable": [ { "key": "identifier", "value": "0477472701", "description": "Enterprise number or VAT number of the company to look up." } ] }, "description": "Normalised sheet of a company, cached 24 hours. The call is attributed to the company file.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Check a VAT number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/lookup/vat", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "lookup", "vat" ], "query": [ { "key": "vat", "value": "BE0477472701", "description": "", "disabled": false }, { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "Format, check digits and existence, with the Peppol status when known. The call is attributed to the company file.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "City autocompletion", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/lookup/cities", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "lookup", "cities" ], "query": [ { "key": "q", "value": "Mons", "description": "", "disabled": false }, { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "The call is attributed to the company file.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Street autocompletion", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/lookup/streets", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "lookup", "streets" ], "query": [ { "key": "zipcode", "value": "7000", "description": "Four digits.", "disabled": false }, { "key": "q", "value": "Grand", "description": "", "disabled": true }, { "key": "country", "value": "BE", "description": "", "disabled": true } ] }, "description": "The call is attributed to the company file.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] } ] }, { "name": "Chart of accounts", "description": "Accounts of a company file.", "item": [ { "name": "Chart of accounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/accounts", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "accounts" ], "query": [ { "key": "q", "value": "6120", "description": "Number prefix or part of the label.", "disabled": true }, { "key": "postable", "value": "1", "description": "Only the accounts entries can be posted to.", "disabled": true } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Create an account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/accounts", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "accounts" ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"number\": \"612100\",\n \"label\": \"Électricité\",\n \"type\": \"expense\",\n \"is_postable\": true,\n \"purchase_grid\": 82\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update an account", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/accounts/:account", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "accounts", ":account" ], "variable": [ { "key": "account", "value": "223", "description": "Id of the account (not its number)." } ] }, "description": "The number and the type of an account never change.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"label\": \"Électricité et gaz\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Journals", "description": "Journals, routing rules of the imported documents, numbering series.", "item": [ { "name": "Journals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journals", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journals" ] }, "description": "With their control account, routing rules and number of entries.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Create a journal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journals", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journals" ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"code\": \"ING\",\n \"label\": \"ING Business\",\n \"type\": \"financial\",\n \"iban\": \"BE12310123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a journal", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journals/:journal", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journals", ":journal" ], "variable": [ { "key": "journal", "value": "3", "description": "Id of the journal." } ] }, "description": "`is_default` makes it the default journal of its type.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"is_default\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a journal", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journals/:journal", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journals", ":journal" ], "variable": [ { "key": "journal", "value": "3", "description": "Id of the journal." } ] }, "description": "Only a journal that never held an entry (continuous numbering); otherwise deactivate it. Goes to the recycle bin.\n\nIntegration tokens need the `write` ability." }, "response": [] }, { "name": "Journal routing rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journal-rules", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journal-rules" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Create a journal rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journal-rules", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journal-rules" ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"journal_id\": 3,\n \"direction\": \"sale\",\n \"match_field\": \"number_prefix\",\n \"match_value\": \"TK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a journal rule", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journal-rules/:journalRule", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journal-rules", ":journalRule" ], "variable": [ { "key": "journalRule", "value": "4", "description": "Id of the journal rule." } ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"priority\": 10\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a journal rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journal-rules/:journalRule", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journal-rules", ":journalRule" ], "variable": [ { "key": "journalRule", "value": "4", "description": "Id of the journal rule." } ] }, "description": "Integration tokens need the `write` ability." }, "response": [] }, { "name": "Numbering series of the documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/series", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", "series" ] }, "description": "Series observed in the imported documents (prefix and payment provider) and the journal resolved for each.\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Fiscal years", "description": "Fiscal years, periods, locking, closing and year-end.", "item": [ { "name": "Fiscal years and periods", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Open a fiscal year", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years" ] }, "description": "Creates the year and its periods (opening, one per month, closing).\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"code\": \"2027\",\n \"starts_on\": \"2027-01-01\",\n \"ends_on\": \"2027-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Lock or unlock a period", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/periods/:period", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "periods", ":period" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." }, { "key": "period", "value": "16", "description": "Id of the period." } ] }, "description": "No entry can be posted in a locked period. Refused with `period_locked` (reason `fiscal_year_closed`) when the fiscal year is closed.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)", "body": { "mode": "raw", "raw": "{\n \"is_locked\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Close or reopen a fiscal year", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/close", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "close" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Locks every period. Send `reopen: true` to reopen. For the closing entries and the carry-forward use `year-end`.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"reopen\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Year-end closing", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/year-end", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "year-end" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Posts the closing entry (result), opens the next fiscal year when needed, posts the opening entry (carry-forward of the balance sheet accounts) and closes the year. Emits the webhook `fiscal_year.closed`.\n\nIntegration tokens need the `write` ability.\n\nRate limit: 5 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] } ] }, { "name": "Third parties", "description": "Customers and suppliers: sheet, open items, lettering, reminders, totals, VIES.", "item": [ { "name": "List the third parties", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties" ], "query": [ { "key": "type", "value": "customer", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Name, code or VAT number.", "disabled": true } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Create a third party", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties" ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"type\": \"supplier\",\n \"name\": \"Brasserie Dubuisson SA\",\n \"vat_number\": \"BE 0402.531.376\",\n \"address\": \"Chaussée de Mons 28\",\n \"postal_code\": \"7904\",\n \"city\": \"Pipaix\",\n \"iban\": \"BE71 0961 2345 6769\",\n \"payment_terms_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Third party sheet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "With its default account and VAT code.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Update a third party", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"payment_terms_days\": 45,\n \"email\": \"compta@dubuisson.example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a third party", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Refused (422) when an entry or a document references it. Goes to the recycle bin.\n\nIntegration tokens need the `write` ability." }, "response": [] }, { "name": "Open items and entries of a third party", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/entries", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "entries" ], "query": [ { "key": "lettered", "value": "all", "description": "", "disabled": true }, { "key": "fiscal_year_id", "value": "2", "description": "", "disabled": true } ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Letter lines together", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/letter", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "letter" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Matches lines of the third party whose debits and credits balance (a small difference is posted to the difference accounts of the settings).\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"line_ids\": [\n 3391,\n 3518\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove a lettering", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/unletter", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "unletter" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "By lettering code or by lines.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"code\": \"AB\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Automatic lettering", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/letter-auto", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "letter-auto" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Letters every group of open lines that balances exactly.\n\nIntegration tokens need the `write` ability." }, "response": [] }, { "name": "Record a payment reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/entries/:line/remind", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "entries", ":line", "remind" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." }, { "key": "line", "value": "3391", "description": "Id of the line." } ] }, "description": "Raises the reminder level of an open line and stamps the date. No e-mail is sent by this endpoint.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] }, { "name": "Reminders of a third party", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/reminders", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "reminders" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Totals per period", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/totals", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "totals" ], "query": [ { "key": "mode", "value": "balance", "description": "", "disabled": true }, { "key": "fiscal_year_id", "value": "2", "description": "", "disabled": true } ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Check a VAT number with VIES", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vies", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vies" ], "query": [ { "key": "vat_number", "value": "BE0402531376", "description": "", "disabled": false } ] }, "description": "Integration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Check the VAT number of a third party with VIES", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/vies", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "vies" ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Stores the result on the third party (`vies_valid`, `vies_checked_at`, `vies_name`).\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] } ] }, { "name": "Entries", "description": "Journal entries: free entries, invoices and credit notes, reversal.", "item": [ { "name": "List the entries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries" ], "query": [ { "key": "journal_id", "value": "3", "description": "", "disabled": true }, { "key": "fiscal_year_id", "value": "2", "description": "", "disabled": true }, { "key": "third_party_id", "value": "18", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "Entry date, inclusive.", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "Entry date, inclusive.", "disabled": true }, { "key": "status", "value": "posted", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Label, reference, structured communication, third party name, line label or account number prefix.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Newest first, with their journal, third party and lines.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Post a free entry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries" ] }, "description": "Miscellaneous operation, financial entry…: every line is given, debits must equal credits. The entry is posted at once and numbered in its journal. Accounts are addressed by `account_id` or by number (`account`). A date in a locked period or a closed fiscal year is refused with 422 `period_locked`.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)", "body": { "mode": "raw", "raw": "{\n \"journal_id\": 5,\n \"entry_date\": \"2026-03-31\",\n \"label\": \"Salaires mars 2026\",\n \"reference\": \"SAL-2026-03\",\n \"lines\": [\n {\n \"account\": \"620200\",\n \"debit\": \"8420.00\",\n \"label\": \"Rémunérations brutes\"\n },\n {\n \"account\": \"453000\",\n \"credit\": \"2105.00\",\n \"label\": \"Précompte professionnel\"\n },\n {\n \"account\": \"454000\",\n \"credit\": \"1100.48\",\n \"label\": \"ONSS\"\n },\n {\n \"account\": \"455000\",\n \"credit\": \"5214.52\",\n \"label\": \"Net à payer\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Post an invoice or a credit note", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries/invoice", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries", "invoice" ] }, "description": "Purchase or sale invoice (journal of type purchase / sale) or credit note (journal of type purchase_credit_note / sale_credit_note). Send the net lines with their VAT code: the VAT lines and the third party line are generated, including reverse charge (intra-EU, co-contractor). The label defaults to « Facture ». A date in a locked period or a closed fiscal year is refused with 422 `period_locked`.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)", "body": { "mode": "raw", "raw": "{\n \"journal_id\": 1,\n \"third_party_id\": 18,\n \"entry_date\": \"2026-03-15\",\n \"due_date\": \"2026-04-14\",\n \"reference\": \"F-2026-0412\",\n \"lines\": [\n {\n \"account\": \"604000\",\n \"amount\": \"507.00\",\n \"vat_code\": \"A21\",\n \"label\": \"Fûts Bush Caractère 20 L\"\n },\n {\n \"account\": \"613200\",\n \"amount\": \"35.00\",\n \"vat_code\": \"A21\",\n \"label\": \"Consigne et transport\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Entry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries/:journalEntry", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries", ":journalEntry" ], "variable": [ { "key": "journalEntry", "value": "1284", "description": "Id of the journal entry." } ] }, "description": "With journal, third party, fiscal year, period and lines (account and VAT code).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Delete an entry", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries/:journalEntry", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries", ":journalEntry" ], "variable": [ { "key": "journalEntry", "value": "1284", "description": "Id of the journal entry." } ] }, "description": "Always refused (422) for a posted entry: numbering is continuous and the audit trail is kept. Use `reverse`. In a locked period the refusal carries `period_locked`.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Reverse an entry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries/:journalEntry/reverse", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries", ":journalEntry", "reverse" ], "variable": [ { "key": "journalEntry", "value": "1284", "description": "Id of the journal entry." } ] }, "description": "Posts the mirror entry (« Extourne de VEN 2026/000412 ») linked to the original, which becomes `reversed`. The linked document or bank transaction goes back to `pending`, letterings of the lines are removed and a depreciation line goes back to `planned`.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)", "body": { "mode": "raw", "raw": "{\n \"entry_date\": \"2026-03-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Recurring entries", "description": "Recurring entry templates and the quality checks of the file.", "item": [ { "name": "List the recurring entries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Create a recurring entry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries" ] }, "description": "Template posted automatically every night once `next_date` is reached (or on demand with `generate`).\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"journal_id\": 5,\n \"label\": \"Loyer mensuel\",\n \"frequency\": \"monthly\",\n \"next_date\": \"2026-04-01\",\n \"lines\": [\n {\n \"account_id\": 368,\n \"debit\": \"1500.00\"\n },\n {\n \"account_id\": 263,\n \"credit\": \"1500.00\",\n \"third_party_id\": 22\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Generate every due entry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries/generate", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries", "generate" ] }, "description": "Integration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Update a recurring entry", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries/:recurringEntry", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries", ":recurringEntry" ], "variable": [ { "key": "recurringEntry", "value": "5", "description": "Id of the recurring entry template." } ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a recurring entry", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries/:recurringEntry", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries", ":recurringEntry" ], "variable": [ { "key": "recurringEntry", "value": "5", "description": "Id of the recurring entry template." } ] }, "description": "Integration tokens need the `write` ability." }, "response": [] }, { "name": "Generate the due entries of one template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries/:recurringEntry/generate", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries", ":recurringEntry", "generate" ], "variable": [ { "key": "recurringEntry", "value": "5", "description": "Id of the recurring entry template." } ] }, "description": "Integration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Quality checks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/quality", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "quality" ] }, "description": "Continuous control of the file: documents and bank transactions pending, unbalanced entries, missing numbers, third parties without VAT number, VAT declarations late…\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Documents", "description": "Invoices and receipts of the file: allocation, booking.", "item": [ { "name": "List the documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents" ], "query": [ { "key": "type", "value": "string", "description": "", "disabled": true }, { "key": "direction", "value": "sale", "description": "", "disabled": true }, { "key": "status", "value": "pending", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Number, third party or subject.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Invoices, credit notes and receipts of the file (synchronised from Novadesko or created by the importer).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Book every pending document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/book-all", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", "book-all" ], "query": [ { "key": "type", "value": "string", "description": "", "disabled": true }, { "key": "direction", "value": "sale", "description": "", "disabled": true } ] }, "description": "Books what can be booked; the others stay pending with the reason (a locked period is reported per document in `skipped_documents`).\n\nIntegration tokens need the `write` ability.\n\nRate limit: 5 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/:importedDocument", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", ":importedDocument" ], "variable": [ { "key": "importedDocument", "value": "87", "description": "Id of the document." } ] }, "description": "With its lines (recorded and actual accounts) and the entry it was booked to.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Correct the allocation of a line", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/:importedDocument/lines/:line", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", ":importedDocument", "lines", ":line" ], "variable": [ { "key": "importedDocument", "value": "87", "description": "Id of the document." }, { "key": "line", "value": "3391", "description": "Id of the line." } ] }, "description": "Sets the account chosen by the accountant (« actual » layer); `account_id: null` goes back to the recorded account.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"account_id\": 361\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Book a document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/:importedDocument/book", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", ":importedDocument", "book" ], "variable": [ { "key": "importedDocument", "value": "87", "description": "Id of the document." } ] }, "description": "Posts the entry of the document in the journal resolved by the journal rules.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Ignore or restore a document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/:importedDocument/ignore", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", ":importedDocument", "ignore" ], "variable": [ { "key": "importedDocument", "value": "87", "description": "Id of the document." } ] }, "description": "An ignored document is left out of the booking; `restore: true` puts it back to pending. Refused for a booked document.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"restore\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Document importer", "description": "Upload of PDF, images, UBL / CII XML and ZIP files, analysis, validation.", "item": [ { "name": "List the imports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports" ], "query": [ { "key": "batch_id", "value": "bf413a19-2136-4504-bc42-b314637eb5c7", "description": "", "disabled": true }, { "key": "status", "value": "ready,needs_review", "description": "Comma-separated statuses.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Polling list of the uploaded files, without `raw_text`.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Upload files", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports" ] }, "description": "Multipart upload of 1 to 20 files, 25 MB each: PDF, images (JPEG, PNG, HEIC, WebP), UBL / CII XML, or a ZIP of those (50 files max, expanded into child imports). Files are stored and queued; call `process` for a synchronous analysis or let the scheduler analyse them within a minute.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "type": "file", "src": [] }, { "key": "batch_id", "value": "", "type": "text", "disabled": true } ] } }, "response": [] }, { "name": "Analysis engines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/engines", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", "engines" ] }, "description": "Engines able to read a document and whether each is configured.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Import", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport" ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "With the extracted data and the text layer.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Correct the extracted data", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport" ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "Saves corrections without validating. Only for the statuses `ready`, `needs_review` and `duplicate`.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"extracted\": {\n \"direction\": \"purchase\",\n \"is_credit_note\": false,\n \"number\": \"F-2026-0412\",\n \"document_date\": \"2026-03-15\",\n \"due_date\": \"2026-03-15\",\n \"currency\": \"EUR\",\n \"supplier\": {\n \"name\": \"Brasserie Dubuisson SA\",\n \"vat_number\": \"BE0402531376\",\n \"enterprise_number\": \"0477472701\",\n \"address\": \"Grand-Place 14\",\n \"postal_code\": \"7000\",\n \"city\": \"Mons\",\n \"country\": \"BE\",\n \"iban\": \"BE68539007547034\",\n \"email\": \"claire.dumont@fiduciaire-dumont.be\"\n },\n \"customer\": {},\n \"amount_net\": \"507.00\",\n \"amount_vat\": \"106.47\",\n \"amount_gross\": \"613.47\",\n \"structured_communication\": \"000000000101\",\n \"confidence\": 0.93,\n \"lines\": [\n {\n \"description\": \"Fûts Bush Caractère 20 L\",\n \"quantity\": 6,\n \"unit_price\": 84.5,\n \"tax_rate\": 21,\n \"amount_net\": \"507.00\",\n \"amount_vat\": \"106.47\",\n \"account_id\": 580,\n \"account_number\": \"604000\",\n \"vat_code_id\": 4,\n \"vat_code\": \"A21\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete an import", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport" ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "Goes to the recycle bin. A validated import keeps its document.\n\nIntegration tokens need the `write` ability." }, "response": [] }, { "name": "Analyse an import now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport/process", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport", "process" ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "Synchronous analysis (up to two minutes): text layer, extraction, account suggestions, third party matching, duplicate detection. Already analysed: returns the result.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Analyse again", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport/retry", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport", "retry" ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "`force` re-analyses a file flagged as the duplicate of another import.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"force\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Validate an import", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport/validate", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport", "validate" ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "Creates the document (locked for the shop), books it unless `book: false`, and pushes it to Novadesko when the file is linked (never from the demo). The third party is `third_party_id`, or created from `new_third_party`.\n\nIntegration tokens need the `write` ability.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)", "body": { "mode": "raw", "raw": "{\n \"third_party_id\": 18,\n \"direction\": \"purchase\",\n \"lines\": [\n {\n \"account_id\": 361,\n \"vat_code_id\": 25\n }\n ],\n \"book\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Signed preview of an uploaded file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/document-imports/:documentImport/file", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "document-imports", ":documentImport", "file" ], "query": [ { "key": "preview", "value": "0", "description": "`0` serves the original file.", "disabled": true } ], "variable": [ { "key": "documentImport", "value": "311", "description": "Id of the import (uploaded file)." } ] }, "description": "Serves the file inline (or its preview: PDF embedded in a UBL, JPEG converted from HEIC).\n\nAuthorised by the signature of the URL (query parameters `signature` and `expires`), not by a bearer token. The URL is issued by another endpoint and expires.\n\nRate limit: 240 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Bank", "description": "Bank transactions (CODA), matching, rules, treasury, SEPA payment files.", "item": [ { "name": "List the bank transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-transactions", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-transactions" ], "query": [ { "key": "unmatched", "value": "1", "description": "Pending and without proposal.", "disabled": true }, { "key": "journal_id", "value": "3", "description": "", "disabled": true }, { "key": "status", "value": "pending", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "Value date.", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Counterpart, communication or description.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "100", "description": "Items per page (default 100, maximum 500).", "disabled": true } ] }, "description": "Transactions of the CODA statements with the proposed match.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Propose the matches", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-transactions/match", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-transactions", "match" ] }, "description": "Looks for the invoice paid by each pending transaction (structured communication, Novadesko link, amount and third party) and applies the bank rules.\n\nIntegration tokens need the `write` ability.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Book the matched transactions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-transactions/book-matched", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-transactions", "book-matched" ] }, "description": "Books every transaction with a high-confidence match (and medium ones with `include_medium`).\n\nIntegration tokens need the `write` ability.\n\nRate limit: 5 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"include_medium\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Book a transaction", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-transactions/:bankTransaction/book", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-transactions", ":bankTransaction", "book" ], "variable": [ { "key": "bankTransaction", "value": "951", "description": "Id of the bank transaction." } ] }, "description": "Payment of the matched invoice (lettered with it), or allocation to the chosen account (fees, VAT, salaries…).\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)", "body": { "mode": "raw", "raw": "{\n \"account_id\": 517,\n \"label\": \"Frais de tenue de compte\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Ignore or restore a transaction", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-transactions/:bankTransaction/ignore", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-transactions", ":bankTransaction", "ignore" ], "variable": [ { "key": "bankTransaction", "value": "951", "description": "Id of the bank transaction." } ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"restore\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Treasury", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/treasury", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "treasury" ] }, "description": "Accounting balance of each financial journal against the last statement, with the pending transactions.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "List the bank rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-rules", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-rules" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Create a bank rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-rules", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-rules" ] }, "description": "Allocates the transactions whose field matches the pattern to an account.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Frais bancaires\",\n \"field\": \"description\",\n \"operator\": \"contains\",\n \"pattern\": \"frais de tenue\",\n \"direction\": \"out\",\n \"account_id\": 517\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a bank rule", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-rules/:bankRule", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-rules", ":bankRule" ], "variable": [ { "key": "bankRule", "value": "6", "description": "Id of the bank rule." } ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a bank rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-rules/:bankRule", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-rules", ":bankRule" ], "variable": [ { "key": "bankRule", "value": "6", "description": "Id of the bank rule." } ] }, "description": "Integration tokens need the `write` ability." }, "response": [] }, { "name": "List the CODA files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/coda-files", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "coda-files" ], "query": [ { "key": "journal_id", "value": "3", "description": "", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Download a CODA file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/coda-files/:codaFile/download", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "coda-files", ":codaFile", "download" ], "variable": [ { "key": "codaFile", "value": "31", "description": "Id of the CODA file." } ] }, "description": "Original statement file.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Supplier items to pay", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/payments/open-items", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "payments", "open-items" ] }, "description": "Open supplier lines; `payable` is false when the IBAN of the supplier is missing.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Generate a SEPA credit transfer file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/payments/sepa", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "payments", "sepa" ] }, "description": "pain.001 XML for the chosen open items, debited from the bank of a financial journal. The file is to be uploaded to the bank: NovaFisko never initiates a payment.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 20 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"journal_id\": 7,\n \"line_ids\": [\n 3394,\n 3410\n ],\n \"execution_date\": \"2026-04-02\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "VAT", "description": "VAT codes, periodic declarations, Intervat XML, customer and intra-community listings.", "item": [ { "name": "VAT codes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-codes", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-codes" ], "query": [ { "key": "all", "value": "1", "description": "Include the inactive codes.", "disabled": true } ] }, "description": "Codes of the country pack with their rate, nature and declaration grids.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Activate or describe a VAT code", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-codes/:vatCode", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-codes", ":vatCode" ], "variable": [ { "key": "vatCode", "value": "4", "description": "Id of the VAT code." } ] }, "description": "Rates and grids are part of the country pack and cannot be edited.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "VAT periods of a year", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations" ], "query": [ { "key": "year", "value": "2026", "description": "Current year by default.", "disabled": true } ] }, "description": "Every period of the year with its declaration, or a computed preview when none exists yet.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Create or refresh a draft declaration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations" ] }, "description": "Computes the grids of the period and stores them as a draft. Calling it again recomputes the draft.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"year\": 2026,\n \"period\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Compute a VAT period", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/preview", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", "preview" ], "query": [ { "key": "year", "value": "2026", "description": "2000 to 2100.", "disabled": false }, { "key": "period", "value": "1", "description": "Month (1-12) or quarter (1-4) according to the VAT regime of the file.", "disabled": false } ] }, "description": "Grids computed from the entries of the period, without saving anything.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Intra-community listing", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/intracom-listing", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", "intracom-listing" ], "query": [ { "key": "year", "value": "2026", "description": "2000 to 2100.", "disabled": false }, { "key": "period", "value": "1", "description": "Month (1-12) or quarter (1-4) according to the VAT regime of the file.", "disabled": false }, { "key": "format", "value": "xml", "description": "", "disabled": true } ] }, "description": "Intra-EU supplies of goods and services per customer for the period. `format=xml` downloads the Intervat file.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Annual customer listing", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/client-listing/:year", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", "client-listing", ":year" ], "query": [ { "key": "format", "value": "xml", "description": "", "disabled": true } ], "variable": [ { "key": "year", "value": "2026", "description": "Calendar year." } ] }, "description": "Belgian VAT-liable customers of the year with turnover and VAT; `declare` is true above the legal threshold of 250 EUR. `format=xml` downloads the Intervat file.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "VAT declaration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/:vatDeclaration", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", ":vatDeclaration" ], "variable": [ { "key": "vatDeclaration", "value": "14", "description": "Id of the VAT declaration." } ] }, "description": "With its settlement entry once validated.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Validate a declaration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/:vatDeclaration/validate", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", ":vatDeclaration", "validate" ], "variable": [ { "key": "vatDeclaration", "value": "14", "description": "Id of the VAT declaration." } ] }, "description": "Freezes the grids and posts the VAT settlement entry (accounts of `settings.auto_entries.vat`). Emits the webhook `vat.declaration_validated`.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Mark a declaration as submitted", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/:vatDeclaration/submit", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", ":vatDeclaration", "submit" ], "variable": [ { "key": "vatDeclaration", "value": "14", "description": "Id of the VAT declaration." } ] }, "description": "Records the Intervat reference. NovaFisko does not file the declaration itself: download the XML and upload it on Intervat.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"reference\": \"INTERVAT-2026-04-0098123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Intervat XML of a declaration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/:vatDeclaration/xml", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", ":vatDeclaration", "xml" ], "variable": [ { "key": "vatDeclaration", "value": "14", "description": "Id of the VAT declaration." } ] }, "description": "File ready to upload on Intervat (VATConsignment).\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Fixed assets", "description": "Fixed asset register, depreciation plans, bookings, disposals.", "item": [ { "name": "Fixed asset register", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets" ] }, "description": "With the depreciation plan of each asset.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Create a fixed asset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets" ] }, "description": "Builds the depreciation plan (linear or declining, pro rata temporis) and resolves the asset, depreciation and expense accounts.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Four mixte Rational\",\n \"category\": \"machinery\",\n \"acquisition_date\": \"2026-02-01\",\n \"acquisition_cost\": \"12400.00\",\n \"useful_life_years\": 5\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Depreciation table per group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/groups/:fiscalYear", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", "groups", ":fiscalYear" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Acquisition cost, accumulated depreciation, depreciation of the year and net book value per group, for a fiscal year.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Fixed asset", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/:fixedAsset", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", ":fixedAsset" ], "variable": [ { "key": "fixedAsset", "value": "9", "description": "Id of the fixed asset." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Update a fixed asset", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/:fixedAsset", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", ":fixedAsset" ], "variable": [ { "key": "fixedAsset", "value": "9", "description": "Id of the fixed asset." } ] }, "description": "The plan is rebuilt for the years not booked yet.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"useful_life_years\": 7\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Book the depreciation of a period", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/book-period/:fiscalYear", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", "book-period", ":fiscalYear" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "One miscellaneous entry for every asset, for a month of the fiscal year. 200 with `entry: null` when there is nothing to book.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"period_number\": 3\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Book the yearly depreciation of an asset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/:fixedAsset/book/:fiscalYear", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", ":fixedAsset", "book", ":fiscalYear" ], "variable": [ { "key": "fixedAsset", "value": "9", "description": "Id of the fixed asset." }, { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Miscellaneous entry 6302 / 2x09 for the fiscal year.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `period_locked`: the period is locked or the fiscal year is closed; `reason` tells which (`period_locked` or `fiscal_year_closed`)" }, "response": [] }, { "name": "Dispose of an asset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/:fixedAsset/dispose", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", ":fixedAsset", "dispose" ], "variable": [ { "key": "fixedAsset", "value": "9", "description": "Id of the fixed asset." } ] }, "description": "Sale (price above 0) or scrapping (price 0): posts the disposal entry with the gain or loss.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-09-30\",\n \"sale_price\": \"4500.00\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Reports", "description": "Trial balance, general ledger, balance sheet and income statement, third party and aged balances.", "item": [ { "name": "Entries of a journal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journals/:journal/entries", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journals", ":journal", "entries" ], "query": [ { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true } ], "variable": [ { "key": "journal", "value": "3", "description": "Id of the journal." } ] }, "description": "Full entries of the journal over a date range, in number order (journal book).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Trial balance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/trial-balance", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "trial-balance" ], "query": [ { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "include_empty", "value": "1", "description": "Include the accounts without movement.", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Balance by period", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/balance-by-period", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "balance-by-period" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "One column per period of the fiscal year.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Balance sheet and income statement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/financial-statements", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "financial-statements" ], "query": [ { "key": "to", "value": "2026-03-15", "description": "Situation at this date.", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Belgian legal scheme (BNB / NBB headings), in real time.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "General ledger of an account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/general-ledger/:account", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "general-ledger", ":account" ], "query": [ { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." }, { "key": "account", "value": "223", "description": "Id of the account (not its number)." } ] }, "description": "Movements of one account with the running balance.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Consistency of the fiscal year", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/consistency", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "consistency" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Gaps in the numbering, entries whose period does not match their date, entries outside the fiscal year.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Customer or supplier balance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-party-balance/:type", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-party-balance", ":type" ], "query": [ { "key": "to", "value": "2026-03-15", "description": "", "disabled": true } ], "variable": [ { "key": "type", "value": "customer", "description": "Side of the balance." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Aged balance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/aged-balance/:type", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "aged-balance", ":type" ], "query": [ { "key": "to", "value": "2026-03-15", "description": "Today by default.", "disabled": true } ], "variable": [ { "key": "type", "value": "customer", "description": "Side of the balance." } ] }, "description": "Open amounts per third party, split by age: not due, 1-30, 31-60, 61-90 and more than 90 days.\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Analytics & budgets", "description": "Analytic codes, analytic report, budgets.", "item": [ { "name": "Analytic codes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/analytic-codes", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "analytic-codes" ], "query": [ { "key": "axis", "value": "cost_center", "description": "", "disabled": true } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Create an analytic code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/analytic-codes", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "analytic-codes" ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"axis\": \"cost_center\",\n \"code\": \"SALLE\",\n \"label\": \"Salle\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update an analytic code", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/analytic-codes/:analyticCode", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "analytic-codes", ":analyticCode" ], "variable": [ { "key": "analyticCode", "value": "2", "description": "Id of the analytic code." } ] }, "description": "Integration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Analytic report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/analytic-report", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "analytic-report" ], "query": [ { "key": "axis", "value": "cost_center", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Expenses, income and result per analytic code.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Budget cells", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/budgets", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "budgets" ], "query": [ { "key": "scenario", "value": "string", "description": "`default` when absent.", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Save budget cells", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/budgets", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "budgets" ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Batch of cells (account × period, optionally × cost centre). An amount of 0 deletes the cell; `spread_yearly` spreads a yearly amount over twelve months.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"cells\": [\n {\n \"account_id\": 378,\n \"period_number\": 1,\n \"amount\": \"18000.00\"\n }\n ],\n \"spread_yearly\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Budget against actuals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fiscal-years/:fiscalYear/budget-report", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fiscal-years", ":fiscalYear", "budget-report" ], "query": [ { "key": "scenario", "value": "string", "description": "", "disabled": true }, { "key": "cost_center_id", "value": "42", "description": "", "disabled": true }, { "key": "upto_period", "value": "1", "description": "1 to 12.", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Exports", "description": "Legal books, statements and data as PDF, XLSX or CSV; full dossier as ZIP.", "item": [ { "name": "Catalogue of exports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/exports", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "exports" ], "query": [ { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "Every export with its group, formats and parameters. `types` keeps the historical list of CSV codes.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Full dossier (ZIP)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/exports/full-dossier/:fiscalYear", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "exports", "full-dossier", ":fiscalYear" ], "query": [ { "key": "lang", "value": "fr", "description": "", "disabled": true } ], "variable": [ { "key": "fiscalYear", "value": "2", "description": "Id of the fiscal year." } ] }, "description": "Every book, statement, VAT document, third party listing, fixed asset table and the source documents of the fiscal year, in numbered folders with a manifest of SHA-256 fingerprints.\n\nIntegration tokens need the `read` ability.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Signed preview URL of an export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/exports/:type/preview-url", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "exports", ":type", "preview-url" ], "query": [ { "key": "fiscal_year_id", "value": "2", "description": "The current fiscal year when absent.", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true }, { "key": "account_from", "value": "string", "description": "general-ledger.", "disabled": true }, { "key": "account_to", "value": "string", "description": "general-ledger.", "disabled": true }, { "key": "scheme", "value": "abbreviated", "description": "annual-accounts.", "disabled": true }, { "key": "general_meeting_date", "value": "2026-03-15", "description": "annual-accounts.", "disabled": true }, { "key": "declaration_id", "value": "42", "description": "vat-declaration.", "disabled": true }, { "key": "year", "value": "2026", "description": "intracom-listing.", "disabled": true }, { "key": "period", "value": "3", "description": "intracom-listing.", "disabled": true }, { "key": "third_party_id", "value": "18", "description": "third-party-ledger.", "disabled": true }, { "key": "party_type", "value": "customer", "description": "third-party-ledger.", "disabled": true } ], "variable": [ { "key": "type", "value": "trial-balance", "description": "Export code from the catalogue of `GET exports` (`journals`, `general-ledger`, `trial-balance`, `vat-declaration`, …)." } ] }, "description": "URL valid 15 minutes that serves the PDF inline (preview pane).\n\nIntegration tokens need the `read` ability.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Download an export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/exports/:type", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "exports", ":type" ], "query": [ { "key": "format", "value": "pdf", "description": "CSV by default.", "disabled": true }, { "key": "fiscal_year_id", "value": "2", "description": "The current fiscal year when absent.", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "lang", "value": "fr", "description": "", "disabled": true }, { "key": "account_from", "value": "string", "description": "general-ledger.", "disabled": true }, { "key": "account_to", "value": "string", "description": "general-ledger.", "disabled": true }, { "key": "scheme", "value": "abbreviated", "description": "annual-accounts.", "disabled": true }, { "key": "general_meeting_date", "value": "2026-03-15", "description": "annual-accounts.", "disabled": true }, { "key": "declaration_id", "value": "42", "description": "vat-declaration.", "disabled": true }, { "key": "year", "value": "2026", "description": "intracom-listing.", "disabled": true }, { "key": "period", "value": "3", "description": "intracom-listing.", "disabled": true }, { "key": "third_party_id", "value": "18", "description": "third-party-ledger.", "disabled": true }, { "key": "party_type", "value": "customer", "description": "third-party-ledger.", "disabled": true } ], "variable": [ { "key": "type", "value": "trial-balance", "description": "Export code from the catalogue of `GET exports` (`journals`, `general-ledger`, `trial-balance`, `vat-declaration`, …)." } ] }, "description": "Codes: journals, purchases, sales, financial, miscellaneous, general-ledger, trial-balance, balance-by-period, financial-statements, annual-accounts, vat-summary, vat-declaration, customer-listing, intracom-listing, third-parties, customer-balance, supplier-balance, aged-customers, aged-suppliers, third-party-ledger, fixed-assets, accounts, documents, audit-trail. Generation is synchronous. PDFs of a period that is not locked carry a « provisional » mention.\n\nIntegration tokens need the `read` ability.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Inline PDF of an export (signed)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/exports/:type/view", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "exports", ":type", "view" ], "variable": [ { "key": "type", "value": "trial-balance", "description": "Export code from the catalogue of `GET exports` (`journals`, `general-ledger`, `trial-balance`, `vat-declaration`, …)." } ] }, "description": "Target of the URL returned by `preview-url`.\n\nAuthorised by the signature of the URL (query parameters `signature` and `expires`), not by a bearer token. The URL is issued by another endpoint and expires.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Peppol", "description": "Registration of a company file on Peppol, transport options, network lookups.", "item": [ { "name": "Peppol state of the file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol" ] }, "description": "Registration, transport options, SMP publication, supported documents and what blocks a registration.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Unregister the file from Peppol", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol" ] }, "description": "Archives the account at the access point and records the reason.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.", "body": { "mode": "raw", "raw": "{\n \"reason_type\": \"accountant\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Register the file on Peppol", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol/register", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol", "register" ] }, "description": "Creates the account at the access point (B2Brouter) and publishes the participant `0208:`. 201 for a new registration, 200 when it was already active. Emits the webhook `peppol.status_changed`.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 6 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"email\": \"gerant@comptoir-montois.example\",\n \"address\": \"Grand-Place 14\",\n \"postal_code\": \"7000\",\n \"city\": \"Mons\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Refresh the Peppol state", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol/refresh", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol", "refresh" ] }, "description": "Reads the account at the access point and the network (SML / SMP) again.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 12 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Update the transport options", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol/transport", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol", "transport" ] }, "description": "Reception and the document families received through Peppol.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.", "body": { "mode": "raw", "raw": "{\n \"reception\": true,\n \"credit_note\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Look a participant up on the Peppol network", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol/lookup", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol", "lookup" ], "query": [ { "key": "identifier", "value": "0208:0402531376", "description": "", "disabled": true }, { "key": "vat", "value": "BE0402531376", "description": "", "disabled": true }, { "key": "country", "value": "BE", "description": "", "disabled": true }, { "key": "enterprise_number", "value": "0477472701", "description": "", "disabled": true } ] }, "description": "By identifier (`0208:0402531376`) or by VAT / enterprise number and country. Reads the SML and the SMP of the participant.\n\nIntegration tokens need the `read` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Supported Peppol document types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol/document-types", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol", "document-types" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Calls to the access point", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/peppol/logs", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "peppol", "logs" ], "query": [ { "key": "limit", "value": "1", "description": "1 to 200, 50 by default.", "disabled": true } ] }, "description": "Last calls made for the file, for support.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Check the Peppol status of every third party", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/peppol/check-all", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", "peppol", "check-all" ] }, "description": "Up to 100 third parties per call.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 6 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"only_stale\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Peppol status of a third party", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:thirdParty/peppol", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":thirdParty", "peppol" ], "query": [ { "key": "refresh", "value": "1", "description": "", "disabled": true } ], "variable": [ { "key": "thirdParty", "value": "18", "description": "Id of the third party." } ] }, "description": "Cached 7 days; `refresh=1` asks the network again.\n\nIntegration tokens need the `read` ability.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] } ] }, { "name": "Integrations", "description": "Catalogue of integrations, Novadesko synchronisation, file relays.", "item": [ { "name": "Catalogue of integrations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations" ], "query": [ { "key": "lang", "value": "fr", "description": "", "disabled": true } ] }, "description": "Every integration with its status, its configuration schema and the connection of the file.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Activate an integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/activate", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "activate" ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `integration_error`: generic driver error\n- `not_available`: integration not available yet\n- `not_connected`: the integration is not active on the file\n- `integration_inactive`: the integration is switched off\n- `no_driver`: nothing to run for this integration\n- `not_linked`: the file is not linked to the external system\n- `use_open_tab`: managed from its own tab (Peppol)\n- `file_required`: a file is expected\n- `file_too_large`: file above the size limit\n- `sync_failed`: the run failed\n- `novadesko_locked`: locked on the Novadesko side", "body": { "mode": "raw", "raw": "{\n \"config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deactivate an integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/deactivate", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "deactivate" ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `integration_error`: generic driver error\n- `not_available`: integration not available yet\n- `not_connected`: the integration is not active on the file\n- `integration_inactive`: the integration is switched off\n- `no_driver`: nothing to run for this integration\n- `not_linked`: the file is not linked to the external system\n- `use_open_tab`: managed from its own tab (Peppol)\n- `file_required`: a file is expected\n- `file_too_large`: file above the size limit\n- `sync_failed`: the run failed\n- `novadesko_locked`: locked on the Novadesko side" }, "response": [] }, { "name": "Update the configuration", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/config", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "config" ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "Secrets are stored encrypted and returned masked.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `integration_error`: generic driver error\n- `not_available`: integration not available yet\n- `not_connected`: the integration is not active on the file\n- `integration_inactive`: the integration is switched off\n- `no_driver`: nothing to run for this integration\n- `not_linked`: the file is not linked to the external system\n- `use_open_tab`: managed from its own tab (Peppol)\n- `file_required`: a file is expected\n- `file_too_large`: file above the size limit\n- `sync_failed`: the run failed\n- `novadesko_locked`: locked on the Novadesko side", "body": { "mode": "raw", "raw": "{\n \"config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Test the connection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/test", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "test" ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 12 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `integration_error`: generic driver error\n- `not_available`: integration not available yet\n- `not_connected`: the integration is not active on the file\n- `integration_inactive`: the integration is switched off\n- `no_driver`: nothing to run for this integration\n- `not_linked`: the file is not linked to the external system\n- `use_open_tab`: managed from its own tab (Peppol)\n- `file_required`: a file is expected\n- `file_too_large`: file above the size limit\n- `sync_failed`: the run failed\n- `novadesko_locked`: locked on the Novadesko side" }, "response": [] }, { "name": "Run a synchronisation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/sync", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "sync" ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "Runs the driver synchronously. JSON options (`full`) or, for `file_import`, a multipart upload (`file`: CODA, CSV…). On failure the answer is 422 with the last `run`.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 12 requests per minute (429 beyond, see `Retry-After`).\n\nError codes (`code`):\n- `integration_error`: generic driver error\n- `not_available`: integration not available yet\n- `not_connected`: the integration is not active on the file\n- `integration_inactive`: the integration is switched off\n- `no_driver`: nothing to run for this integration\n- `not_linked`: the file is not linked to the external system\n- `use_open_tab`: managed from its own tab (Peppol)\n- `file_required`: a file is expected\n- `file_too_large`: file above the size limit\n- `sync_failed`: the run failed\n- `novadesko_locked`: locked on the Novadesko side", "body": { "mode": "raw", "raw": "{\n \"full\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Synchronisation runs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/runs", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "runs" ], "query": [ { "key": "limit", "value": "1", "description": "1 to 100, 20 by default.", "disabled": true } ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Register an interest", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/integrations/:integration/interest", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "integrations", ":integration", "interest" ], "variable": [ { "key": "integration", "value": "novadesko", "description": "Slug of the integration (`novadesko`, `peppol`, `file_import`, …)." } ] }, "description": "For an integration that is not available yet (`coming_soon`).\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] }, { "name": "Synchronise the file from Novadesko", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/novadesko", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "novadesko" ] }, "description": "Reads documents, bank statements (CODA) and fixed assets of the linked shop. Read-only on the Novadesko side. 422 when the file is not linked or the integration is inactive.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 10 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"full\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Signed URL of a Novadesko file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/files/preview-url", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "files", "preview-url" ], "query": [ { "key": "url", "value": "https://api.novafisko.com/v1/companies/XBVD5O1L29HC", "description": "File on web.novadesko.com.", "disabled": false } ] }, "description": "Novadesko files cannot be framed directly; this returns a signed relay URL valid 20 minutes. Only whitelisted hosts and paths are relayed.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Signed relay of a Novadesko file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/files/view", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "files", "view" ], "query": [ { "key": "url", "value": "https://api.novafisko.com/v1/companies/XBVD5O1L29HC", "description": "", "disabled": false } ] }, "description": "Target of `files/preview-url`: serves the PDF or image inline with `frame-ancestors` allowing the app.\n\nAuthorised by the signature of the URL (query parameters `signature` and `expires`), not by a bearer token. The URL is issued by another endpoint and expires.\n\nRate limit: 120 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "History & recycle bin", "description": "Version history, revert, recycle bin, activity feed.", "item": [ { "name": "Version history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history" ], "query": [ { "key": "subject_type", "value": "string", "description": "third_parties, accounts, journals, entries, documents, bank_transactions, fixed_assets…", "disabled": true }, { "key": "subject_id", "value": "42", "description": "", "disabled": true }, { "key": "user_id", "value": "12", "description": "", "disabled": true }, { "key": "action", "value": "created", "description": "", "disabled": true }, { "key": "origin", "value": "online", "description": "", "disabled": true }, { "key": "operation_id", "value": "bf413a19-2136-4504-bc42-b314637eb5c7", "description": "", "disabled": true }, { "key": "device_id", "value": "mac-7F3A21", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Record label, user or device.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Who changed what, from which device, newest first.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Filters of the history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/users", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", "users" ] }, "description": "People and devices that changed something, subject types and actions.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Export the history (CSV)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/export", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", "export" ], "query": [ { "key": "subject_type", "value": "string", "description": "third_parties, accounts, journals, entries, documents, bank_transactions, fixed_assets…", "disabled": true }, { "key": "subject_id", "value": "42", "description": "", "disabled": true }, { "key": "user_id", "value": "12", "description": "", "disabled": true }, { "key": "action", "value": "created", "description": "", "disabled": true }, { "key": "origin", "value": "online", "description": "", "disabled": true }, { "key": "operation_id", "value": "bf413a19-2136-4504-bc42-b314637eb5c7", "description": "", "disabled": true }, { "key": "device_id", "value": "mac-7F3A21", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Record label, user or device.", "disabled": true } ] }, "description": "Same filters as the list. UTF-8 with BOM, semicolon separated.\n\nIntegration tokens need the `read` ability.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Retention settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/settings", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", "settings" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Update the retention of the recycle bin", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/settings", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", "settings" ] }, "description": "Managers only.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `settings_forbidden`: only a manager can change this setting", "body": { "mode": "raw", "raw": "{\n \"trash_retention_days\": 180\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Undo a whole operation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/operations/:operation/revert", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", "operations", ":operation", "revert" ], "variable": [ { "key": "operation", "value": "bf413a19-2136-4504-bc42-b314637eb5c7", "description": "Operation id (`X-Operation-Id`) grouping the changes of one action." } ] }, "description": "Reverts every change recorded under one `X-Operation-Id`, newest first, in one transaction: all or nothing.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `conflict`: the record changed since then (forceable by a manager with `force: true`)\n- `period_locked`: locked period or closed fiscal year\n- `vat_locked`: VAT return validated or submitted\n- `already_reverted`: already reverted\n- `not_revertible`: this kind of change cannot be reverted\n- `entry_immutable`: a posted entry is reversed, not modified\n- `in_use`: the record is in use\n- `booked`: the record is booked\n- `code_taken`: the code is used by another record\n- `force_forbidden`: only a manager can force\n- `read_only`: read-only access to the file\n- `operation_not_found`: unknown operation\n- `operation_not_revertible`: one change of the batch cannot be reverted\n- `nothing_to_revert`: nothing to revert", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Erreur de saisie\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Revision", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/:revision", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", ":revision" ], "variable": [ { "key": "revision", "value": "2301", "description": "Id of the revision (history line)." } ] }, "description": "With the snapshots before and after.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Revert a change", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/history/:revision/revert", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "history", ":revision", "revert" ], "variable": [ { "key": "revision", "value": "2301", "description": "Id of the revision (history line)." } ] }, "description": "Puts back the state before the change: an update restores the previous values, a deletion restores the record, a creation sends it to the recycle bin, a posted entry is reversed. The revert is itself recorded and revertible.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `conflict`: the record changed since then (forceable by a manager with `force: true`)\n- `period_locked`: locked period or closed fiscal year\n- `vat_locked`: VAT return validated or submitted\n- `already_reverted`: already reverted\n- `not_revertible`: this kind of change cannot be reverted\n- `entry_immutable`: a posted entry is reversed, not modified\n- `in_use`: the record is in use\n- `booked`: the record is booked\n- `code_taken`: the code is used by another record\n- `force_forbidden`: only a manager can force\n- `read_only`: read-only access to the file\n- `operation_not_found`: unknown operation\n- `operation_not_revertible`: one change of the batch cannot be reverted\n- `nothing_to_revert`: nothing to revert", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Mauvais tiers\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Activity of the file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/activity", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "activity" ], "query": [ { "key": "user_id", "value": "12", "description": "", "disabled": true }, { "key": "from", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "to", "value": "2026-03-15", "description": "", "disabled": true }, { "key": "type", "value": "string", "description": "", "disabled": true }, { "key": "source", "value": "audit", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Audit trail (sign-ins, exports, bookings…) and history merged, newest first. No total: use `has_more`.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Recycle bin", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/trash", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "trash" ], "query": [ { "key": "type", "value": "string", "description": "Recycle bin type.", "disabled": true }, { "key": "q", "value": "string", "description": "", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Restore everything", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/trash/restore-all", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "trash", "restore-all" ] }, "description": "Optionally one type only.\n\nIntegration tokens need the `write` ability.", "body": { "mode": "raw", "raw": "{\n \"type\": \"third_parties\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Restore a record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/trash/:type/:id/restore", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "trash", ":type", ":id", "restore" ], "variable": [ { "key": "type", "value": "third_parties", "description": "Recycle bin type: `third_parties`, `accounts`, `journals`, `journal_rules`, `bank_rules`, `recurring_entries`, `analytic_codes`, `fixed_assets`, `documents`, `document_imports`, `integrations`." }, { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "A third party whose code was taken comes back with a suffixed code; an account, journal or analytic code is refused (`code_taken`).\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `code_taken`: the code is used by another record\n- `parent_missing`: the linked record no longer exists\n- `not_in_trash`: the record is not in the recycle bin\n- `restore_failed`: the restore failed" }, "response": [] }, { "name": "Delete definitively", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/trash/:type/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "trash", ":type", ":id" ], "variable": [ { "key": "type", "value": "third_parties", "description": "Recycle bin type: `third_parties`, `accounts`, `journals`, `journal_rules`, `bank_rules`, `recurring_entries`, `analytic_codes`, `fixed_assets`, `documents`, `document_imports`, `integrations`." }, { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Managers only; recorded in the audit trail. Cannot be undone.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `purge_forbidden`: only a manager can purge" }, "response": [] }, { "name": "History of one record (third parties)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/third-parties/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "third-parties", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (entries)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/entries/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "entries", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (documents)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (accounts)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/accounts/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "accounts", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (bank transactions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/bank-transactions/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "bank-transactions", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (fixed assets)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (journals)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/journals/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "journals", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (recurring entries)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/recurring-entries/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "recurring-entries", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "History of one record (vat declarations)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/vat-declarations/:id/history", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "vat-declarations", ":id", "history" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Same items as the version history, limited to one record.\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Move to the recycle bin (accounts)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/accounts/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "accounts", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Refused with 422 when the record is used or booked.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `in_use`: the record is used by entries or documents\n- `booked`: the record is booked: reverse the entry first" }, "response": [] }, { "name": "Move to the recycle bin (analytic codes)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/analytic-codes/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "analytic-codes", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Refused with 422 when the record is used or booked.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `in_use`: the record is used by entries or documents\n- `booked`: the record is booked: reverse the entry first" }, "response": [] }, { "name": "Move to the recycle bin (fixed assets)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/fixed-assets/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "fixed-assets", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Refused with 422 when the record is used or booked.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `in_use`: the record is used by entries or documents\n- `booked`: the record is booked: reverse the entry first" }, "response": [] }, { "name": "Move to the recycle bin (documents)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/documents/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "documents", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "Id of the record." } ] }, "description": "Refused with 422 when the record is used or booked.\n\nIntegration tokens need the `write` ability.\n\nError codes (`code`):\n- `in_use`: the record is used by entries or documents\n- `booked`: the record is booked: reverse the entry first" }, "response": [] } ] }, { "name": "Synchronisation", "description": "Continuous and offline synchronisation: bootstrap, pull, push, conflicts. Requires the `sync` ability for integration tokens.", "item": [ { "name": "First load", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/bootstrap", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "bootstrap" ] }, "description": "Starting point of a local copy: the cursor, the list of resources with their REST endpoint, the company, its settings and the rights of the user. Load each resource through its endpoint, then keep `cursor` for `sync/pull`.\n\nIntegration tokens need the `sync` ability." }, "response": [] }, { "name": "Incremental pull", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/pull", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "pull" ], "query": [ { "key": "since", "value": "1042", "description": "Cursor of the previous pull or bootstrap.", "disabled": true }, { "key": "resources", "value": "third_parties,entries", "description": "Comma-separated resource names.", "disabled": true }, { "key": "limit", "value": "1", "description": "500 by default, 1000 max.", "disabled": true } ] }, "description": "Changes since a cursor, one line per record (last state). `delete` is a tombstone (deleted or in the recycle bin). When `since` is absent, unknown or older than the 90-day journal, `full_resync` is true and no change is returned: reload everything, then restart from the returned cursor. A change becomes visible two seconds after it was written.\n\nIntegration tokens need the `sync` ability." }, "response": [] }, { "name": "Push offline mutations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/push", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "push" ] }, "description": "Up to 200 mutations, processed in order, each in its own transaction and replayed through the matching REST action. Idempotent on `client_mutation_id`. Conflicts are settled by the priority rules (posted or locked accounting data always wins; field-by-field merge; highest role, then most recent change).\n\nIntegration tokens need the `sync` ability.", "body": { "mode": "raw", "raw": "{\n \"device\": {\n \"id\": \"erp-connector-01\",\n \"name\": \"ERP connector\",\n \"platform\": \"server\"\n },\n \"mutations\": [\n {\n \"client_mutation_id\": \"b0a6f6f0-7d1c-4c5e-8a55-3f2b1c9d0e11\",\n \"occurred_at\": \"2026-10-05T08:00:00Z\",\n \"resource\": \"third_parties\",\n \"op\": \"create\",\n \"client_temp_id\": \"tmp-3c1f\",\n \"data\": {\n \"type\": \"supplier\",\n \"name\": \"Proximus SA\",\n \"vat_number\": \"BE0202239951\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Synchronisation status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/status", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "status" ] }, "description": "Integration tokens need the `sync` ability." }, "response": [] }, { "name": "Synchronisation conflicts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/conflicts", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "conflicts" ], "query": [ { "key": "status", "value": "open", "description": "", "disabled": true }, { "key": "resource", "value": "string", "description": "", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Items per page (default 50, maximum 200).", "disabled": true } ] }, "description": "Integration tokens need the `sync` ability." }, "response": [] }, { "name": "Resolve a conflict", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/sync/conflicts/:conflict/resolve", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "sync", "conflicts", ":conflict", "resolve" ], "variable": [ { "key": "conflict", "value": "8", "description": "Id of the synchronisation conflict." } ] }, "description": "`client` applies the values that were refused, `merge` applies `data`, `server` acknowledges.\n\nIntegration tokens need the `sync` ability.\n\nError codes (`code`):\n- `conflict_already_resolved`: already resolved\n- `conflict_choice_unavailable`: choice not available for this conflict", "body": { "mode": "raw", "raw": "{\n \"choice\": \"client\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Mail", "description": "Mails sent to clients in the name of the firm, shared files.", "item": [ { "name": "Send documents or an export by e-mail", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/mail/documents", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "mail", "documents" ] }, "description": "Sends documents of the file and / or an export to a client, in the name of the firm. Above 10 MB (or with `as_link`) the files are sent as a signed download link valid 7 days. Manager role at least.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 20 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"gerant@comptoir-montois.example\"\n ],\n \"subject\": \"Balance au 30 septembre\",\n \"message\": \"Bonjour, vous trouverez ci-joint la balance arrêtée au 30 septembre.\",\n \"export\": {\n \"type\": \"trial-balance\",\n \"format\": \"pdf\",\n \"to\": \"2026-09-30\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Ask a client for missing documents", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Client-Mutation-Id", "value": "{{$guid}}", "description": "Idempotence key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/mail/document-request", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "mail", "document-request" ] }, "description": "Integration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 20 requests per minute (429 beyond, see `Retry-After`).", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"gerant@comptoir-montois.example\"\n ],\n \"items\": [\n \"Extrait bancaire de septembre\",\n \"Facture Engie d'août\"\n ],\n \"due_date\": \"2026-10-15\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Mails sent for the file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/companies/{{company}}/mail/logs", "host": [ "{{base_url}}" ], "path": [ "v1", "companies", "{{company}}", "mail", "logs" ], "query": [ { "key": "template", "value": "string", "description": "Template key.", "disabled": true }, { "key": "per_page", "value": "50", "description": "25 by default, 100 max.", "disabled": true }, { "key": "page", "value": "1", "description": "", "disabled": true } ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "Download a shared file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/mail/shares/:share", "host": [ "{{base_url}}" ], "path": [ "v1", "mail", "shares", ":share" ], "variable": [ { "key": "share", "value": "q8ZrT2mVx4", "description": "Token of the shared file." } ] }, "description": "Signed link of a mail (7 days). An expired or purged share redirects to the « download expired » page of the app.\n\nAuthorised by the signature of the URL (query parameters `signature` and `expires`), not by a bearer token. The URL is issued by another endpoint and expires.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Open pixel", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/mail/o/:token.gif", "host": [ "{{base_url}}" ], "path": [ "v1", "mail", "o", ":token.gif" ], "variable": [ { "key": "token", "value": "a1B2c3D4e5", "description": "Opaque token." } ] }, "description": "Present in the mails only when tracking is switched on by the firm. Not meant to be called by integrations.\n\nPublic endpoint: no bearer token.\n\nRate limit: 240 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Click redirection", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/mail/c/:token", "host": [ "{{base_url}}" ], "path": [ "v1", "mail", "c", ":token" ], "query": [ { "key": "u", "value": "string", "description": "Encoded target.", "disabled": false }, { "key": "s", "value": "string", "description": "Signature.", "disabled": false } ], "variable": [ { "key": "token", "value": "a1B2c3D4e5", "description": "Opaque token." } ] }, "description": "Followed only when the signature of the target matches (no open redirect). Not meant to be called by integrations.\n\nPublic endpoint: no bearer token.\n\nRate limit: 240 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Webhooks", "description": "Outgoing webhooks of a firm: endpoints, test event, delivery log.", "item": [ { "name": "Catalogue of webhook events", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhooks/events", "host": [ "{{base_url}}" ], "path": [ "v1", "webhooks", "events" ] }, "description": "Integration tokens need the `read` ability." }, "response": [] }, { "name": "List the webhook endpoints", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "webhooks" ] }, "description": "Admins and managers of the firm (403 for other members, 404 for non-members).\n\nIntegration tokens need the `read` ability." }, "response": [] }, { "name": "Create a webhook endpoint", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "webhooks" ] }, "description": "The signing secret (`whsec_…`) is returned once. Events are queued and sent by a dispatcher that runs every minute.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `webhook_limit_reached`: 20 endpoints per firm at most\n- `webhook_url_refused`: the URL is not HTTPS or targets a private / loopback address (production)", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://erp.example.com/hooks/novafisko\",\n \"description\": \"ERP connector\",\n \"events\": [\n \"entry.posted\",\n \"document.booked\",\n \"vat.declaration_validated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a webhook endpoint", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/webhooks/:webhook", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "webhooks", ":webhook" ], "variable": [ { "key": "webhook", "value": "3", "description": "Id of the webhook endpoint." } ] }, "description": "A paused endpoint keeps its pending deliveries; they are sent once it is active again.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nError codes (`code`):\n- `webhook_url_refused`: the URL is not HTTPS or targets a private / loopback address (production)", "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a webhook endpoint", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/webhooks/:webhook", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "webhooks", ":webhook" ], "variable": [ { "key": "webhook", "value": "3", "description": "Id of the webhook endpoint." } ] }, "description": "Pending deliveries of the endpoint are dropped.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`." }, "response": [] }, { "name": "Send a test event", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/webhooks/:webhook/test", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "webhooks", ":webhook", "test" ], "variable": [ { "key": "webhook", "value": "3", "description": "Id of the webhook endpoint." } ] }, "description": "Sends a `webhook.test` event immediately, signed like a real one. It is never retried: the returned delivery is `delivered` or `failed`.\n\nIntegration tokens need the `write` ability.\n\nNot available in demo mode: answers 403 `demo_mode`.\n\nRate limit: 12 requests per minute (429 beyond, see `Retry-After`)." }, "response": [] }, { "name": "Deliveries of a webhook endpoint", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/firms/{{firm}}/webhooks/:webhook/deliveries", "host": [ "{{base_url}}" ], "path": [ "v1", "firms", "{{firm}}", "webhooks", ":webhook", "deliveries" ], "query": [ { "key": "status", "value": "pending", "description": "", "disabled": true }, { "key": "event", "value": "entry.posted", "description": "", "disabled": true }, { "key": "page", "value": "1", "description": "Page number, starting at 1.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Items per page (default 25, maximum 100).", "disabled": true } ], "variable": [ { "key": "webhook", "value": "3", "description": "Id of the webhook endpoint." } ] }, "description": "Newest first, with the status, the number of attempts and an excerpt of the answer (2000 characters max). Deliveries that are no longer pending are pruned after 30 days.\n\nIntegration tokens need the `read` ability." }, "response": [] } ] }, { "name": "Novadesko bridge", "description": "Endpoints reserved to the Novadesko platform (shared secret).", "item": [ { "name": "Ping of the Novadesko bridge", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Novafisko-Secret", "value": "string", "description": "Shared secret of the bridge." } ], "url": { "raw": "{{base_url}}/v1/bridge/ping", "host": [ "{{base_url}}" ], "path": [ "v1", "bridge", "ping" ] }, "description": "Used by Novadesko to check the shared secret. Reserved to the Novadesko platform.\n\nPublic endpoint: no bearer token.\n\nRate limit: 30 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Synchronisation status of a Novadesko shop", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Novafisko-Secret", "value": "string", "description": "Shared secret of the bridge." } ], "url": { "raw": "{{base_url}}/v1/bridge/shops/:token/status", "host": [ "{{base_url}}" ], "path": [ "v1", "bridge", "shops", ":token", "status" ], "variable": [ { "key": "token", "value": "shp_8fK2mQ", "description": "Token of the Novadesko shop." } ] }, "description": "Shown on the integration page of Novadesko. Reserved to the Novadesko platform (shared secret).\n\nPublic endpoint: no bearer token.\n\nRate limit: 60 requests per minute (429 beyond, see `Retry-After`).", "auth": { "type": "noauth" } }, "response": [] } ] } ] }