Översikt
Klirrs externa API är kompatibelt med Fortnox API v3. Byt bas-URL, behåll resurssökvägarna.
Klirrs externa API låter ett annat system läsa och skriva en organisations kunder, artiklar, fakturor, betalningar, leverantörer, leverantörsfakturor, personalregister och bokföring.
API:t är kompatibelt med Fortnox API v3. Resurssökvägarna, kuverten, fältnamnen och felformen är Fortnox egna, med /api/v1 som prefix. En befintlig Fortnox-integration byter i första hand bas-URL.
| Bas-URL | https://app.klirr.ai/api/v1 |
| Resurser | /3/..., till exempel https://app.klirr.ai/api/v1/3/invoices |
| Format | JSON. Skrivningar kuverteras i resursnamnet: {"Invoice": {...}} |
| Autentisering | OAuth 2.0 authorization code. Inga API-nycklar. |
| Plan | Kräver AI Pro |
| Rate limit | 25 anrop per 5 sekunder per integration och organisation |
Hur ett anrop behandlas
Token och scope. Authorization: Bearer <access_token> verifieras, och tokenets scopes måste innehålla resursens scope. Anropet räknas mot rate limit.
Plan. Organisationen måste ha AI Pro eller högre. Annars 403 med kod 9000403.
Kuvert. POST och PUT måste ha kroppen inlindad i resursnamnet, och innehållet måste vara ett objekt. Annars 400.
Resursen. Skrivningen går genom samma tjänstelager som Klirrs eget gränssnitt.
Resurser
| Resurs | Scope |
|---|---|
| Kontoplan | bookkeeping |
| Artiklar | article |
| Kunder | customer |
| Anställda | salary |
| Räkenskapsår | bookkeeping |
| Fakturor | invoice |
| Fakturabetalningar | invoice |
| Låst period | settings |
| Leverantörsfakturor | supplierinvoice |
| Leverantörer | supplier |
| Verifikationer | bookkeeping |
| Verifikationsserier | bookkeeping |
Kom igång
- Snabbstart: från registrerad klient till första anropet.
- Autentisering: hela OAuth-flödet.
- Fortnox-kompatibilitet: vad som skiljer sig från Fortnox.
Det finns ingen OpenAPI-specifikation och ingen sandlåda. Referensen här är skriven för att läsas av både människor och AI-verktyg.