# Översikt (/api)

> 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 | <Plan min="ai_pro" /> |
| Rate limit | 25 anrop per 5 sekunder per integration och organisation |

## Hur ett anrop behandlas [#hur-ett-anrop-behandlas]

<Steps>
<Step>
**Token och scope.** `Authorization: Bearer <access_token>` verifieras, och tokenets scopes måste innehålla resursens scope. Anropet räknas mot rate limit.
</Step>
<Step>
**Plan.** Organisationen måste ha AI Pro eller högre. Annars `403` med kod `9000403`.
</Step>
<Step>
**Kuvert.** `POST` och `PUT` måste ha kroppen inlindad i resursnamnet, och innehållet måste vara ett objekt. Annars `400`.
</Step>
<Step>
**Resursen.** Skrivningen går genom samma tjänstelager som Klirrs eget gränssnitt.
</Step>
</Steps>

## Resurser [#resurser]

| Resurs | Scope |
|---|---|
| [Kontoplan](/api/referens/accounts) | `bookkeeping` |
| [Artiklar](/api/referens/articles) | `article` |
| [Kunder](/api/referens/customers) | `customer` |
| [Anställda](/api/referens/employees) | `salary` |
| [Räkenskapsår](/api/referens/financialyears) | `bookkeeping` |
| [Fakturor](/api/referens/invoices) | `invoice` |
| [Fakturabetalningar](/api/referens/invoicepayments) | `invoice` |
| [Låst period](/api/referens/settings-lockedperiod) | `settings` |
| [Leverantörsfakturor](/api/referens/supplierinvoices) | `supplierinvoice` |
| [Leverantörer](/api/referens/suppliers) | `supplier` |
| [Verifikationer](/api/referens/vouchers) | `bookkeeping` |
| [Verifikationsserier](/api/referens/voucherseries) | `bookkeeping` |

## Kom igång [#kom-igång]

- [Snabbstart](/api/snabbstart): från registrerad klient till första anropet.
- [Autentisering](/api/autentisering): hela OAuth-flödet.
- [Fortnox-kompatibilitet](/api/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.