v5

latestOpenAPI 3.0.3EUPL 1.2raw.githubusercontent.com2026-05-2769262387.9 KB
zaken

Werk een ZAAK deels bij.

Er wordt gevalideerd op

  • identificatie mag niet gewijzigd worden.
  • laatsteBetaaldatum mag niet in de toekomst liggen.
  • laatsteBetaaldatum mag niet gezet worden als de betalingsindicatie "nvt" is.
  • archiefnominatie moet een waarde hebben indien archiefstatus niet de waarde "nog_te_archiveren" heeft.
  • archiefactiedatum moet een waarde hebben indien archiefstatus niet de waarde "nog_te_archiveren" heeft.
  • archiefstatus kan alleen een waarde anders dan "nog_te_archiveren" hebben indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut status de waarde "gearchiveerd" heeft. Opmerkingen
  • er worden enkel zaken getoond van de zaaktypes waar u toe geautoriseerd bent.
  • indien een zaak heropend moet worden, doe dit dan door een nieuwe status toe te voegen die NIET de eindstatus is. Zie de Status resource.
patch/zaken/{uuid}

Path parameters

uuidstring uuid required

Unieke resource identifier (UUID4)

Headers

Content-Type'application/json' required

Content type van de verzoekinhoud.

X-NLX-Logrecord-IDstring

Identifier of the request, traceable throughout the network

X-Audit-Toelichtingstring

Toelichting waarom een bepaald verzoek wordt gedaan

Accept-Crs'EPSG:4326' required

Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84).

Content-Crs'EPSG:4326' required

Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84).

Request body

urlstring uri

URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.

uuidstring uuid

Unieke resource identifier (UUID4)

identificatiestring

De unieke identificatie van de ZAAK binnen de organisatie die verantwoordelijk is voor de behandeling van de ZAAK.

bronorganisatiestring

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef

omschrijvingstring

Een korte omschrijving van de zaak.

toelichtingstring

Een toelichting op de zaak.

zaaktypestring uri

URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS waar deze voorkomt

registratiedatumstring date

De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt.

verantwoordelijkeOrganisatiestring

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef

startdatumstring date

De datum waarop met de uitvoering van de zaak is gestart

einddatumstring date nullable

De datum waarop de uitvoering van de zaak afgerond is.

einddatumGeplandstring date nullable

De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt.

uiterlijkeEinddatumAfdoeningstring date nullable

De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn.

publicatiedatumstring date nullable

Datum waarop (het starten van) de zaak gepubliceerd is of wordt.

communicatiekanaalstring uri

Het medium waarlangs de aanleiding om een zaak te starten is ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van communicatiekanalen.

productenOfDienstenstring[]

De producten en/of diensten die door de zaak worden voortgebracht. Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld zijn.

vertrouwelijkheidaanduiding'openbaar' | 'beperkt_openbaar' | 'intern' | 'zaakvertrouwelijk' | 'vertrouwelijk' | 'confidentieel' | 'geheim' | 'zeer_geheim'
betalingsindicatieWeergavestring

Uitleg bij betalingsindicatie.

laatsteBetaaldatumstring date-time nullable

De datum waarop de meest recente betaling is verwerkt van kosten die gemoeid zijn met behandeling van de zaak.

selectielijstklassestring uri

URL-referentie naar de categorie in de gehanteerde 'Selectielijst Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de zaak, bepalend is voor het archiefregime van de zaak.

hoofdzaakstring uri nullable

URL-referentie naar de ZAAK, waarom verzocht is door de initiator daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan de onderhavige ZAAK er één is.

deelzakenstring[]

URL-referenties naar deel ZAAKen.

eigenschappenstring[]
rollenstring[]
statusstring uri nullable

Indien geen status bekend is, dan is de waarde 'null'

zaakinformatieobjectenstring[]
zaakobjectenstring[]
archiefstatus'nog_te_archiveren' | 'gearchiveerd' | 'gearchiveerd_procestermijn_onbekend' | 'overgedragen'
archiefactiedatumstring date nullable

De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg.

resultaatstring uri nullable

URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null'

opdrachtgevendeOrganisatiestring

De krachtens publiekrecht ingestelde rechtspersoon dan wel ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling geeft.

processobjectaardstring nullable

Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft.

startdatumBewaartermijnstring date nullable

De datum die de start markeert van de termijn waarop het zaakdossier vernietigd moet worden.

Response

OK

urlstring uri required

URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.

uuidstring uuid required

Unieke resource identifier (UUID4)

identificatiestring

De unieke identificatie van de ZAAK binnen de organisatie die verantwoordelijk is voor de behandeling van de ZAAK.

bronorganisatiestring required

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef

omschrijvingstring

Een korte omschrijving van de zaak.

toelichtingstring

Een toelichting op de zaak.

zaaktypestring uri required

URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS waar deze voorkomt

registratiedatumstring date

De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt.

verantwoordelijkeOrganisatiestring required

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef

startdatumstring date required

De datum waarop met de uitvoering van de zaak is gestart

einddatumstring date nullable required

De datum waarop de uitvoering van de zaak afgerond is.

einddatumGeplandstring date nullable

De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt.

uiterlijkeEinddatumAfdoeningstring date nullable

De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn.

publicatiedatumstring date nullable

Datum waarop (het starten van) de zaak gepubliceerd is of wordt.

communicatiekanaalstring uri

Het medium waarlangs de aanleiding om een zaak te starten is ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van communicatiekanalen.

productenOfDienstenstring[]

De producten en/of diensten die door de zaak worden voortgebracht. Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld zijn.

vertrouwelijkheidaanduiding'openbaar' | 'beperkt_openbaar' | 'intern' | 'zaakvertrouwelijk' | 'vertrouwelijk' | 'confidentieel' | 'geheim' | 'zeer_geheim'
betalingsindicatieWeergavestring required

Uitleg bij betalingsindicatie.

laatsteBetaaldatumstring date-time nullable

De datum waarop de meest recente betaling is verwerkt van kosten die gemoeid zijn met behandeling van de zaak.

selectielijstklassestring uri

URL-referentie naar de categorie in de gehanteerde 'Selectielijst Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de zaak, bepalend is voor het archiefregime van de zaak.

hoofdzaakstring uri nullable

URL-referentie naar de ZAAK, waarom verzocht is door de initiator daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan de onderhavige ZAAK er één is.

deelzakenstring[] required

URL-referenties naar deel ZAAKen.

eigenschappenstring[] required
rollenstring[] required
statusstring uri nullable required

Indien geen status bekend is, dan is de waarde 'null'

zaakinformatieobjectenstring[] required
zaakobjectenstring[] required
archiefstatus'nog_te_archiveren' | 'gearchiveerd' | 'gearchiveerd_procestermijn_onbekend' | 'overgedragen'
archiefactiedatumstring date nullable

De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg.

resultaatstring uri nullable required

URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null'

opdrachtgevendeOrganisatiestring

De krachtens publiekrecht ingestelde rechtspersoon dan wel ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling geeft.

processobjectaardstring nullable

Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft.

startdatumBewaartermijnstring date nullable

De datum die de start markeert van de termijn waarop het zaakdossier vernietigd moet worden.