Frihets REST API
Programmatisk åtkomst till fakturor, kunder, utgifter, produkter och offerter. Utformad för integrationer som skalar.
Interactive Explorer
Kodexempel
Deterministic payloads · Fictional fixture (Cafetería Lumen)
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);
curl "https://api.frihet.io/v1/invoices?status=paid&limit=25" \
-H "Authorization: Bearer $FRIHET_API_KEY" \
-H "Accept: application/json"
const res = await fetch('https://api.frihet.io/v1/invoices?status=paid&limit=25', {
headers: {
Authorization: `Bearer ${process.env.FRIHET_API_KEY}`,
Accept: 'application/json',
},
});
const { data, nextCursor } = await res.json();
import os
import requests
res = requests.get(
'https://api.frihet.io/v1/invoices',
params={'status': 'paid', 'limit': 25},
headers={'Authorization': f"Bearer {os.environ['FRIHET_API_KEY']}"},
timeout=10,
)
page = res.json()
{
"data": [
{
"id": "inv_01J8LUMEN0042",
"documentNumber": "F-2026-0042",
"status": "paid",
"clientName": "Cafetería Lumen",
"currency": "EUR",
"subtotal": 1850,
"taxAmount": 388.5,
"total": 2238.5,
"hashPreview": "sha256:9f86d081884c...b0f00a08"
}
],
"total": 42,
"limit": 25,
"offset": 0,
"nextCursor": "cur_01J8LUMEN0043"
}
{
"id": "inv_01J8LUMEN0043",
"documentNumber": null,
"status": "draft",
"clientName": "Cafetería Lumen",
"currency": "EUR",
"items": [
{
"description": "Diseño identidad y carta digital",
"quantity": 1,
"unitPrice": 950
}
],
"subtotal": 950,
"taxAmount": 199.5,
"total": 1149.5,
"hashPreview": null
}
{
"id": "evt_01J8LUMEN9910",
"type": "invoice.paid",
"apiVersion": "2026-03-18",
"createdAt": "2026-06-18T14:22:10Z",
"data": {
"id": "inv_01J8LUMEN0042",
"documentNumber": "F-2026-0042",
"clientName": "Cafetería Lumen",
"status": "paid",
"total": 2238.5,
"currency": "EUR",
"hashPreview": "sha256:9f86d081884c...b0f00a08"
}
}
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. 85 sökvägar, 66 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
| Metod | Sökväg |
|---|---|
| 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 |
Webhook Security & Idempotency Blueprint
Three-step cryptographic webhook verification
X-Frihet-Signature Timestamped signature header
Every delivery carries t=<unix_ts>,v1=<hex_digest> read against the unparsed raw body.
HMAC-SHA256(secret, rawBody) Deterministic raw-body digest
Compute the SHA-256 HMAC over `${t}.${rawBody}` using your endpoint signing key.
timingSafeEqual Constant-time verification
Compare equal-length buffers in constant time and reject stale replay timestamps.
import { createHmac, timingSafeEqual } from 'node:crypto';
export function verifyFrihetWebhook(rawBody: Buffer, header: string, signingKey: string): boolean {
const parts = Object.fromEntries(header.split(',').map((kv) => kv.split('=')));
if (!parts.t || !parts.v1) return false;
const expected = createHmac('sha256', signingKey)
.update(`${parts.t}.${rawBody.toString('utf8')}`)
.digest('hex');
const a = Buffer.from(parts.v1, 'hex');
const b = Buffer.from(expected, 'hex');
return a.length === b.length && timingSafeEqual(a, b);
} 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_... Idempotency-Key: idem_2026_0042
Börja integrera idag
API-åtkomst ingår i alla planer. Din API-nyckel är redo i Inställningar.
Kom igång gratis