Frihets REST API
Programmatisk åtkomst till fakturor, kunder, utgifter, produkter och offerter. Utformad för integrationer som skalar.
Byggd för utvecklare
Partiella PATCH-uppdateringar
Uppdatera bara de fält du behöver. Partiella scheman validerade med Zod garanterar integritet.
Sökning och filter
Fulltextsökning med parameter ?q=. Fältmappning per resurs för exakta resultat.
Batchoperationer
Skapa upp till 50 resurser i en enda förfrågan. HTTP 207 multi-status svar.
Idempotensnycklar
Försök utföra förfrågningar igen på ett säkert sätt med Idempotency-Key-headern. Nycklar känns igen i 24 timmar.
Rate limit-headers
X-RateLimit-Limit, Remaining och Reset i varje svar. Planera därefter.
OpenAPI 3.1 Specifikation
Maskinläsbar specifikation på /openapi.yaml. 16 sökvägar, 18 scheman. Genererar SDK:er automatiskt.
Intelligenta slutpunkter
Affärskontext, månatliga sammanfattningar och kvartalsvisa skattedata via /context, /monthly, /quarterly.
Säker radering VeriFactu
Mjuk radering för fakturor och offerter som inte är utkast. Fullständig spårbarhet för spansk skatteefterlevnad.
Slutpunkter
| Method | Path |
|---|---|
| GET | /v1/invoices |
| POST | /v1/invoices |
| PATCH | /v1/invoices/:id |
| DELETE | /v1/invoices/:id |
| POST | /v1/invoices/batch |
| GET | /v1/clients |
| POST | /v1/clients |
| GET | /v1/expenses |
| POST | /v1/expenses |
| GET | /v1/products |
| GET | /v1/quotes |
| GET | /v1/context |
| GET | /v1/monthly |
| GET | /v1/quarterly |
| GET | /openapi.yaml |
Kodexempel
import { Frihet } from '@frihet/sdk';
const apiKey = process.env.FRIHET_API_KEY;
if (!apiKey) throw new Error('Set FRIHET_API_KEY before running this example');
const frihet = new Frihet({ apiKey });
// Follow each page's nextCursor until all paid invoices have been read.
let cursor: string | undefined;
do {
const page = await frihet.invoices.list({ status: 'paid', limit: 25, cursor });
for (const invoice of page.data) {
console.log(invoice.documentNumber, invoice.total);
}
cursor = page.nextCursor;
} while (cursor);
Autentisering
Generera API-nycklar från Inställningar > API i din Frihet-panel. Inkludera din nyckel som Bearer token i Authorization-headern.
Authorization: Bearer fri_...
Börja integrera idag
API-åtkomst ingår i alla planer. Din API-nyckel är redo i Inställningar.
Kom igång gratis