Frihet REST API
Programmatische toegang tot facturen, klanten, uitgaven, producten en offertes. Ontworpen voor schaalbare integraties.
Gemaakt voor ontwikkelaars
Gedeeltelijke PATCH-updates
Update alleen de velden die u nodig heeft. Gedeeltelijke schema's gevalideerd met Zod garanderen de integriteit.
Zoeken en filters
Full-text zoeken met parameter ?q=. Mapping van velden per bron voor nauwkeurige resultaten.
Batch-bewerkingen
Maak tot 50 bronnen in één verzoek. HTTP 207 multi-status antwoorden.
Idempotentiesleutels
Probeer verzoeken veilig opnieuw met de Idempotency-Key-header. Sleutels worden 24 uur lang herkend.
Snelheidslimiet headers
X-RateLimit-Limit, Remaining en Reset in elk antwoord. Plan dienovereenkomstig.
OpenAPI 3.1 Specificatie
Machinaal leesbare specificatie op /openapi.yaml. 16 paden, 18 schema's. Genereert automatisch SDK's.
Intelligentie-endpoints
Bedrijfscontext, maandoverzichten en kwartaalbelastinggegevens via /context, /monthly, /quarterly.
Veilige VeriFactu-verwijdering
Soft delete voor niet-conceptfacturen en -offertes. Volledige traceerbaarheid voor Spaanse fiscale compliance.
Endpoints
| 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 |
Codevoorbeelden
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);
Authenticatie
Genereer API-sleutels via Instellingen > API in uw Frihet-paneel. Voeg uw sleutel toe als Bearer token in de Authorization header.
Authorization: Bearer fri_...
Begin vandaag nog met integreren
API-toegang inbegrepen in alle plannen. Uw API-sleutel is beschikbaar in Instellingen.
Gratis beginnen