Offsys documentatie

Filter

Filter

Orders en klanten kun je filteren met de parameter filter. Een voorwaarde staat altijd tussen accolades, bijvoorbeeld {status=offerte}.

TekenBetekenis
=Is gelijk aan
^=Begint met
*=Bevat
$=Eindigt op
>Groter dan
<Kleiner dan
>=Groter dan of gelijk aan
<=Kleiner dan of gelijk aan

Combineren

Combineer voorwaarden met AND en OR. Gebruik haakjes om aan te geven wat bij elkaar hoort. Zonder haakjes gaat AND voor OR.

{status=factuur} AND ({date>=2026-01-01} OR {number^=2026})

Zet het filter in de URL:

curl "https://api.offsys.nl/orders" \
-G \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d" \
--data-urlencode "filter={status=factuur} AND {date>=2026-01-01}"

Klopt het filter niet, of gebruik je een veld dat hieronder niet staat, dan krijg je code 400.


Datums

Bij datumvelden kun je een datum (2026-06-12) of een datum met tijd (2026-06-12 10:00) gebruiken.

  • {date=2026-06-12} vindt alles op die dag.
  • {date<=2026-06-12} vindt alles tot en met het einde van die dag.
  • {date>=2026-06-12 10:00} vindt alles vanaf dat tijdstip.

Orders

VeldWaardeOmschrijving
numberTekstOrdernummer
dateDatumLeverdatum
statusTekstBijvoorbeeld aanvraag, offerte of factuur
customerGetalId van de klant
created_atDatumMoment van aanmaken
updated_atDatumMoment van de laatste wijziging

Klanten

VeldWaardeOmschrijving
nameTekstNaam
phoneTekstTelefoonnummer
emailTekstE-mailadres
postalTekstPostcode
placeTekstPlaats