Filtrering

Filtrering

De fleste liste-endepunkter i Fenerum API’et accepterer query-string-filtre for at indsnævre resultatmængden. Det præcise sæt af filtre, der understøttes af hvert endepunkt, er angivet i afsnittet Parameters på endepunktets referenceside — beskrivelsen nedenfor dækker konventionerne, der bruges på tværs af dem alle.

Filtre for eksakt match

Filtrer efter en specifik feltværdi:

GET /api/v1/invoices/?status=open

GET /api/v1/accounts/?code=CUST001

Flere filtre kan kombineres; de forbindes med AND:

GET /api/v1/invoices/?status=due&collection_method=invoice

Sammenligningsfiltre

For numeriske felter og datofelter eksponerer Fenerum lookup-suffikser i Django-stil:

Dato-filtre accepterer ISO-datoer (YYYY-MM-DD).

Eksempel på datointerval

Hent fakturaer oprettet i december 2025:

GET /api/v1/invoices/?created_date__gte=2025-12-01&created_date__lt=2026-01-01

Negerede filtre

Nogle endepunkter eksponerer _not-varianter til eksklusionsforespørgsler. Tjek endepunktets Parameters for, hvad der er tilgængeligt, for eksempel på Fakturaer:

GET /api/v1/invoices/?status_not=paid&account_not=CUST001

Kombination med paginering

Filtre bevares på tværs af sider — next/previous-URL’erne i et pagineret svar viderefører dine filterparametre. Se Paginering for beskrivelsen af page/page_size-parametrene.

GET /api/v1/invoices/?account=CUST001&page=2&page_size=50

Feltet count i svaret afspejler det samlede filtrerede antal resultater, ikke det ufiltrerede totalantal.

Opslag efter alternativ identifikator

Et mindre sæt endepunkter (aktuelt Pakker og betingelser) accepterer en Lookup-Field HTTP header, der ændrer, hvordan identifikatoren i URL-stien fortolkes — nyttigt når du ikke har UUID’et, men kender ressourcens eksterne code:

GET /api/v1/plans/enterprise/
Lookup-Field: code

Tilladte værdier er dokumenteret på de berørte endepunkter (typisk uuid og code).

Bedste praksis

• Filtrer før paginering. Mindre resultatmængder er hurtigere og tæller mindre mod din rate limit.
• Brug ISO-datoer. Alle datofelter accepterer YYYY-MM-DD; nogle accepterer også ISO-dato/tid (YYYY-MM-DDTHH:MM:SSZ).
• Kontrollér endepunktets parametre. Filternavne varierer pr. ressource — blokken Parameters på hver operation angiver præcist, hvad der er tilgængeligt (kig efter det blå "query"-badge).