diff --git a/Informatiedomeinen/Algemeen.yaml b/Informatiedomeinen/Algemeen.yaml
index d1f3b5f..52f6a4d 100644
--- a/Informatiedomeinen/Algemeen.yaml
+++ b/Informatiedomeinen/Algemeen.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://algemeen.vera.io:{port}/{basePath}
description: Productieserver
@@ -31,7 +31,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -47,7 +47,7 @@ paths:
get:
tags:
- 'ExtraAttributen'
- description: Ophalen van ExtraAttributen
+ summary: Ophalen van ExtraAttributen
operationId: listExtraAttributen
parameters:
- name: params
@@ -97,7 +97,7 @@ paths:
post:
tags:
- 'ExtraAttributen'
- description: Voegt een nieuw(e) ExtraAttribuut toe.
+ summary: Voegt een nieuw(e) ExtraAttribuut toe.
operationId: createExtraAttribuut
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
put:
tags:
- 'ExtraAttributen'
- description: |
+ summary: |
Vervangen van een ExtraAttribuut op basis van overeenkomstige sleutelvelden.
operationId: replaceExtraAttribuut
parameters:
@@ -172,7 +172,7 @@ paths:
patch:
tags:
- 'ExtraAttributen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExtraAttribuut. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExtraAttribuut
@@ -209,7 +209,7 @@ paths:
get:
tags:
- 'ExtraAttributen'
- description: Retourneert een ExtraAttribuut met de gegeven identifier
+ summary: Retourneert een ExtraAttribuut met de gegeven identifier
operationId: readExtraAttribuutById
parameters:
- name: id
@@ -246,7 +246,7 @@ paths:
put:
tags:
- 'ExtraAttributen'
- description: Vervangen van een ExtraAttribuut
+ summary: Vervangen van een ExtraAttribuut
operationId: replaceExtraAttribuutById
parameters:
- name: 'id'
@@ -284,7 +284,7 @@ paths:
patch:
tags:
- 'ExtraAttributen'
- description: Wijzigen van een ExtraAttribuut
+ summary: Wijzigen van een ExtraAttribuut
operationId: updateExtraAttribuutById
parameters:
- name: 'id'
@@ -323,7 +323,7 @@ paths:
get:
tags:
- 'Referentiedata'
- description: Ophalen van Referentiedata
+ summary: Ophalen van Referentiedata
operationId: listReferentiedata
parameters:
- name: params
@@ -373,7 +373,7 @@ paths:
post:
tags:
- 'Referentiedata'
- description: Voegt een nieuw(e) Referentiedata toe.
+ summary: Voegt een nieuw(e) Referentiedata toe.
operationId: createReferentiedata
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
put:
tags:
- 'Referentiedata'
- description: |
+ summary: |
Vervangen van een Referentiedata op basis van overeenkomstige sleutelvelden.
operationId: replaceReferentiedata
parameters:
@@ -448,7 +448,7 @@ paths:
patch:
tags:
- 'Referentiedata'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Referentiedata. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReferentiedata
@@ -485,7 +485,7 @@ paths:
get:
tags:
- 'Referentiedata'
- description: Retourneert een Referentiedata met de gegeven identifier
+ summary: Retourneert een Referentiedata met de gegeven identifier
operationId: readReferentiedataById
parameters:
- name: id
@@ -522,7 +522,7 @@ paths:
put:
tags:
- 'Referentiedata'
- description: Vervangen van een Referentiedata
+ summary: Vervangen van een Referentiedata
operationId: replaceReferentiedataById
parameters:
- name: 'id'
@@ -560,7 +560,7 @@ paths:
patch:
tags:
- 'Referentiedata'
- description: Wijzigen van een Referentiedata
+ summary: Wijzigen van een Referentiedata
operationId: updateReferentiedataById
parameters:
- name: 'id'
@@ -599,7 +599,7 @@ paths:
get:
tags:
- 'Sturingslabels'
- description: Ophalen van Sturingslabels
+ summary: Ophalen van Sturingslabels
operationId: listSturingslabels
parameters:
- name: params
@@ -649,7 +649,7 @@ paths:
post:
tags:
- 'Sturingslabels'
- description: Voegt een nieuw(e) Sturingslabel toe.
+ summary: Voegt een nieuw(e) Sturingslabel toe.
operationId: createSturingslabel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
put:
tags:
- 'Sturingslabels'
- description: |
+ summary: |
Vervangen van een Sturingslabel op basis van overeenkomstige sleutelvelden.
operationId: replaceSturingslabel
parameters:
@@ -724,7 +724,7 @@ paths:
patch:
tags:
- 'Sturingslabels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Sturingslabel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSturingslabel
@@ -761,7 +761,7 @@ paths:
get:
tags:
- 'Sturingslabels'
- description: Retourneert een Sturingslabel met de gegeven identifier
+ summary: Retourneert een Sturingslabel met de gegeven identifier
operationId: readSturingslabelById
parameters:
- name: id
@@ -798,7 +798,7 @@ paths:
put:
tags:
- 'Sturingslabels'
- description: Vervangen van een Sturingslabel
+ summary: Vervangen van een Sturingslabel
operationId: replaceSturingslabelById
parameters:
- name: 'id'
@@ -836,7 +836,7 @@ paths:
patch:
tags:
- 'Sturingslabels'
- description: Wijzigen van een Sturingslabel
+ summary: Wijzigen van een Sturingslabel
operationId: updateSturingslabelById
parameters:
- name: 'id'
@@ -908,10 +908,22 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Algemeen.All.Read: alleen lezen van alle resources
+ Algemeen.All.ReadWrite: lezen en schrijven van alle resources
+ Algemeen.ExtraAttributen.Read: alleen lezen van ExtraAttributen
+ Algemeen.ExtraAttributen.ReadWrite: lezen en schrijven van ExtraAttributen
+ Algemeen.Referentiedata.Read: alleen lezen van Referentiedata
+ Algemeen.Referentiedata.ReadWrite: lezen en schrijven van Referentiedata
+ Algemeen.Sturingslabels.Read: alleen lezen van Sturingslabels
+ Algemeen.Sturingslabels.ReadWrite: lezen en schrijven van Sturingslabels
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Algemeen.All.Read: alleen lezen van alle resources
Algemeen.All.ReadWrite: lezen en schrijven van alle resources
@@ -970,7 +982,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -982,7 +994,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
diff --git a/Informatiedomeinen/Dossier.yaml b/Informatiedomeinen/Dossier.yaml
index 38d95dd..1aefd32 100644
--- a/Informatiedomeinen/Dossier.yaml
+++ b/Informatiedomeinen/Dossier.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://dossier.vera.io:{port}/{basePath}
description: Productieserver
@@ -22,6 +22,8 @@ servers:
basePath:
default: v4
tags:
+- name: AuthentiekeGegevens
+ description: Operaties met betrekking tot een AuthentiekGegeven
- name: Dossiers
description: Operaties met betrekking tot een Dossier
- name: Informatieobjecten
@@ -49,7 +51,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -61,11 +63,287 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Foutbericht'
+ /authentieke-gegevens:
+ get:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Ophalen van AuthentiekeGegevens
+ operationId: listAuthentiekeGegevens
+ parameters:
+ - name: params
+ in: query
+ style: form
+ explode: true
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ - $ref: '#/components/parameters/Cursor'
+ - $ref: '#/components/parameters/Pagina'
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ - $ref: '#/components/parameters/ParametersPeiltijdstipMaterieel'
+ - $ref: '#/components/parameters/ParametersAantalPerPagina'
+ responses:
+ '200':
+ description: OK
+ content:
+ 'application/json':
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ headers:
+ X-Parameters-Aantal:
+ $ref: '#/components/headers/X-Parameters-Aantal'
+ X-Parameters-AantalPerPagina:
+ $ref: '#/components/headers/X-Parameters-AantalPerPagina'
+ X-Parameters-Pagina:
+ $ref: '#/components/headers/X-Parameters-Pagina'
+ X-Parameters-Cursor:
+ $ref: '#/components/headers/X-Parameters-Cursor'
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ default:
+ description: Onverwachte fout
+ content:
+ 'application/json':
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.Read
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ post:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Voegt een nieuw(e) AuthentiekGegeven toe.
+ operationId: createAuthentiekGegeven
+ parameters:
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '201':
+ description: Created
+ headers:
+ Location:
+ schema:
+ type: string
+ format: uri
+ description: URL waar de resource leeft.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ put:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: |
+ Vervangen van een AuthentiekGegeven op basis van overeenkomstige sleutelvelden.
+ operationId: replaceAuthentiekGegeven
+ parameters:
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '200':
+ description: OK
+ '400':
+ description: Bad Request
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ patch:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: |
+ Wijzigen van afzonderlijke attributen van een AuthentiekGegeven. In de meegestuurde entiteit moeten
+ sleutelvelden aanwezig zijn.
+ operationId: updateAuthentiekGegeven
+ parameters:
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '200':
+ description: OK
+ '400':
+ description: Bad Request
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ /authentieke-gegevens/{id}:
+ get:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Retourneert een AuthentiekGegeven met de gegeven identifier
+ operationId: readAuthentiekGegevenById
+ parameters:
+ - name: id
+ in: path
+ description: Id van AuthentiekGegeven om op te halen
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.Read
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ put:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Vervangen van een AuthentiekGegeven
+ operationId: replaceAuthentiekGegevenById
+ parameters:
+ - name: 'id'
+ in: 'path'
+ description: Id van AuthentiekGegeven om te vervangen
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ responses:
+ '200':
+ description: OK
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ patch:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Wijzigen van een AuthentiekGegeven
+ operationId: updateAuthentiekGegevenById
+ parameters:
+ - name: 'id'
+ in: 'path'
+ description: Id van AuthentiekGegeven om te wijzigen
+ required: true
+ schema:
+ type: integer
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '200':
+ description: OK
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
/dossiers:
get:
tags:
- 'Dossiers'
- description: Ophalen van Dossiers
+ summary: Ophalen van Dossiers
operationId: listDossiers
parameters:
- name: params
@@ -115,7 +393,7 @@ paths:
post:
tags:
- 'Dossiers'
- description: Voegt een nieuw(e) Dossier toe.
+ summary: Voegt een nieuw(e) Dossier toe.
operationId: createDossier
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -155,7 +433,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: |
+ summary: |
Vervangen van een Dossier op basis van overeenkomstige sleutelvelden.
operationId: replaceDossier
parameters:
@@ -190,7 +468,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Dossier. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDossier
@@ -227,7 +505,7 @@ paths:
get:
tags:
- 'Dossiers'
- description: Retourneert een Dossier met de gegeven identifier
+ summary: Retourneert een Dossier met de gegeven identifier
operationId: readDossierById
parameters:
- name: id
@@ -264,7 +542,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: Vervangen van een Dossier
+ summary: Vervangen van een Dossier
operationId: replaceDossierById
parameters:
- name: 'id'
@@ -302,7 +580,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: Wijzigen van een Dossier
+ summary: Wijzigen van een Dossier
operationId: updateDossierById
parameters:
- name: 'id'
@@ -341,7 +619,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Ophalen van Informatieobjecten
+ summary: Ophalen van Informatieobjecten
operationId: listInformatieobjecten
parameters:
- name: params
@@ -391,7 +669,7 @@ paths:
post:
tags:
- 'Informatieobjecten'
- description: Voegt een nieuw(e) Informatieobject toe.
+ summary: Voegt een nieuw(e) Informatieobject toe.
operationId: createInformatieobject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -431,7 +709,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Vervangen van een Informatieobject op basis van overeenkomstige sleutelvelden.
operationId: replaceInformatieobject
parameters:
@@ -466,7 +744,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Informatieobject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInformatieobject
@@ -503,7 +781,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Retourneert een Informatieobject met de gegeven identifier
+ summary: Retourneert een Informatieobject met de gegeven identifier
operationId: readInformatieobjectById
parameters:
- name: id
@@ -540,7 +818,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: Vervangen van een Informatieobject
+ summary: Vervangen van een Informatieobject
operationId: replaceInformatieobjectById
parameters:
- name: 'id'
@@ -578,7 +856,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: Wijzigen van een Informatieobject
+ summary: Wijzigen van een Informatieobject
operationId: updateInformatieobjectById
parameters:
- name: 'id'
@@ -617,7 +895,7 @@ paths:
get:
tags:
- 'Informatieobjectkenmerken'
- description: Ophalen van Informatieobjectkenmerken
+ summary: Ophalen van Informatieobjectkenmerken
operationId: listInformatieobjectkenmerken
parameters:
- name: params
@@ -667,7 +945,7 @@ paths:
post:
tags:
- 'Informatieobjectkenmerken'
- description: Voegt een nieuw(e) Informatieobjectkenmerk toe.
+ summary: Voegt een nieuw(e) Informatieobjectkenmerk toe.
operationId: createInformatieobjectkenmerk
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -707,7 +985,7 @@ paths:
put:
tags:
- 'Informatieobjectkenmerken'
- description: |
+ summary: |
Vervangen van een Informatieobjectkenmerk op basis van overeenkomstige sleutelvelden.
operationId: replaceInformatieobjectkenmerk
parameters:
@@ -742,7 +1020,7 @@ paths:
patch:
tags:
- 'Informatieobjectkenmerken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Informatieobjectkenmerk. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInformatieobjectkenmerk
@@ -779,7 +1057,7 @@ paths:
get:
tags:
- 'Informatieobjectkenmerken'
- description: Retourneert een Informatieobjectkenmerk met de gegeven identifier
+ summary: Retourneert een Informatieobjectkenmerk met de gegeven identifier
operationId: readInformatieobjectkenmerkById
parameters:
- name: id
@@ -816,7 +1094,7 @@ paths:
put:
tags:
- 'Informatieobjectkenmerken'
- description: Vervangen van een Informatieobjectkenmerk
+ summary: Vervangen van een Informatieobjectkenmerk
operationId: replaceInformatieobjectkenmerkById
parameters:
- name: 'id'
@@ -854,7 +1132,7 @@ paths:
patch:
tags:
- 'Informatieobjectkenmerken'
- description: Wijzigen van een Informatieobjectkenmerk
+ summary: Wijzigen van een Informatieobjectkenmerk
operationId: updateInformatieobjectkenmerkById
parameters:
- name: 'id'
@@ -893,7 +1171,7 @@ paths:
get:
tags:
- 'Processen'
- description: Ophalen van Processen
+ summary: Ophalen van Processen
operationId: listProcessen
parameters:
- name: params
@@ -943,7 +1221,7 @@ paths:
post:
tags:
- 'Processen'
- description: Voegt een nieuw(e) Proces toe.
+ summary: Voegt een nieuw(e) Proces toe.
operationId: createProces
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -983,7 +1261,7 @@ paths:
put:
tags:
- 'Processen'
- description: |
+ summary: |
Vervangen van een Proces op basis van overeenkomstige sleutelvelden.
operationId: replaceProces
parameters:
@@ -1018,7 +1296,7 @@ paths:
patch:
tags:
- 'Processen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Proces. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProces
@@ -1055,7 +1333,7 @@ paths:
get:
tags:
- 'Processen'
- description: Retourneert een Proces met de gegeven identifier
+ summary: Retourneert een Proces met de gegeven identifier
operationId: readProcesById
parameters:
- name: id
@@ -1092,7 +1370,7 @@ paths:
put:
tags:
- 'Processen'
- description: Vervangen van een Proces
+ summary: Vervangen van een Proces
operationId: replaceProcesById
parameters:
- name: 'id'
@@ -1130,7 +1408,7 @@ paths:
patch:
tags:
- 'Processen'
- description: Wijzigen van een Proces
+ summary: Wijzigen van een Proces
operationId: updateProcesById
parameters:
- name: 'id'
@@ -1169,7 +1447,7 @@ paths:
get:
tags:
- 'Procesrollen'
- description: Ophalen van Procesrollen
+ summary: Ophalen van Procesrollen
operationId: listProcesrollen
parameters:
- name: params
@@ -1219,7 +1497,7 @@ paths:
post:
tags:
- 'Procesrollen'
- description: Voegt een nieuw(e) Procesrol toe.
+ summary: Voegt een nieuw(e) Procesrol toe.
operationId: createProcesrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1259,7 +1537,7 @@ paths:
put:
tags:
- 'Procesrollen'
- description: |
+ summary: |
Vervangen van een Procesrol op basis van overeenkomstige sleutelvelden.
operationId: replaceProcesrol
parameters:
@@ -1294,7 +1572,7 @@ paths:
patch:
tags:
- 'Procesrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Procesrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProcesrol
@@ -1331,7 +1609,7 @@ paths:
get:
tags:
- 'Procesrollen'
- description: Retourneert een Procesrol met de gegeven identifier
+ summary: Retourneert een Procesrol met de gegeven identifier
operationId: readProcesrolById
parameters:
- name: id
@@ -1368,7 +1646,7 @@ paths:
put:
tags:
- 'Procesrollen'
- description: Vervangen van een Procesrol
+ summary: Vervangen van een Procesrol
operationId: replaceProcesrolById
parameters:
- name: 'id'
@@ -1406,7 +1684,7 @@ paths:
patch:
tags:
- 'Procesrollen'
- description: Wijzigen van een Procesrol
+ summary: Wijzigen van een Procesrol
operationId: updateProcesrolById
parameters:
- name: 'id'
@@ -1445,7 +1723,7 @@ paths:
get:
tags:
- 'Processtappen'
- description: Ophalen van Processtappen
+ summary: Ophalen van Processtappen
operationId: listProcesstappen
parameters:
- name: params
@@ -1495,7 +1773,7 @@ paths:
post:
tags:
- 'Processtappen'
- description: Voegt een nieuw(e) Processtap toe.
+ summary: Voegt een nieuw(e) Processtap toe.
operationId: createProcesstap
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1535,7 +1813,7 @@ paths:
put:
tags:
- 'Processtappen'
- description: |
+ summary: |
Vervangen van een Processtap op basis van overeenkomstige sleutelvelden.
operationId: replaceProcesstap
parameters:
@@ -1570,7 +1848,7 @@ paths:
patch:
tags:
- 'Processtappen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Processtap. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProcesstap
@@ -1607,7 +1885,7 @@ paths:
get:
tags:
- 'Processtappen'
- description: Retourneert een Processtap met de gegeven identifier
+ summary: Retourneert een Processtap met de gegeven identifier
operationId: readProcesstapById
parameters:
- name: id
@@ -1644,7 +1922,7 @@ paths:
put:
tags:
- 'Processtappen'
- description: Vervangen van een Processtap
+ summary: Vervangen van een Processtap
operationId: replaceProcesstapById
parameters:
- name: 'id'
@@ -1682,7 +1960,7 @@ paths:
patch:
tags:
- 'Processtappen'
- description: Wijzigen van een Processtap
+ summary: Wijzigen van een Processtap
operationId: updateProcesstapById
parameters:
- name: 'id'
@@ -1721,7 +1999,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Ophalen van Zaken
+ summary: Ophalen van Zaken
operationId: listZaken
parameters:
- name: params
@@ -1771,7 +2049,7 @@ paths:
post:
tags:
- 'Zaken'
- description: Voegt een nieuw(e) Zaak toe.
+ summary: Voegt een nieuw(e) Zaak toe.
operationId: createZaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1811,7 +2089,7 @@ paths:
put:
tags:
- 'Zaken'
- description: |
+ summary: |
Vervangen van een Zaak op basis van overeenkomstige sleutelvelden.
operationId: replaceZaak
parameters:
@@ -1846,7 +2124,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaak
@@ -1883,7 +2161,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Retourneert een Zaak met de gegeven identifier
+ summary: Retourneert een Zaak met de gegeven identifier
operationId: readZaakById
parameters:
- name: id
@@ -1920,7 +2198,7 @@ paths:
put:
tags:
- 'Zaken'
- description: Vervangen van een Zaak
+ summary: Vervangen van een Zaak
operationId: replaceZaakById
parameters:
- name: 'id'
@@ -1958,7 +2236,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: Wijzigen van een Zaak
+ summary: Wijzigen van een Zaak
operationId: updateZaakById
parameters:
- name: 'id'
@@ -1997,7 +2275,7 @@ paths:
get:
tags:
- 'Zaakkenmerken'
- description: Ophalen van Zaakkenmerken
+ summary: Ophalen van Zaakkenmerken
operationId: listZaakkenmerken
parameters:
- name: params
@@ -2047,7 +2325,7 @@ paths:
post:
tags:
- 'Zaakkenmerken'
- description: Voegt een nieuw(e) Zaakkenmerk toe.
+ summary: Voegt een nieuw(e) Zaakkenmerk toe.
operationId: createZaakkenmerk
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2087,7 +2365,7 @@ paths:
put:
tags:
- 'Zaakkenmerken'
- description: |
+ summary: |
Vervangen van een Zaakkenmerk op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakkenmerk
parameters:
@@ -2122,7 +2400,7 @@ paths:
patch:
tags:
- 'Zaakkenmerken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakkenmerk. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakkenmerk
@@ -2159,7 +2437,7 @@ paths:
get:
tags:
- 'Zaakkenmerken'
- description: Retourneert een Zaakkenmerk met de gegeven identifier
+ summary: Retourneert een Zaakkenmerk met de gegeven identifier
operationId: readZaakkenmerkById
parameters:
- name: id
@@ -2196,7 +2474,7 @@ paths:
put:
tags:
- 'Zaakkenmerken'
- description: Vervangen van een Zaakkenmerk
+ summary: Vervangen van een Zaakkenmerk
operationId: replaceZaakkenmerkById
parameters:
- name: 'id'
@@ -2234,7 +2512,7 @@ paths:
patch:
tags:
- 'Zaakkenmerken'
- description: Wijzigen van een Zaakkenmerk
+ summary: Wijzigen van een Zaakkenmerk
operationId: updateZaakkenmerkById
parameters:
- name: 'id'
@@ -2273,7 +2551,7 @@ paths:
get:
tags:
- 'Zaakobjecten'
- description: Ophalen van Zaakobjecten
+ summary: Ophalen van Zaakobjecten
operationId: listZaakobjecten
parameters:
- name: params
@@ -2323,7 +2601,7 @@ paths:
post:
tags:
- 'Zaakobjecten'
- description: Voegt een nieuw(e) Zaakobject toe.
+ summary: Voegt een nieuw(e) Zaakobject toe.
operationId: createZaakobject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2363,7 +2641,7 @@ paths:
put:
tags:
- 'Zaakobjecten'
- description: |
+ summary: |
Vervangen van een Zaakobject op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakobject
parameters:
@@ -2398,7 +2676,7 @@ paths:
patch:
tags:
- 'Zaakobjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakobject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakobject
@@ -2435,7 +2713,7 @@ paths:
get:
tags:
- 'Zaakobjecten'
- description: Retourneert een Zaakobject met de gegeven identifier
+ summary: Retourneert een Zaakobject met de gegeven identifier
operationId: readZaakobjectById
parameters:
- name: id
@@ -2472,7 +2750,7 @@ paths:
put:
tags:
- 'Zaakobjecten'
- description: Vervangen van een Zaakobject
+ summary: Vervangen van een Zaakobject
operationId: replaceZaakobjectById
parameters:
- name: 'id'
@@ -2510,7 +2788,7 @@ paths:
patch:
tags:
- 'Zaakobjecten'
- description: Wijzigen van een Zaakobject
+ summary: Wijzigen van een Zaakobject
operationId: updateZaakobjectById
parameters:
- name: 'id'
@@ -2549,7 +2827,7 @@ paths:
get:
tags:
- 'Zaakrollen'
- description: Ophalen van Zaakrollen
+ summary: Ophalen van Zaakrollen
operationId: listZaakrollen
parameters:
- name: params
@@ -2599,7 +2877,7 @@ paths:
post:
tags:
- 'Zaakrollen'
- description: Voegt een nieuw(e) Zaakrol toe.
+ summary: Voegt een nieuw(e) Zaakrol toe.
operationId: createZaakrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2639,7 +2917,7 @@ paths:
put:
tags:
- 'Zaakrollen'
- description: |
+ summary: |
Vervangen van een Zaakrol op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakrol
parameters:
@@ -2674,7 +2952,7 @@ paths:
patch:
tags:
- 'Zaakrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakrol
@@ -2711,7 +2989,7 @@ paths:
get:
tags:
- 'Zaakrollen'
- description: Retourneert een Zaakrol met de gegeven identifier
+ summary: Retourneert een Zaakrol met de gegeven identifier
operationId: readZaakrolById
parameters:
- name: id
@@ -2748,7 +3026,7 @@ paths:
put:
tags:
- 'Zaakrollen'
- description: Vervangen van een Zaakrol
+ summary: Vervangen van een Zaakrol
operationId: replaceZaakrolById
parameters:
- name: 'id'
@@ -2786,7 +3064,7 @@ paths:
patch:
tags:
- 'Zaakrollen'
- description: Wijzigen van een Zaakrol
+ summary: Wijzigen van een Zaakrol
operationId: updateZaakrolById
parameters:
- name: 'id'
@@ -2825,7 +3103,7 @@ paths:
get:
tags:
- 'Zaakstatussen'
- description: Ophalen van Zaakstatussen
+ summary: Ophalen van Zaakstatussen
operationId: listZaakstatussen
parameters:
- name: params
@@ -2875,7 +3153,7 @@ paths:
post:
tags:
- 'Zaakstatussen'
- description: Voegt een nieuw(e) Zaakstatus toe.
+ summary: Voegt een nieuw(e) Zaakstatus toe.
operationId: createZaakstatus
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2915,7 +3193,7 @@ paths:
put:
tags:
- 'Zaakstatussen'
- description: |
+ summary: |
Vervangen van een Zaakstatus op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakstatus
parameters:
@@ -2950,7 +3228,7 @@ paths:
patch:
tags:
- 'Zaakstatussen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakstatus. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakstatus
@@ -2987,7 +3265,7 @@ paths:
get:
tags:
- 'Zaakstatussen'
- description: Retourneert een Zaakstatus met de gegeven identifier
+ summary: Retourneert een Zaakstatus met de gegeven identifier
operationId: readZaakstatusById
parameters:
- name: id
@@ -3024,7 +3302,7 @@ paths:
put:
tags:
- 'Zaakstatussen'
- description: Vervangen van een Zaakstatus
+ summary: Vervangen van een Zaakstatus
operationId: replaceZaakstatusById
parameters:
- name: 'id'
@@ -3062,7 +3340,7 @@ paths:
patch:
tags:
- 'Zaakstatussen'
- description: Wijzigen van een Zaakstatus
+ summary: Wijzigen van een Zaakstatus
operationId: updateZaakstatusById
parameters:
- name: 'id'
@@ -3101,7 +3379,7 @@ paths:
get:
tags:
- 'Zaaktypen'
- description: Ophalen van Zaaktypen
+ summary: Ophalen van Zaaktypen
operationId: listZaaktypen
parameters:
- name: params
@@ -3151,7 +3429,7 @@ paths:
post:
tags:
- 'Zaaktypen'
- description: Voegt een nieuw(e) Zaaktype toe.
+ summary: Voegt een nieuw(e) Zaaktype toe.
operationId: createZaaktype
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3191,7 +3469,7 @@ paths:
put:
tags:
- 'Zaaktypen'
- description: |
+ summary: |
Vervangen van een Zaaktype op basis van overeenkomstige sleutelvelden.
operationId: replaceZaaktype
parameters:
@@ -3226,7 +3504,7 @@ paths:
patch:
tags:
- 'Zaaktypen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaaktype. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaaktype
@@ -3263,7 +3541,7 @@ paths:
get:
tags:
- 'Zaaktypen'
- description: Retourneert een Zaaktype met de gegeven identifier
+ summary: Retourneert een Zaaktype met de gegeven identifier
operationId: readZaaktypeById
parameters:
- name: id
@@ -3300,7 +3578,7 @@ paths:
put:
tags:
- 'Zaaktypen'
- description: Vervangen van een Zaaktype
+ summary: Vervangen van een Zaaktype
operationId: replaceZaaktypeById
parameters:
- name: 'id'
@@ -3338,7 +3616,7 @@ paths:
patch:
tags:
- 'Zaaktypen'
- description: Wijzigen van een Zaaktype
+ summary: Wijzigen van een Zaaktype
operationId: updateZaaktypeById
parameters:
- name: 'id'
@@ -3410,13 +3688,16 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
scopes:
Dossier.All.Read: alleen lezen van alle resources
Dossier.All.ReadWrite: lezen en schrijven van alle resources
+ Dossier.AuthentiekeGegevens.Read: alleen lezen van AuthentiekeGegevens
+ Dossier.AuthentiekeGegevens.ReadWrite: lezen en schrijven van AuthentiekeGegevens
Dossier.Dossiers.Read: alleen lezen van Dossiers
Dossier.Dossiers.ReadWrite: lezen en schrijven van Dossiers
Dossier.Informatieobjecten.Read: alleen lezen van Informatieobjecten
@@ -3441,19 +3722,50 @@ components:
Dossier.Zaakstatussen.ReadWrite: lezen en schrijven van Zaakstatussen
Dossier.Zaaktypen.Read: alleen lezen van Zaaktypen
Dossier.Zaaktypen.ReadWrite: lezen en schrijven van Zaaktypen
- responses:
- NietGeautoriseerd:
- description: Unauthorized
- headers:
- X-API-KEY:
- schema:
+ clientCredentials:
+ tokenUrl: /oauth/token
+ scopes:
+ Dossier.All.Read: alleen lezen van alle resources
+ Dossier.All.ReadWrite: lezen en schrijven van alle resources
+ Dossier.AuthentiekeGegevens.Read: alleen lezen van AuthentiekeGegevens
+ Dossier.AuthentiekeGegevens.ReadWrite: lezen en schrijven van AuthentiekeGegevens
+ Dossier.Dossiers.Read: alleen lezen van Dossiers
+ Dossier.Dossiers.ReadWrite: lezen en schrijven van Dossiers
+ Dossier.Informatieobjecten.Read: alleen lezen van Informatieobjecten
+ Dossier.Informatieobjecten.ReadWrite: lezen en schrijven van Informatieobjecten
+ Dossier.Informatieobjectkenmerken.Read: alleen lezen van Informatieobjectkenmerken
+ Dossier.Informatieobjectkenmerken.ReadWrite: lezen en schrijven van Informatieobjectkenmerken
+ Dossier.Processen.Read: alleen lezen van Processen
+ Dossier.Processen.ReadWrite: lezen en schrijven van Processen
+ Dossier.Procesrollen.Read: alleen lezen van Procesrollen
+ Dossier.Procesrollen.ReadWrite: lezen en schrijven van Procesrollen
+ Dossier.Processtappen.Read: alleen lezen van Processtappen
+ Dossier.Processtappen.ReadWrite: lezen en schrijven van Processtappen
+ Dossier.Zaken.Read: alleen lezen van Zaken
+ Dossier.Zaken.ReadWrite: lezen en schrijven van Zaken
+ Dossier.Zaakkenmerken.Read: alleen lezen van Zaakkenmerken
+ Dossier.Zaakkenmerken.ReadWrite: lezen en schrijven van Zaakkenmerken
+ Dossier.Zaakobjecten.Read: alleen lezen van Zaakobjecten
+ Dossier.Zaakobjecten.ReadWrite: lezen en schrijven van Zaakobjecten
+ Dossier.Zaakrollen.Read: alleen lezen van Zaakrollen
+ Dossier.Zaakrollen.ReadWrite: lezen en schrijven van Zaakrollen
+ Dossier.Zaakstatussen.Read: alleen lezen van Zaakstatussen
+ Dossier.Zaakstatussen.ReadWrite: lezen en schrijven van Zaakstatussen
+ Dossier.Zaaktypen.Read: alleen lezen van Zaaktypen
+ Dossier.Zaaktypen.ReadWrite: lezen en schrijven van Zaaktypen
+ responses:
+ NietGeautoriseerd:
+ description: Unauthorized
+ headers:
+ X-API-KEY:
+ schema:
type: string
schemas:
- Dossierbericht:
+ AuthentiekGegevenbericht:
allOf:
- - $ref: '#/components/schemas/Dossier'
+ - $ref: '#/components/schemas/AuthentiekGegeven'
- $ref: '#/components/schemas/Bericht-basis'
- Dossier:
+ AuthentiekGegeven:
type: object
properties:
id:
@@ -3468,124 +3780,38 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Geeft het dossier type aan. Bijvoorbeeld mutatiedossier. Referentiedatasoort DOSSIERSOORT.
- detailSoort:
+ description: Geeft het gegevens type aan. Bijvoorbeeld geregistreerde inkomens, actueel inkomen, woongeschiedenis, naw. Referentiedatasoort AUTHENTIEKGEGEVENSOORT.
+ bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Geeft het dossier detail type aan. Referentiedatasoort DOSSIERDETAILSOORT.
- omschrijving:
- type: string
- format: any
- description: Beknopte omschrijving van het dossier.
- bovenliggendDossier:
- allOf:
- - $ref: '#/components/schemas/Dossier-sleutels'
- description: Het dossier waarin dit dossier is opgenomen.
+ description: Geeft de bron van het gegeven aan. Bijv. MijnOverheid, Qii, IRF etc. Referentiedatasoort AUTHENTIEKGEGEVENBRONSOORT.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt (Bijvoorbeeld 'Gearchiveerd'). Referentiedatasoort DOSSIERSTATUS.
+ description: De De status van het gegeven. Bijv. Gevalideerd, Vervallen. Referentiedatasoort AUTHENTIEKGEGEVENSTATUS.
begindatum:
type: string
format: date-time
- description: De datum waarop het dossier gevormd is.
+ description: De datum waarop de gevalideerde gegevens zijn vastgelegd.
einddatum:
type: string
format: date-time
- description: De datum waarop het dossier afgesloten is.
- archiefActiedatum:
+ description: De datum waarop gevalideerde gegevens verlopen of er nieuwe gegevens zijn ingegaan (gevalideerd of zelf ingevuld).
+ gegevens:
type: string
- format: date-time
- description: De datum waarop het dossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
- archiefnominatie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding of de informatieobjecten binnen het dossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
- clusters:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
- collectiefObjecten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
- contactmomenten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- deelDossiers:
- description: Het dossier bevat onderliggende dossier(s).
- type: array
- items:
- $ref: '#/components/schemas/Dossier-sleutels'
- detailStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Detaillering van de fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt. Referentiedatasoort DOSSIERDETAILSTATUS.
- eenheden:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
- inkoopfacturen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Factuur in informatiedomein Financien
- inkoopopdrachten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- objecten:
- description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
- type: array
- items:
- $ref: '#/components/schemas/Zaakobject'
- onderhoudsverzoeken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- processen:
- description: Het dossier is gekoppeld aan/heeft betrekking op proces(sen).
- type: array
- items:
- $ref: '#/components/schemas/Proces'
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- zaken:
- description: Zaken die gekoppeld zijn aan dit dossier.
- type: array
- items:
- $ref: '#/components/schemas/Zaak'
+ format: any
+ description: De ruwe gegevens zoals ze uit de bron zijn opgehaald.
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor de gegevens geldig zijn.
+ token:
+ type: string
+ format: any
+ description: Een eigen validatietoken op de gegevens.
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -3612,7 +3838,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -3624,7 +3850,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -3660,49 +3886,11 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Dossier-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Zaakobjectbericht:
- allOf:
- - $ref: '#/components/schemas/Zaakobject'
- - $ref: '#/components/schemas/Bericht-basis'
- Zaakobject:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort gegevensobject. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc. Referentiedatasoort ZAAKOBJECTSOORT.
- Procesbericht:
+ Dossierbericht:
allOf:
- - $ref: '#/components/schemas/Proces'
+ - $ref: '#/components/schemas/Dossier'
- $ref: '#/components/schemas/Bericht-basis'
- Proces:
+ Dossier:
type: object
properties:
id:
@@ -3724,114 +3912,118 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De omschrijving en definitie van het proces (bijvoorbeeld aanbieden woning). Referentiedatasoort PROCESSOORT.
- bovenliggendProces:
+ description: Geeft het dossier type aan. Bijvoorbeeld mutatiedossier. Referentiedatasoort DOSSIERSOORT.
+ detailSoort:
allOf:
- - $ref: '#/components/schemas/Proces-sleutels'
- description: Specificeert het bijbehorende hoofdproces.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft het dossier detail type aan. Referentiedatasoort DOSSIERDETAILSOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: Beknopte omschrijving van het dossier.
+ bovenliggendDossier:
+ allOf:
+ - $ref: '#/components/schemas/Dossier-sleutels'
+ description: Het dossier waarin dit dossier is opgenomen.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De status van de proces. Bijvoorbeeld;In behandeling, Afgesloten. Referentiedatasoort PROCESSTATUS.
+ description: De fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt (Bijvoorbeeld 'Gearchiveerd'). Referentiedatasoort DOSSIERSTATUS.
begindatum:
type: string
format: date-time
- description: Datum en tijd waarop het proces gestart is.
+ description: De datum waarop het dossier gevormd is.
einddatum:
type: string
format: date-time
- description: Datum en tijd waarop het proces afgesloten is.
- verloopdatum:
+ description: De datum waarop het dossier afgesloten is.
+ archiefActiedatum:
type: string
format: date-time
- description: Datum en tijd waarop het proces afgerond zou moeten zijn.
+ description: De datum waarop het dossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
+ archiefnominatie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Aanduiding of de informatieobjecten binnen het dossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObjecten:
type: array
items:
type: string
format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
- deelprocessen:
- description: Specificeert de bijbehorende deelprocessen.
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
+ contactmomenten:
type: array
items:
- $ref: '#/components/schemas/Proces-sleutels'
- dossiers:
- description: Het proces is gekoppeld aan/heeft betrekking op dossier(s).
+ type: string
+ format: uri
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ deelDossiers:
+ description: Het dossier bevat onderliggende dossier(s).
type: array
items:
$ref: '#/components/schemas/Dossier-sleutels'
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detaillering van de fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt. Referentiedatasoort DOSSIERDETAILSTATUS.
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
inkoopfacturen:
type: array
items:
type: string
format: uri
- description: Referenties naar Factuur in informatiedomein Financien
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
inkoopopdrachten:
type: array
items:
type: string
format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- niveau:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Specificeert het niveau van het proces. Bijvoorbeeld ketenproces, bedrijfsproces en werkproces. Referentiedatasoort PROCESNIVEAU.
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
objecten:
description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
type: array
items:
- $ref: '#/components/schemas/Zaakobject'
+ $ref: '#/components/schemas/Zaakobject-sleutels'
onderhoudsverzoeken:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- prioriteit:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Prioriteit van het proces. Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
- processtappen:
- description: De taken/stappen die behoren bij het proces.
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ processen:
+ description: Het dossier is gekoppeld aan/heeft betrekking op proces(sen).
type: array
items:
- $ref: '#/components/schemas/Processtap'
+ $ref: '#/components/schemas/Proces-sleutels'
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- rollen:
- description: De rol(len) die een relatie uitoefent ten opzichte van het proces.
- type: array
- items:
- $ref: '#/components/schemas/Procesrol'
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
zaken:
- description: Het proces is gekoppeld aan/heeft betrekking op zaak(-en).
+ description: Zaken die gekoppeld zijn aan dit dossier.
type: array
items:
- $ref: '#/components/schemas/Zaak'
- Proces-sleutels:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Dossier-sleutels:
type: object
properties:
id:
@@ -3850,80 +4042,18 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Processtapbericht:
- allOf:
- - $ref: '#/components/schemas/Processtap'
- - $ref: '#/components/schemas/Bericht-basis'
- Processtap:
+ Zaakobject-sleutels:
type: object
properties:
id:
type: string
format: any
description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De omschrijving en definitie van de processtap. Bijvoorbeeld keur inkoopfactuur goed of controleer huuropzegging. Referentiedatasoort PROCESSTAPSOORT.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de processtap. Bijvoorbeeld;In behandeling, Wachtstand, Afgerond. Referentiedatasoort PROCESSTAPSTATUS.
- begindatum:
- type: string
- format: date-time
- description: Datum en tijd waarop de processtap gestart is.
- einddatum:
- type: string
- format: date-time
- description: Datum en tijd waarop de processtap afgesloten is.
- verloopdatum:
- type: string
- format: date-time
- description: Datum en tijd waarop de processtap afgerond zou moeten zijn.
- actie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Actie die is uitgevoerd. Bijvoorbeeld;Doorsturen, Toewijzen, Stoppen. Referentiedatasoort PROCESSTAPACTIE.
- positie:
- type: integer
- format: int32
- description: De positie van de processtap binnen het proces ten opzichte van andere processtappen.
- prioriteit:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Prioriteit van de processtap Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
- proces:
- allOf:
- - $ref: '#/components/schemas/Proces-sleutels'
- description: Het proces waar de processtap onderdeel van is.
- rollen:
- description: De rol(-len) die een relatie uitoefent ten opzichte van de processtap.
- type: array
- items:
- $ref: '#/components/schemas/Procesrol'
- vorigeProcesstappen:
- description: De processtap(-en) die deze processtap geïnitieerd heeft.
- type: array
- items:
- $ref: '#/components/schemas/Processtap-sleutels'
- Procesrolbericht:
- allOf:
- - $ref: '#/components/schemas/Procesrol'
- - $ref: '#/components/schemas/Bericht-basis'
- Procesrol:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Proces-sleutels:
type: object
properties:
id:
@@ -3942,37 +4072,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
- type: string
- format: any
- description: Een beknopte omschrijving van de aard van de rol.
- begindatum:
- type: string
- format: date-time
- description: Geeft de startdatum van de geldigheid van de rol aan.
- einddatum:
- type: string
- format: date-time
- description: Geeft de einddatum van de geldigheid van de rol aan.
- processen:
- description: De proces(-sen) waar de rol betrekking op heeft.
- type: array
- items:
- $ref: '#/components/schemas/Proces-sleutels'
- processtappen:
- description: De processtap(-pen) waar de rol betrekking op heeft.
- type: array
- items:
- $ref: '#/components/schemas/Processtap-sleutels'
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- toelichtingRol:
- type: string
- format: any
- description: Schriftelijke toelichting bij de rol.
- Processtap-sleutels:
+ Zaak-sleutels:
type: object
properties:
id:
@@ -3991,11 +4091,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Zaakbericht:
+ Informatieobjectbericht:
allOf:
- - $ref: '#/components/schemas/Zaak'
+ - $ref: '#/components/schemas/Informatieobject'
- $ref: '#/components/schemas/Bericht-basis'
- Zaak:
+ Informatieobject:
type: object
properties:
id:
@@ -4014,128 +4114,162 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Specificatie van het documenttype. Bijvoorbeeld verslag, rapport etc. Referentiedatasoort INFORMATIEOBJECTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detail specificatie van het documenttype. Bijvoorbeeld notulen, adviesrapport etc. Referentiedatasoort INFORMATIEOBJECTDETAILSOORT.
+ onderwerp:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Onderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTONDERWERP.
+ subonderwerp:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Subonderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTSUBONDERWERP.
+ titel:
type: string
format: any
- description: Een beknopte omschrijving van de zaak.
- toelichting:
+ description: Titel van het informatieobject.
+ beschrijving:
type: string
format: any
- description: Een beknopte toelichting op de zaak.
- bovenliggendeZaak:
+ description: Beschrijving van het informatieobject.
+ status:
allOf:
- - $ref: '#/components/schemas/Zaak-sleutels'
- description: Specificeert de bijbehorende hoofdzaak.
- begindatum:
- type: string
- format: date-time
- description: De datum waarop met de uitvoering van de zaak gestart is.
- einddatum:
- type: string
- format: date-time
- description: De datum waarop de uitvoering van de zaak afgerond is.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTSTATUS.
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detaillering van de fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTDETAILSTATUS.
registratiedatum:
type: string
format: date-time
- description: De datum waarop de zaakbehandelende organisatie de zaak heeft geregistreerd.
- publicatiedatum:
- type: string
- format: date-time
- description: Datum waarop (het starten van) de zaak gepubliceerd is.
- geplandeEinddatum:
+ description: Registratiedatum van het informatieobject.
+ ontvangstdatum:
type: string
format: date-time
- description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt.
- uiterlijkeEinddatum:
+ description: Ontvangstdatum van het informatieobject.
+ publicatiedatum:
type: string
format: date-time
- description: De datum waarop de zaak uiterlijk dient afgehandeld te zijn.
- archiefstatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De fase waarin het zaakdossier zich vanuit het perspectief van archivering bevindt. Referentiedatasoort ARCHIEFSTATUS.
+ description: Publicatiedatum of verzenddatum van het informatieobject.
archiefActiedatum:
type: string
format: date-time
- description: De datum waarop het gearchiveerde zaakdossier vernietigd dient te worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
+ description: De datum waarop het gearchiveerde informatieobject vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
archiefnominatie:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
+ description: Aanduiding of het informatieobject blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
+ auteur:
+ type: string
+ format: any
+ description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het informatieobject.
+ bestand:
+ type: string
+ format: byte
+ description: De binaire representatie van het informatieobject.
+ bestandsgrootte:
+ type: integer
+ format: int32
+ description: Omvang van het bestand in bytes.
+ bestandslocatie:
+ type: string
+ format: uri
+ description: Een link (URI) naar de binaire representatie van het informatieobject.
+ bestandsnaam:
+ type: string
+ format: any
+ description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd.
+ bijlagen:
+ description: De bijlagen behorend bij het informatieobject.
+ type: array
+ items:
+ $ref: '#/components/schemas/Informatieobject-sleutels'
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObjecten:
type: array
items:
type: string
format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- deelzaken:
- description: Specificeert de bijbehorende deelzaken.
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ dossiers:
+ description: Het informatieobject is gekoppeld aan/heeft betrekking op dossier(s).
type: array
items:
- $ref: '#/components/schemas/Zaak-sleutels'
- dossier:
- allOf:
- - $ref: '#/components/schemas/Dossier-sleutels'
- description: Het dossier dat aan de zaak gekoppeld is.
+ $ref: '#/components/schemas/Dossier-sleutels'
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
- gerelateerdeZaken:
- description: Heeft één of meerdere gerelateerde interne of externe zaken.
- type: array
- items:
- $ref: '#/components/schemas/Zaak-sleutels'
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ externePublicatie:
+ type: boolean
+ description: Aanduiding of dit informatieobject extern gepubliceerd dient te worden.
+ externePublicatietekst:
+ type: string
+ format: any
+ description: Tekstuele omschrijving ten behoeve van externe publicatie van dit informatieobject.
+ formaat:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het digitale formaat (IANA media type) van het informatieobject. Referentiedatasoort INFORMATIEOBJECTFORMAAT.
+ gebruiksrechten:
+ type: string
+ format: any
+ description: Informatie omtrent rechten die geassocieerd zijn met het informatieobject zoals intellectueel eigendom.
inkoopfacturen:
type: array
items:
type: string
format: uri
- description: Referenties naar Factuur in informatiedomein Financien
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
inkoopopdrachten:
type: array
items:
type: string
format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- kenmerken:
- description: Dit zijn eigenschappen behorend bij de zaak.
- type: array
- items:
- $ref: '#/components/schemas/Zaakkenmerk'
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
+ isBijlageVan:
+ allOf:
+ - $ref: '#/components/schemas/Informatieobject-sleutels'
+ description: Geeft aan dat het informatieobject een bijlage is van een ander informatieobject.
objecten:
description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
type: array
items:
- $ref: '#/components/schemas/Zaakobject'
+ $ref: '#/components/schemas/Zaakobject-sleutels'
onderhoudsverzoeken:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
processen:
- description: De zaak is gekoppeld aan/heeft betrekking op proces(sen).
+ description: Het informatieobject is gekoppeld aan/heeft betrekking op proces(sen).
type: array
items:
$ref: '#/components/schemas/Proces-sleutels'
@@ -4144,34 +4278,29 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- resultaatOmschrijving:
- type: string
- format: any
- description: Een beknopte omschrijving van het resultaat van de zaak.
- resultaatToelichting:
- type: string
- format: any
- description: Een beknopte toelichting op het resultaat van de zaak.
- rollen:
- description: De rollen op basis waarvan relaties betrokken zijn bij de zaak.
- type: array
- items:
- $ref: '#/components/schemas/Zaakrol'
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ taal:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De taal waarin het informatieobject is opgesteld. Referentiedatasoort TAAL.
verantwoordelijkeOrganisatie:
type: string
format: any
- description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor de behandeling van de gerelateerde zaak.
- zaakstatussen:
- description: De statussen die bereikt zijn gedurende de behandeling van de zaak.
+ description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor het informatieobject.
+ versie:
+ type: number
+ format: float
+ description: Het versienummer van het informatieobject.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De classificatie van het vertrouwelijkheidsniveau van het informatieobject. Referentiedatasoort VERTROUWELIJKHEID.
+ zaken:
+ description: Het informatieobject is gekoppeld aan/heeft betrekking op zaak(-en).
type: array
items:
- $ref: '#/components/schemas/Zaakstatus'
- zaaktype:
- allOf:
- - $ref: '#/components/schemas/Zaaktype'
- description: Zaaktype duidt de aard van de zaak aan en definieert daarmee de zaak.
- Zaak-sleutels:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Informatieobject-sleutels:
type: object
properties:
id:
@@ -4190,11 +4319,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Zaakkenmerkbericht:
+ Informatieobjectkenmerkbericht:
allOf:
- - $ref: '#/components/schemas/Zaakkenmerk'
+ - $ref: '#/components/schemas/Informatieobjectkenmerk'
- $ref: '#/components/schemas/Bericht-basis'
- Zaakkenmerk:
+ Informatieobjectkenmerk:
type: object
properties:
id:
@@ -4216,11 +4345,11 @@ components:
omschrijving:
type: string
format: any
- description: De omschrijving van het zaakkenmerk.
+ description: De omschrijving van het informatieobject kenmerk.
waarde:
type: string
format: any
- description: De waarde van het zaakkenmerk.
+ description: De waarde van het informatieobject kenmerk.
datatype:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4228,17 +4357,12 @@ components:
groep:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De groep van kenmerken behorend bij het zaakkenmerk. Referentiedatasoort ZAAKKENMERKGROEP.
- zaken:
- description: De zaken behorende bij het zaakkenmerk.
- type: array
- items:
- $ref: '#/components/schemas/Zaak-sleutels'
- Zaakrolbericht:
+ description: De groep van kenmerken behorend bij het informatieobject kenmerk. Referentiedatasoort INFORMATIEOBJECTGROEP.
+ Procesbericht:
allOf:
- - $ref: '#/components/schemas/Zaakrol'
+ - $ref: '#/components/schemas/Proces'
- $ref: '#/components/schemas/Bericht-basis'
- Zaakrol:
+ Proces:
type: object
properties:
id:
@@ -4256,53 +4380,118 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Algemeen gehanteerde benaming van de aard van de rol. Referentiedatasoort ZAAKROL.
- omschrijving:
- type: string
- format: any
- description: Een beknopte omschrijving van de aard van de rol.
+ description: De omschrijving en definitie van het proces (bijvoorbeeld aanbieden woning). Referentiedatasoort PROCESSOORT.
+ bovenliggendProces:
+ allOf:
+ - $ref: '#/components/schemas/Proces-sleutels'
+ description: Specificeert het bijbehorende hoofdproces.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de proces. Bijvoorbeeld;In behandeling, Afgesloten. Referentiedatasoort PROCESSTATUS.
begindatum:
type: string
format: date-time
- description: Geeft de startdatum van de geldigheid van de rol aan.
+ description: Datum en tijd waarop het proces gestart is.
einddatum:
type: string
format: date-time
- description: Geeft de einddatum van de geldigheid van de rol aan.
- afwijkendContactgegegeven:
- type: string
- format: uri
- description: Referentie naar Contactgegeven in informatiedomein Relaties
- indicatieGemachtigde:
- type: boolean
- description: Indicatie of de betrokkene in de rol bij de zaak optreedt als gemachtigde van een andere betrokkene bij die zaak.
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- toelichtingRol:
+ description: Datum en tijd waarop het proces afgesloten is.
+ verloopdatum:
type: string
- format: any
- description: Schriftelijke toelichting bij de rol.
- zaak:
- description: De zaak(-en) waarop de rol betrekking heeft.
+ format: date-time
+ description: Datum en tijd waarop het proces afgerond zou moeten zijn.
+ clusters:
type: array
items:
- $ref: '#/components/schemas/Zaak-sleutels'
- zaakstatussen:
- description: De zaak(-en) statussen waarop de rol betrekking heeft.
+ type: string
+ format: uri
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
+ collectiefObjecten:
type: array
items:
- $ref: '#/components/schemas/Zaakstatus'
- Zaakstatusbericht:
- allOf:
- - $ref: '#/components/schemas/Zaakstatus'
- - $ref: '#/components/schemas/Bericht-basis'
- Zaakstatus:
+ type: string
+ format: uri
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
+ deelprocessen:
+ description: Specificeert de bijbehorende deelprocessen.
+ type: array
+ items:
+ $ref: '#/components/schemas/Proces-sleutels'
+ dossiers:
+ description: Het proces is gekoppeld aan/heeft betrekking op dossier(s).
+ type: array
+ items:
+ $ref: '#/components/schemas/Dossier-sleutels'
+ eenheden:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ inkoopfacturen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
+ inkoopopdrachten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
+ niveau:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Specificeert het niveau van het proces. Bijvoorbeeld ketenproces, bedrijfsproces en werkproces. Referentiedatasoort PROCESNIVEAU.
+ objecten:
+ description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakobject-sleutels'
+ onderhoudsverzoeken:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ prioriteit:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Prioriteit van het proces. Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
+ processtappen:
+ description: De taken/stappen die behoren bij het proces.
+ type: array
+ items:
+ $ref: '#/components/schemas/Processtap-sleutels'
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ rollen:
+ description: De rol(len) die een relatie uitoefent ten opzichte van het proces.
+ type: array
+ items:
+ $ref: '#/components/schemas/Procesrol-sleutels'
+ zaken:
+ description: Het proces is gekoppeld aan/heeft betrekking op zaak(-en).
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Processtap-sleutels:
type: object
properties:
id:
@@ -4321,31 +4510,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De aanduiding van de status middels een statustype. Referentiedatasoort ZAAKSTATUSSOORT.
- begindatum:
- type: string
- format: date-time
- description: Het moment waarop de status is bereikt.
- einddatum:
- type: string
- format: date-time
- description: Het moment waarop de status verlopen is.
- toelichting:
- type: string
- format: any
- description: Toelichting over de status.
- zaak:
- allOf:
- - $ref: '#/components/schemas/Zaak-sleutels'
- description: De zaak waar de status betrekking op heeft.
- zaakrol:
- allOf:
- - $ref: '#/components/schemas/Zaakrol-sleutels'
- description: De rol van de bijbehorende relatie die de zaakstatus gezet heeft.
- Zaakrol-sleutels:
+ Procesrol-sleutels:
type: object
properties:
id:
@@ -4363,12 +4528,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Zaaktypebericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Procesrolbericht:
allOf:
- - $ref: '#/components/schemas/Zaaktype'
+ - $ref: '#/components/schemas/Procesrol'
- $ref: '#/components/schemas/Bericht-basis'
- Zaaktype:
+ Procesrol:
type: object
properties:
id:
@@ -4387,88 +4552,41 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Categorisering van de aard van een zaak van dit zaaktype. Referentiedatasoort ZAAKTYPESOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Specificatie van de categorie ten aanzien van de aard van zaak van het zaaktype. Referentiedatasoort ZAAKTYPEDETAILSOORT.
- generiekeOmschrijving:
- type: string
- format: any
- description: Een beknopte generieke omschrijving van de aard van de zaak en van het zaaktype gerelateerd aan een sectorale ZTC.
omschrijving:
type: string
format: any
- description: Een beknopte omschrijving van de aard van de zaak en van het zaaktype.
+ description: Een beknopte omschrijving van de aard van de rol.
begindatum:
type: string
format: date-time
- description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype bestaat en toegepast kan worden.
+ description: Geeft de startdatum van de geldigheid van de rol aan.
einddatum:
type: string
format: date-time
- description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype niet meer bestaat en niet meer toegepast kan worden.
- aanleiding:
- type: string
- format: any
- description: Een omschrijving van de aanleiding die leidt tot het starten van een zaak van dit zaaktype.
- archiefcode:
- type: string
- format: any
- description: De systematische identificatie van zaakdossiers van dit zaaktype overeenkomstig logisch gestructureerde conventies, methoden en procedureregels.
- doel:
- type: string
- format: any
- description: Een omschrijving van het doel
- domein:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het domein waarbinnen het zaaktype is uitgewerkt. Referentiedatasoort ZAAKTYPEDOMEIN.
- doorlooptijd:
- type: integer
- format: int32
- description: De periode waarbinnen een zaak van dit zaaktype afgerond dient te zijn.
- externePublicatie:
- type: boolean
- description: Aanduiding of (het starten van) een zaak van dit zaaktype gepubliceerd moet worden.
- externePublicatietekst:
- type: string
- format: any
- description: De generieke tekst ten behoeve van de publicatie van een zaak van dit zaaktype.
+ description: Geeft de einddatum van de geldigheid van de rol aan.
+ processen:
+ description: De proces(-sen) waar de rol betrekking op heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Proces-sleutels'
+ processtappen:
+ description: De processtap(-pen) waar de rol betrekking op heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Processtap-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- servicenorm:
- type: integer
- format: int32
- description: De periode waarbinnen verwacht wordt dat een zaak van dit zaaktype afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie.
- trefwoord:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ toelichtingRol:
type: string
format: any
- description: Een trefwoord waarmee een zaak van dit zaaktype kan worden gekarakteriseerd.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding van de mate waarin zaakdossiers van een zaak van dit zaaktype voor de openbaarheid bestemd zijn. Referentiedatasoort VERTROUWELIJKHEID.
- zaakstatussen:
- description: De statussen die bereikt kunnen worden bij behandeling van een zaak van dit zaaktype.
- type: array
- items:
- $ref: '#/components/schemas/Zaakstatus'
- zaken:
- description: De aanwezige/betreffende zaken van dit zaaktype.
- type: array
- items:
- $ref: '#/components/schemas/Zaak-sleutels'
- Informatieobjectbericht:
+ description: Schriftelijke toelichting bij de rol.
+ Processtapbericht:
allOf:
- - $ref: '#/components/schemas/Informatieobject'
+ - $ref: '#/components/schemas/Processtap'
- $ref: '#/components/schemas/Bericht-basis'
- Informatieobject:
+ Processtap:
type: object
properties:
id:
@@ -4490,190 +4608,230 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Specificatie van het documenttype. Bijvoorbeeld verslag, rapport etc. Referentiedatasoort INFORMATIEOBJECTSOORT.
- detailSoort:
+ description: De omschrijving en definitie van de processtap. Bijvoorbeeld keur inkoopfactuur goed of controleer huuropzegging. Referentiedatasoort PROCESSTAPSOORT.
+ status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Detail specificatie van het documenttype. Bijvoorbeeld notulen, adviesrapport etc. Referentiedatasoort INFORMATIEOBJECTDETAILSOORT.
- onderwerp:
+ description: Status van de processtap. Bijvoorbeeld;In behandeling, Wachtstand, Afgerond. Referentiedatasoort PROCESSTAPSTATUS.
+ begindatum:
+ type: string
+ format: date-time
+ description: Datum en tijd waarop de processtap gestart is.
+ einddatum:
+ type: string
+ format: date-time
+ description: Datum en tijd waarop de processtap afgesloten is.
+ verloopdatum:
+ type: string
+ format: date-time
+ description: Datum en tijd waarop de processtap afgerond zou moeten zijn.
+ actie:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Onderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTONDERWERP.
- subonderwerp:
+ description: Actie die is uitgevoerd. Bijvoorbeeld;Doorsturen, Toewijzen, Stoppen. Referentiedatasoort PROCESSTAPACTIE.
+ positie:
+ type: integer
+ format: int32
+ description: De positie van de processtap binnen het proces ten opzichte van andere processtappen.
+ prioriteit:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Subonderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTSUBONDERWERP.
- titel:
+ description: Prioriteit van de processtap Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
+ proces:
+ allOf:
+ - $ref: '#/components/schemas/Proces-sleutels'
+ description: Het proces waar de processtap onderdeel van is.
+ rollen:
+ description: De rol(-len) die een relatie uitoefent ten opzichte van de processtap.
+ type: array
+ items:
+ $ref: '#/components/schemas/Procesrol-sleutels'
+ vorigeProcesstappen:
+ description: De processtap(-en) die deze processtap geïnitieerd heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Processtap-sleutels'
+ Zaakbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaak'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaak:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Titel van het informatieobject.
- beschrijving:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: Beschrijving van het informatieobject.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTSTATUS.
- detailStatus:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ omschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van de zaak.
+ toelichting:
+ type: string
+ format: any
+ description: Een beknopte toelichting op de zaak.
+ bovenliggendeZaak:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Detaillering van de fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTDETAILSTATUS.
- registratiedatum:
+ - $ref: '#/components/schemas/Zaak-sleutels'
+ description: Specificeert de bijbehorende hoofdzaak.
+ begindatum:
type: string
format: date-time
- description: Registratiedatum van het informatieobject.
- ontvangstdatum:
+ description: De datum waarop met de uitvoering van de zaak gestart is.
+ einddatum:
type: string
format: date-time
- description: Ontvangstdatum van het informatieobject.
+ description: De datum waarop de uitvoering van de zaak afgerond is.
+ registratiedatum:
+ type: string
+ format: date-time
+ description: De datum waarop de zaakbehandelende organisatie de zaak heeft geregistreerd.
publicatiedatum:
type: string
format: date-time
- description: Publicatiedatum of verzenddatum van het informatieobject.
+ description: Datum waarop (het starten van) de zaak gepubliceerd is.
+ geplandeEinddatum:
+ type: string
+ format: date-time
+ description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt.
+ uiterlijkeEinddatum:
+ type: string
+ format: date-time
+ description: De datum waarop de zaak uiterlijk dient afgehandeld te zijn.
+ archiefstatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De fase waarin het zaakdossier zich vanuit het perspectief van archivering bevindt. Referentiedatasoort ARCHIEFSTATUS.
archiefActiedatum:
type: string
format: date-time
- description: De datum waarop het gearchiveerde informatieobject vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
+ description: De datum waarop het gearchiveerde zaakdossier vernietigd dient te worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
archiefnominatie:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding of het informatieobject blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
- auteur:
- type: string
- format: any
- description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het informatieobject.
- bestand:
- type: string
- format: byte
- description: De binaire representatie van het informatieobject.
- bestandsgrootte:
- type: integer
- format: int32
- description: Omvang van het bestand in bytes.
- bestandslocatie:
- type: string
- format: uri
- description: Een link (URI) naar de binaire representatie van het informatieobject.
- bestandsnaam:
- type: string
- format: any
- description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd.
- bijlagen:
- description: De bijlagen behorend bij het informatieobject.
- type: array
- items:
- $ref: '#/components/schemas/Informatieobject-sleutels'
+ description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObjecten:
type: array
items:
type: string
format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- dossiers:
- description: Het informatieobject is gekoppeld aan/heeft betrekking op dossier(s).
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ deelzaken:
+ description: Specificeert de bijbehorende deelzaken.
type: array
items:
- $ref: '#/components/schemas/Dossier'
+ $ref: '#/components/schemas/Zaak-sleutels'
+ dossier:
+ allOf:
+ - $ref: '#/components/schemas/Dossier-sleutels'
+ description: Het dossier dat aan de zaak gekoppeld is.
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
- externePublicatie:
- type: boolean
- description: Aanduiding of dit informatieobject extern gepubliceerd dient te worden.
- externePublicatietekst:
- type: string
- format: any
- description: Tekstuele omschrijving ten behoeve van externe publicatie van dit informatieobject.
- formaat:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het digitale formaat (IANA media type) van het informatieobject. Referentiedatasoort INFORMATIEOBJECTFORMAAT.
- gebruiksrechten:
- type: string
- format: any
- description: Informatie omtrent rechten die geassocieerd zijn met het informatieobject zoals intellectueel eigendom.
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ gerelateerdeZaken:
+ description: Heeft één of meerdere gerelateerde interne of externe zaken.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
inkoopfacturen:
type: array
items:
type: string
format: uri
- description: Referenties naar Factuur in informatiedomein Financien
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
inkoopopdrachten:
type: array
items:
type: string
format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- isBijlageVan:
- allOf:
- - $ref: '#/components/schemas/Informatieobject-sleutels'
- description: Geeft aan dat het informatieobject een bijlage is van een ander informatieobject.
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
+ kenmerken:
+ description: Dit zijn eigenschappen behorend bij de zaak.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakkenmerk-sleutels'
objecten:
description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
type: array
items:
- $ref: '#/components/schemas/Zaakobject'
+ $ref: '#/components/schemas/Zaakobject-sleutels'
onderhoudsverzoeken:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
processen:
- description: Het informatieobject is gekoppeld aan/heeft betrekking op proces(sen).
+ description: De zaak is gekoppeld aan/heeft betrekking op proces(sen).
type: array
items:
- $ref: '#/components/schemas/Proces'
+ $ref: '#/components/schemas/Proces-sleutels'
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- taal:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De taal waarin het informatieobject is opgesteld. Referentiedatasoort TAAL.
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ resultaatOmschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van het resultaat van de zaak.
+ resultaatToelichting:
+ type: string
+ format: any
+ description: Een beknopte toelichting op het resultaat van de zaak.
+ rollen:
+ description: De rollen op basis waarvan relaties betrokken zijn bij de zaak.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakrol-sleutels'
verantwoordelijkeOrganisatie:
type: string
format: any
- description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor het informatieobject.
- versie:
- type: number
- format: float
- description: Het versienummer van het informatieobject.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De classificatie van het vertrouwelijkheidsniveau van het informatieobject. Referentiedatasoort VERTROUWELIJKHEID.
- zaken:
- description: Het informatieobject is gekoppeld aan/heeft betrekking op zaak(-en).
+ description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor de behandeling van de gerelateerde zaak.
+ zaakstatussen:
+ description: De statussen die bereikt zijn gedurende de behandeling van de zaak.
type: array
items:
- $ref: '#/components/schemas/Zaak'
- Informatieobject-sleutels:
+ $ref: '#/components/schemas/Zaakstatus-sleutels'
+ zaaktype:
+ allOf:
+ - $ref: '#/components/schemas/Zaaktype-sleutels'
+ description: Zaaktype duidt de aard van de zaak aan en definieert daarmee de zaak.
+ Zaakkenmerk-sleutels:
type: object
properties:
id:
@@ -4692,11 +4850,68 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Informatieobjectkenmerkbericht:
+ Zaakrol-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Zaakstatus-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Zaaktype-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Zaakkenmerkbericht:
allOf:
- - $ref: '#/components/schemas/Informatieobjectkenmerk'
+ - $ref: '#/components/schemas/Zaakkenmerk'
- $ref: '#/components/schemas/Bericht-basis'
- Informatieobjectkenmerk:
+ Zaakkenmerk:
type: object
properties:
id:
@@ -4718,11 +4933,11 @@ components:
omschrijving:
type: string
format: any
- description: De omschrijving van het informatieobject kenmerk.
+ description: De omschrijving van het zaakkenmerk.
waarde:
type: string
format: any
- description: De waarde van het informatieobject kenmerk.
+ description: De waarde van het zaakkenmerk.
datatype:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4730,7 +4945,242 @@ components:
groep:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De groep van kenmerken behorend bij het informatieobject kenmerk. Referentiedatasoort INFORMATIEOBJECTGROEP.
+ description: De groep van kenmerken behorend bij het zaakkenmerk. Referentiedatasoort ZAAKKENMERKGROEP.
+ zaken:
+ description: De zaken behorende bij het zaakkenmerk.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Zaakobjectbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaakobject'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaakobject:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort gegevensobject. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc. Referentiedatasoort ZAAKOBJECTSOORT.
+ Zaakrolbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaakrol'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaakrol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Algemeen gehanteerde benaming van de aard van de rol. Referentiedatasoort ZAAKROL.
+ omschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van de aard van de rol.
+ begindatum:
+ type: string
+ format: date-time
+ description: Geeft de startdatum van de geldigheid van de rol aan.
+ einddatum:
+ type: string
+ format: date-time
+ description: Geeft de einddatum van de geldigheid van de rol aan.
+ afwijkendContactgegegeven:
+ type: string
+ format: uri
+ description: Referentie naar Contactgegeven-sleutels in informatiedomein Relaties
+ indicatieGemachtigde:
+ type: boolean
+ description: Indicatie of de betrokkene in de rol bij de zaak optreedt als gemachtigde van een andere betrokkene bij die zaak.
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ toelichtingRol:
+ type: string
+ format: any
+ description: Schriftelijke toelichting bij de rol.
+ zaak:
+ description: De zaak(-en) waarop de rol betrekking heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ zaakstatussen:
+ description: De zaak(-en) statussen waarop de rol betrekking heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakstatus-sleutels'
+ Zaakstatusbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaakstatus'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaakstatus:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De aanduiding van de status middels een statustype. Referentiedatasoort ZAAKSTATUSSOORT.
+ begindatum:
+ type: string
+ format: date-time
+ description: Het moment waarop de status is bereikt.
+ einddatum:
+ type: string
+ format: date-time
+ description: Het moment waarop de status verlopen is.
+ toelichting:
+ type: string
+ format: any
+ description: Toelichting over de status.
+ zaak:
+ allOf:
+ - $ref: '#/components/schemas/Zaak-sleutels'
+ description: De zaak waar de status betrekking op heeft.
+ zaakrol:
+ allOf:
+ - $ref: '#/components/schemas/Zaakrol-sleutels'
+ description: De rol van de bijbehorende relatie die de zaakstatus gezet heeft.
+ Zaaktypebericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaaktype'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaaktype:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Categorisering van de aard van een zaak van dit zaaktype. Referentiedatasoort ZAAKTYPESOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Specificatie van de categorie ten aanzien van de aard van zaak van het zaaktype. Referentiedatasoort ZAAKTYPEDETAILSOORT.
+ generiekeOmschrijving:
+ type: string
+ format: any
+ description: Een beknopte generieke omschrijving van de aard van de zaak en van het zaaktype gerelateerd aan een sectorale ZTC.
+ omschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van de aard van de zaak en van het zaaktype.
+ begindatum:
+ type: string
+ format: date-time
+ description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype bestaat en toegepast kan worden.
+ einddatum:
+ type: string
+ format: date-time
+ description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype niet meer bestaat en niet meer toegepast kan worden.
+ aanleiding:
+ type: string
+ format: any
+ description: Een omschrijving van de aanleiding die leidt tot het starten van een zaak van dit zaaktype.
+ archiefcode:
+ type: string
+ format: any
+ description: De systematische identificatie van zaakdossiers van dit zaaktype overeenkomstig logisch gestructureerde conventies, methoden en procedureregels.
+ doel:
+ type: string
+ format: any
+ description: Een omschrijving van het doel
+ domein:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het domein waarbinnen het zaaktype is uitgewerkt. Referentiedatasoort ZAAKTYPEDOMEIN.
+ doorlooptijd:
+ type: integer
+ format: int32
+ description: De periode waarbinnen een zaak van dit zaaktype afgerond dient te zijn.
+ externePublicatie:
+ type: boolean
+ description: Aanduiding of (het starten van) een zaak van dit zaaktype gepubliceerd moet worden.
+ externePublicatietekst:
+ type: string
+ format: any
+ description: De generieke tekst ten behoeve van de publicatie van een zaak van dit zaaktype.
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ servicenorm:
+ type: integer
+ format: int32
+ description: De periode waarbinnen verwacht wordt dat een zaak van dit zaaktype afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie.
+ trefwoord:
+ type: string
+ format: any
+ description: Een trefwoord waarmee een zaak van dit zaaktype kan worden gekarakteriseerd.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Aanduiding van de mate waarin zaakdossiers van een zaak van dit zaaktype voor de openbaarheid bestemd zijn. Referentiedatasoort VERTROUWELIJKHEID.
+ zaakstatussen:
+ description: De statussen die bereikt kunnen worden bij behandeling van een zaak van dit zaaktype.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakstatus-sleutels'
+ zaken:
+ description: De aanwezige/betreffende zaken van dit zaaktype.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Financien.yaml b/Informatiedomeinen/Financien.yaml
index 34d9e57..403e877 100644
--- a/Informatiedomeinen/Financien.yaml
+++ b/Informatiedomeinen/Financien.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://financien.vera.io:{port}/{basePath}
description: Productieserver
@@ -103,7 +103,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -119,7 +119,7 @@ paths:
get:
tags:
- 'Aanbestedingen'
- description: Ophalen van Aanbestedingen
+ summary: Ophalen van Aanbestedingen
operationId: listAanbestedingen
parameters:
- name: params
@@ -169,7 +169,7 @@ paths:
post:
tags:
- 'Aanbestedingen'
- description: Voegt een nieuw(e) Aanbesteding toe.
+ summary: Voegt een nieuw(e) Aanbesteding toe.
operationId: createAanbesteding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -209,7 +209,7 @@ paths:
put:
tags:
- 'Aanbestedingen'
- description: |
+ summary: |
Vervangen van een Aanbesteding op basis van overeenkomstige sleutelvelden.
operationId: replaceAanbesteding
parameters:
@@ -244,7 +244,7 @@ paths:
patch:
tags:
- 'Aanbestedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aanbesteding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAanbesteding
@@ -281,7 +281,7 @@ paths:
get:
tags:
- 'Aanbestedingen'
- description: Retourneert een Aanbesteding met de gegeven identifier
+ summary: Retourneert een Aanbesteding met de gegeven identifier
operationId: readAanbestedingById
parameters:
- name: id
@@ -318,7 +318,7 @@ paths:
put:
tags:
- 'Aanbestedingen'
- description: Vervangen van een Aanbesteding
+ summary: Vervangen van een Aanbesteding
operationId: replaceAanbestedingById
parameters:
- name: 'id'
@@ -356,7 +356,7 @@ paths:
patch:
tags:
- 'Aanbestedingen'
- description: Wijzigen van een Aanbesteding
+ summary: Wijzigen van een Aanbesteding
operationId: updateAanbestedingById
parameters:
- name: 'id'
@@ -395,7 +395,7 @@ paths:
get:
tags:
- 'Afletteringen'
- description: Ophalen van Afletteringen
+ summary: Ophalen van Afletteringen
operationId: listAfletteringen
parameters:
- name: params
@@ -445,7 +445,7 @@ paths:
post:
tags:
- 'Afletteringen'
- description: Voegt een nieuw(e) Aflettering toe.
+ summary: Voegt een nieuw(e) Aflettering toe.
operationId: createAflettering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -485,7 +485,7 @@ paths:
put:
tags:
- 'Afletteringen'
- description: |
+ summary: |
Vervangen van een Aflettering op basis van overeenkomstige sleutelvelden.
operationId: replaceAflettering
parameters:
@@ -520,7 +520,7 @@ paths:
patch:
tags:
- 'Afletteringen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aflettering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAflettering
@@ -557,7 +557,7 @@ paths:
get:
tags:
- 'Afletteringen'
- description: Retourneert een Aflettering met de gegeven identifier
+ summary: Retourneert een Aflettering met de gegeven identifier
operationId: readAfletteringById
parameters:
- name: id
@@ -594,7 +594,7 @@ paths:
put:
tags:
- 'Afletteringen'
- description: Vervangen van een Aflettering
+ summary: Vervangen van een Aflettering
operationId: replaceAfletteringById
parameters:
- name: 'id'
@@ -632,7 +632,7 @@ paths:
patch:
tags:
- 'Afletteringen'
- description: Wijzigen van een Aflettering
+ summary: Wijzigen van een Aflettering
operationId: updateAfletteringById
parameters:
- name: 'id'
@@ -671,7 +671,7 @@ paths:
get:
tags:
- 'Bankafschriften'
- description: Ophalen van Bankafschriften
+ summary: Ophalen van Bankafschriften
operationId: listBankafschriften
parameters:
- name: params
@@ -721,7 +721,7 @@ paths:
post:
tags:
- 'Bankafschriften'
- description: Voegt een nieuw(e) Bankafschrift toe.
+ summary: Voegt een nieuw(e) Bankafschrift toe.
operationId: createBankafschrift
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -761,7 +761,7 @@ paths:
put:
tags:
- 'Bankafschriften'
- description: |
+ summary: |
Vervangen van een Bankafschrift op basis van overeenkomstige sleutelvelden.
operationId: replaceBankafschrift
parameters:
@@ -796,7 +796,7 @@ paths:
patch:
tags:
- 'Bankafschriften'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Bankafschrift. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBankafschrift
@@ -833,7 +833,7 @@ paths:
get:
tags:
- 'Bankafschriften'
- description: Retourneert een Bankafschrift met de gegeven identifier
+ summary: Retourneert een Bankafschrift met de gegeven identifier
operationId: readBankafschriftById
parameters:
- name: id
@@ -870,7 +870,7 @@ paths:
put:
tags:
- 'Bankafschriften'
- description: Vervangen van een Bankafschrift
+ summary: Vervangen van een Bankafschrift
operationId: replaceBankafschriftById
parameters:
- name: 'id'
@@ -908,7 +908,7 @@ paths:
patch:
tags:
- 'Bankafschriften'
- description: Wijzigen van een Bankafschrift
+ summary: Wijzigen van een Bankafschrift
operationId: updateBankafschriftById
parameters:
- name: 'id'
@@ -947,7 +947,7 @@ paths:
get:
tags:
- 'BankafschriftRegels'
- description: Ophalen van BankafschriftRegels
+ summary: Ophalen van BankafschriftRegels
operationId: listBankafschriftRegels
parameters:
- name: params
@@ -997,7 +997,7 @@ paths:
post:
tags:
- 'BankafschriftRegels'
- description: Voegt een nieuw(e) BankafschriftRegel toe.
+ summary: Voegt een nieuw(e) BankafschriftRegel toe.
operationId: createBankafschriftRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1037,7 +1037,7 @@ paths:
put:
tags:
- 'BankafschriftRegels'
- description: |
+ summary: |
Vervangen van een BankafschriftRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceBankafschriftRegel
parameters:
@@ -1072,7 +1072,7 @@ paths:
patch:
tags:
- 'BankafschriftRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BankafschriftRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBankafschriftRegel
@@ -1109,7 +1109,7 @@ paths:
get:
tags:
- 'BankafschriftRegels'
- description: Retourneert een BankafschriftRegel met de gegeven identifier
+ summary: Retourneert een BankafschriftRegel met de gegeven identifier
operationId: readBankafschriftRegelById
parameters:
- name: id
@@ -1146,7 +1146,7 @@ paths:
put:
tags:
- 'BankafschriftRegels'
- description: Vervangen van een BankafschriftRegel
+ summary: Vervangen van een BankafschriftRegel
operationId: replaceBankafschriftRegelById
parameters:
- name: 'id'
@@ -1184,7 +1184,7 @@ paths:
patch:
tags:
- 'BankafschriftRegels'
- description: Wijzigen van een BankafschriftRegel
+ summary: Wijzigen van een BankafschriftRegel
operationId: updateBankafschriftRegelById
parameters:
- name: 'id'
@@ -1223,7 +1223,7 @@ paths:
get:
tags:
- 'Begrotingen'
- description: Ophalen van Begrotingen
+ summary: Ophalen van Begrotingen
operationId: listBegrotingen
parameters:
- name: params
@@ -1273,7 +1273,7 @@ paths:
post:
tags:
- 'Begrotingen'
- description: Voegt een nieuw(e) Begroting toe.
+ summary: Voegt een nieuw(e) Begroting toe.
operationId: createBegroting
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1313,7 +1313,7 @@ paths:
put:
tags:
- 'Begrotingen'
- description: |
+ summary: |
Vervangen van een Begroting op basis van overeenkomstige sleutelvelden.
operationId: replaceBegroting
parameters:
@@ -1348,7 +1348,7 @@ paths:
patch:
tags:
- 'Begrotingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Begroting. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBegroting
@@ -1385,7 +1385,7 @@ paths:
get:
tags:
- 'Begrotingen'
- description: Retourneert een Begroting met de gegeven identifier
+ summary: Retourneert een Begroting met de gegeven identifier
operationId: readBegrotingById
parameters:
- name: id
@@ -1422,7 +1422,7 @@ paths:
put:
tags:
- 'Begrotingen'
- description: Vervangen van een Begroting
+ summary: Vervangen van een Begroting
operationId: replaceBegrotingById
parameters:
- name: 'id'
@@ -1460,7 +1460,7 @@ paths:
patch:
tags:
- 'Begrotingen'
- description: Wijzigen van een Begroting
+ summary: Wijzigen van een Begroting
operationId: updateBegrotingById
parameters:
- name: 'id'
@@ -1499,7 +1499,7 @@ paths:
get:
tags:
- 'Betaalopdrachten'
- description: Ophalen van Betaalopdrachten
+ summary: Ophalen van Betaalopdrachten
operationId: listBetaalopdrachten
parameters:
- name: params
@@ -1549,7 +1549,7 @@ paths:
post:
tags:
- 'Betaalopdrachten'
- description: Voegt een nieuw(e) Betaalopdracht toe.
+ summary: Voegt een nieuw(e) Betaalopdracht toe.
operationId: createBetaalopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1589,7 +1589,7 @@ paths:
put:
tags:
- 'Betaalopdrachten'
- description: |
+ summary: |
Vervangen van een Betaalopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalopdracht
parameters:
@@ -1624,7 +1624,7 @@ paths:
patch:
tags:
- 'Betaalopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalopdracht
@@ -1661,7 +1661,7 @@ paths:
get:
tags:
- 'Betaalopdrachten'
- description: Retourneert een Betaalopdracht met de gegeven identifier
+ summary: Retourneert een Betaalopdracht met de gegeven identifier
operationId: readBetaalopdrachtById
parameters:
- name: id
@@ -1698,7 +1698,7 @@ paths:
put:
tags:
- 'Betaalopdrachten'
- description: Vervangen van een Betaalopdracht
+ summary: Vervangen van een Betaalopdracht
operationId: replaceBetaalopdrachtById
parameters:
- name: 'id'
@@ -1736,7 +1736,7 @@ paths:
patch:
tags:
- 'Betaalopdrachten'
- description: Wijzigen van een Betaalopdracht
+ summary: Wijzigen van een Betaalopdracht
operationId: updateBetaalopdrachtById
parameters:
- name: 'id'
@@ -1775,7 +1775,7 @@ paths:
get:
tags:
- 'Betaalwijzen'
- description: Ophalen van Betaalwijzen
+ summary: Ophalen van Betaalwijzen
operationId: listBetaalwijzen
parameters:
- name: params
@@ -1825,7 +1825,7 @@ paths:
post:
tags:
- 'Betaalwijzen'
- description: Voegt een nieuw(e) Betaalwijze toe.
+ summary: Voegt een nieuw(e) Betaalwijze toe.
operationId: createBetaalwijze
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1865,7 +1865,7 @@ paths:
put:
tags:
- 'Betaalwijzen'
- description: |
+ summary: |
Vervangen van een Betaalwijze op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalwijze
parameters:
@@ -1900,7 +1900,7 @@ paths:
patch:
tags:
- 'Betaalwijzen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalwijze. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalwijze
@@ -1937,7 +1937,7 @@ paths:
get:
tags:
- 'Betaalwijzen'
- description: Retourneert een Betaalwijze met de gegeven identifier
+ summary: Retourneert een Betaalwijze met de gegeven identifier
operationId: readBetaalwijzeById
parameters:
- name: id
@@ -1974,7 +1974,7 @@ paths:
put:
tags:
- 'Betaalwijzen'
- description: Vervangen van een Betaalwijze
+ summary: Vervangen van een Betaalwijze
operationId: replaceBetaalwijzeById
parameters:
- name: 'id'
@@ -2012,7 +2012,7 @@ paths:
patch:
tags:
- 'Betaalwijzen'
- description: Wijzigen van een Betaalwijze
+ summary: Wijzigen van een Betaalwijze
operationId: updateBetaalwijzeById
parameters:
- name: 'id'
@@ -2051,7 +2051,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Ophalen van Betalingsregelingen
+ summary: Ophalen van Betalingsregelingen
operationId: listBetalingsregelingen
parameters:
- name: params
@@ -2101,7 +2101,7 @@ paths:
post:
tags:
- 'Betalingsregelingen'
- description: Voegt een nieuw(e) Betalingsregeling toe.
+ summary: Voegt een nieuw(e) Betalingsregeling toe.
operationId: createBetalingsregeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2141,7 +2141,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Vervangen van een Betalingsregeling op basis van overeenkomstige sleutelvelden.
operationId: replaceBetalingsregeling
parameters:
@@ -2176,7 +2176,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betalingsregeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetalingsregeling
@@ -2213,7 +2213,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Retourneert een Betalingsregeling met de gegeven identifier
+ summary: Retourneert een Betalingsregeling met de gegeven identifier
operationId: readBetalingsregelingById
parameters:
- name: id
@@ -2250,7 +2250,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: Vervangen van een Betalingsregeling
+ summary: Vervangen van een Betalingsregeling
operationId: replaceBetalingsregelingById
parameters:
- name: 'id'
@@ -2288,7 +2288,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: Wijzigen van een Betalingsregeling
+ summary: Wijzigen van een Betalingsregeling
operationId: updateBetalingsregelingById
parameters:
- name: 'id'
@@ -2327,7 +2327,7 @@ paths:
get:
tags:
- 'BetalingsregelingTermijnen'
- description: Ophalen van BetalingsregelingTermijnen
+ summary: Ophalen van BetalingsregelingTermijnen
operationId: listBetalingsregelingTermijnen
parameters:
- name: params
@@ -2377,7 +2377,7 @@ paths:
post:
tags:
- 'BetalingsregelingTermijnen'
- description: Voegt een nieuw(e) BetalingsregelingTermijn toe.
+ summary: Voegt een nieuw(e) BetalingsregelingTermijn toe.
operationId: createBetalingsregelingTermijn
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2417,7 +2417,7 @@ paths:
put:
tags:
- 'BetalingsregelingTermijnen'
- description: |
+ summary: |
Vervangen van een BetalingsregelingTermijn op basis van overeenkomstige sleutelvelden.
operationId: replaceBetalingsregelingTermijn
parameters:
@@ -2452,7 +2452,7 @@ paths:
patch:
tags:
- 'BetalingsregelingTermijnen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BetalingsregelingTermijn. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetalingsregelingTermijn
@@ -2489,7 +2489,7 @@ paths:
get:
tags:
- 'BetalingsregelingTermijnen'
- description: Retourneert een BetalingsregelingTermijn met de gegeven identifier
+ summary: Retourneert een BetalingsregelingTermijn met de gegeven identifier
operationId: readBetalingsregelingTermijnById
parameters:
- name: id
@@ -2526,7 +2526,7 @@ paths:
put:
tags:
- 'BetalingsregelingTermijnen'
- description: Vervangen van een BetalingsregelingTermijn
+ summary: Vervangen van een BetalingsregelingTermijn
operationId: replaceBetalingsregelingTermijnById
parameters:
- name: 'id'
@@ -2564,7 +2564,7 @@ paths:
patch:
tags:
- 'BetalingsregelingTermijnen'
- description: Wijzigen van een BetalingsregelingTermijn
+ summary: Wijzigen van een BetalingsregelingTermijn
operationId: updateBetalingsregelingTermijnById
parameters:
- name: 'id'
@@ -2603,7 +2603,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Ophalen van Boekingen
+ summary: Ophalen van Boekingen
operationId: listBoekingen
parameters:
- name: params
@@ -2653,7 +2653,7 @@ paths:
post:
tags:
- 'Boekingen'
- description: Voegt een nieuw(e) Boeking toe.
+ summary: Voegt een nieuw(e) Boeking toe.
operationId: createBoeking
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2693,7 +2693,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: |
+ summary: |
Vervangen van een Boeking op basis van overeenkomstige sleutelvelden.
operationId: replaceBoeking
parameters:
@@ -2728,7 +2728,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boeking. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoeking
@@ -2765,7 +2765,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Retourneert een Boeking met de gegeven identifier
+ summary: Retourneert een Boeking met de gegeven identifier
operationId: readBoekingById
parameters:
- name: id
@@ -2802,7 +2802,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: Vervangen van een Boeking
+ summary: Vervangen van een Boeking
operationId: replaceBoekingById
parameters:
- name: 'id'
@@ -2840,7 +2840,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: Wijzigen van een Boeking
+ summary: Wijzigen van een Boeking
operationId: updateBoekingById
parameters:
- name: 'id'
@@ -2879,7 +2879,7 @@ paths:
get:
tags:
- 'Boekingdetails'
- description: Ophalen van Boekingdetails
+ summary: Ophalen van Boekingdetails
operationId: listBoekingdetails
parameters:
- name: params
@@ -2929,7 +2929,7 @@ paths:
post:
tags:
- 'Boekingdetails'
- description: Voegt een nieuw(e) Boekingdetail toe.
+ summary: Voegt een nieuw(e) Boekingdetail toe.
operationId: createBoekingdetail
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2969,7 +2969,7 @@ paths:
put:
tags:
- 'Boekingdetails'
- description: |
+ summary: |
Vervangen van een Boekingdetail op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekingdetail
parameters:
@@ -3004,7 +3004,7 @@ paths:
patch:
tags:
- 'Boekingdetails'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boekingdetail. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekingdetail
@@ -3041,7 +3041,7 @@ paths:
get:
tags:
- 'Boekingdetails'
- description: Retourneert een Boekingdetail met de gegeven identifier
+ summary: Retourneert een Boekingdetail met de gegeven identifier
operationId: readBoekingdetailById
parameters:
- name: id
@@ -3078,7 +3078,7 @@ paths:
put:
tags:
- 'Boekingdetails'
- description: Vervangen van een Boekingdetail
+ summary: Vervangen van een Boekingdetail
operationId: replaceBoekingdetailById
parameters:
- name: 'id'
@@ -3116,7 +3116,7 @@ paths:
patch:
tags:
- 'Boekingdetails'
- description: Wijzigen van een Boekingdetail
+ summary: Wijzigen van een Boekingdetail
operationId: updateBoekingdetailById
parameters:
- name: 'id'
@@ -3155,7 +3155,7 @@ paths:
get:
tags:
- 'Boekjaren'
- description: Ophalen van Boekjaren
+ summary: Ophalen van Boekjaren
operationId: listBoekjaren
parameters:
- name: params
@@ -3205,7 +3205,7 @@ paths:
post:
tags:
- 'Boekjaren'
- description: Voegt een nieuw(e) Boekjaar toe.
+ summary: Voegt een nieuw(e) Boekjaar toe.
operationId: createBoekjaar
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3245,7 +3245,7 @@ paths:
put:
tags:
- 'Boekjaren'
- description: |
+ summary: |
Vervangen van een Boekjaar op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekjaar
parameters:
@@ -3280,7 +3280,7 @@ paths:
patch:
tags:
- 'Boekjaren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boekjaar. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekjaar
@@ -3317,7 +3317,7 @@ paths:
get:
tags:
- 'Boekjaren'
- description: Retourneert een Boekjaar met de gegeven identifier
+ summary: Retourneert een Boekjaar met de gegeven identifier
operationId: readBoekjaarById
parameters:
- name: id
@@ -3354,7 +3354,7 @@ paths:
put:
tags:
- 'Boekjaren'
- description: Vervangen van een Boekjaar
+ summary: Vervangen van een Boekjaar
operationId: replaceBoekjaarById
parameters:
- name: 'id'
@@ -3392,7 +3392,7 @@ paths:
patch:
tags:
- 'Boekjaren'
- description: Wijzigen van een Boekjaar
+ summary: Wijzigen van een Boekjaar
operationId: updateBoekjaarById
parameters:
- name: 'id'
@@ -3431,7 +3431,7 @@ paths:
get:
tags:
- 'BoekjaarPerioden'
- description: Ophalen van BoekjaarPerioden
+ summary: Ophalen van BoekjaarPerioden
operationId: listBoekjaarPerioden
parameters:
- name: params
@@ -3481,7 +3481,7 @@ paths:
post:
tags:
- 'BoekjaarPerioden'
- description: Voegt een nieuw(e) BoekjaarPeriode toe.
+ summary: Voegt een nieuw(e) BoekjaarPeriode toe.
operationId: createBoekjaarPeriode
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3521,7 +3521,7 @@ paths:
put:
tags:
- 'BoekjaarPerioden'
- description: |
+ summary: |
Vervangen van een BoekjaarPeriode op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekjaarPeriode
parameters:
@@ -3556,7 +3556,7 @@ paths:
patch:
tags:
- 'BoekjaarPerioden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BoekjaarPeriode. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekjaarPeriode
@@ -3593,7 +3593,7 @@ paths:
get:
tags:
- 'BoekjaarPerioden'
- description: Retourneert een BoekjaarPeriode met de gegeven identifier
+ summary: Retourneert een BoekjaarPeriode met de gegeven identifier
operationId: readBoekjaarPeriodeById
parameters:
- name: id
@@ -3630,7 +3630,7 @@ paths:
put:
tags:
- 'BoekjaarPerioden'
- description: Vervangen van een BoekjaarPeriode
+ summary: Vervangen van een BoekjaarPeriode
operationId: replaceBoekjaarPeriodeById
parameters:
- name: 'id'
@@ -3668,7 +3668,7 @@ paths:
patch:
tags:
- 'BoekjaarPerioden'
- description: Wijzigen van een BoekjaarPeriode
+ summary: Wijzigen van een BoekjaarPeriode
operationId: updateBoekjaarPeriodeById
parameters:
- name: 'id'
@@ -3707,7 +3707,7 @@ paths:
get:
tags:
- 'BoekjaarPeriodesaldos'
- description: Ophalen van BoekjaarPeriodesaldos
+ summary: Ophalen van BoekjaarPeriodesaldos
operationId: listBoekjaarPeriodesaldos
parameters:
- name: params
@@ -3757,7 +3757,7 @@ paths:
post:
tags:
- 'BoekjaarPeriodesaldos'
- description: Voegt een nieuw(e) BoekjaarPeriodesaldo toe.
+ summary: Voegt een nieuw(e) BoekjaarPeriodesaldo toe.
operationId: createBoekjaarPeriodesaldo
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3797,7 +3797,7 @@ paths:
put:
tags:
- 'BoekjaarPeriodesaldos'
- description: |
+ summary: |
Vervangen van een BoekjaarPeriodesaldo op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekjaarPeriodesaldo
parameters:
@@ -3832,7 +3832,7 @@ paths:
patch:
tags:
- 'BoekjaarPeriodesaldos'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BoekjaarPeriodesaldo. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekjaarPeriodesaldo
@@ -3869,7 +3869,7 @@ paths:
get:
tags:
- 'BoekjaarPeriodesaldos'
- description: Retourneert een BoekjaarPeriodesaldo met de gegeven identifier
+ summary: Retourneert een BoekjaarPeriodesaldo met de gegeven identifier
operationId: readBoekjaarPeriodesaldoById
parameters:
- name: id
@@ -3906,7 +3906,7 @@ paths:
put:
tags:
- 'BoekjaarPeriodesaldos'
- description: Vervangen van een BoekjaarPeriodesaldo
+ summary: Vervangen van een BoekjaarPeriodesaldo
operationId: replaceBoekjaarPeriodesaldoById
parameters:
- name: 'id'
@@ -3944,7 +3944,7 @@ paths:
patch:
tags:
- 'BoekjaarPeriodesaldos'
- description: Wijzigen van een BoekjaarPeriodesaldo
+ summary: Wijzigen van een BoekjaarPeriodesaldo
operationId: updateBoekjaarPeriodesaldoById
parameters:
- name: 'id'
@@ -3983,7 +3983,7 @@ paths:
get:
tags:
- 'BtwAangiften'
- description: Ophalen van BtwAangiften
+ summary: Ophalen van BtwAangiften
operationId: listBtwAangiften
parameters:
- name: params
@@ -4033,7 +4033,7 @@ paths:
post:
tags:
- 'BtwAangiften'
- description: Voegt een nieuw(e) BtwAangifte toe.
+ summary: Voegt een nieuw(e) BtwAangifte toe.
operationId: createBtwAangifte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4073,7 +4073,7 @@ paths:
put:
tags:
- 'BtwAangiften'
- description: |
+ summary: |
Vervangen van een BtwAangifte op basis van overeenkomstige sleutelvelden.
operationId: replaceBtwAangifte
parameters:
@@ -4108,7 +4108,7 @@ paths:
patch:
tags:
- 'BtwAangiften'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BtwAangifte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBtwAangifte
@@ -4145,7 +4145,7 @@ paths:
get:
tags:
- 'BtwAangiften'
- description: Retourneert een BtwAangifte met de gegeven identifier
+ summary: Retourneert een BtwAangifte met de gegeven identifier
operationId: readBtwAangifteById
parameters:
- name: id
@@ -4182,7 +4182,7 @@ paths:
put:
tags:
- 'BtwAangiften'
- description: Vervangen van een BtwAangifte
+ summary: Vervangen van een BtwAangifte
operationId: replaceBtwAangifteById
parameters:
- name: 'id'
@@ -4220,7 +4220,7 @@ paths:
patch:
tags:
- 'BtwAangiften'
- description: Wijzigen van een BtwAangifte
+ summary: Wijzigen van een BtwAangifte
operationId: updateBtwAangifteById
parameters:
- name: 'id'
@@ -4259,7 +4259,7 @@ paths:
get:
tags:
- 'BtwTarieven'
- description: Ophalen van BtwTarieven
+ summary: Ophalen van BtwTarieven
operationId: listBtwTarieven
parameters:
- name: params
@@ -4309,7 +4309,7 @@ paths:
post:
tags:
- 'BtwTarieven'
- description: Voegt een nieuw(e) BtwTarief toe.
+ summary: Voegt een nieuw(e) BtwTarief toe.
operationId: createBtwTarief
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4349,7 +4349,7 @@ paths:
put:
tags:
- 'BtwTarieven'
- description: |
+ summary: |
Vervangen van een BtwTarief op basis van overeenkomstige sleutelvelden.
operationId: replaceBtwTarief
parameters:
@@ -4384,7 +4384,7 @@ paths:
patch:
tags:
- 'BtwTarieven'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BtwTarief. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBtwTarief
@@ -4421,7 +4421,7 @@ paths:
get:
tags:
- 'BtwTarieven'
- description: Retourneert een BtwTarief met de gegeven identifier
+ summary: Retourneert een BtwTarief met de gegeven identifier
operationId: readBtwTariefById
parameters:
- name: id
@@ -4458,7 +4458,7 @@ paths:
put:
tags:
- 'BtwTarieven'
- description: Vervangen van een BtwTarief
+ summary: Vervangen van een BtwTarief
operationId: replaceBtwTariefById
parameters:
- name: 'id'
@@ -4496,7 +4496,7 @@ paths:
patch:
tags:
- 'BtwTarieven'
- description: Wijzigen van een BtwTarief
+ summary: Wijzigen van een BtwTarief
operationId: updateBtwTariefById
parameters:
- name: 'id'
@@ -4535,7 +4535,7 @@ paths:
get:
tags:
- 'Crediteuren'
- description: Ophalen van Crediteuren
+ summary: Ophalen van Crediteuren
operationId: listCrediteuren
parameters:
- name: params
@@ -4585,7 +4585,7 @@ paths:
post:
tags:
- 'Crediteuren'
- description: Voegt een nieuw(e) Crediteur toe.
+ summary: Voegt een nieuw(e) Crediteur toe.
operationId: createCrediteur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4625,7 +4625,7 @@ paths:
put:
tags:
- 'Crediteuren'
- description: |
+ summary: |
Vervangen van een Crediteur op basis van overeenkomstige sleutelvelden.
operationId: replaceCrediteur
parameters:
@@ -4660,7 +4660,7 @@ paths:
patch:
tags:
- 'Crediteuren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Crediteur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCrediteur
@@ -4697,7 +4697,7 @@ paths:
get:
tags:
- 'Crediteuren'
- description: Retourneert een Crediteur met de gegeven identifier
+ summary: Retourneert een Crediteur met de gegeven identifier
operationId: readCrediteurById
parameters:
- name: id
@@ -4734,7 +4734,7 @@ paths:
put:
tags:
- 'Crediteuren'
- description: Vervangen van een Crediteur
+ summary: Vervangen van een Crediteur
operationId: replaceCrediteurById
parameters:
- name: 'id'
@@ -4772,7 +4772,7 @@ paths:
patch:
tags:
- 'Crediteuren'
- description: Wijzigen van een Crediteur
+ summary: Wijzigen van een Crediteur
operationId: updateCrediteurById
parameters:
- name: 'id'
@@ -4811,7 +4811,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Ophalen van Debiteuren
+ summary: Ophalen van Debiteuren
operationId: listDebiteuren
parameters:
- name: params
@@ -4861,7 +4861,7 @@ paths:
post:
tags:
- 'Debiteuren'
- description: Voegt een nieuw(e) Debiteur toe.
+ summary: Voegt een nieuw(e) Debiteur toe.
operationId: createDebiteur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4901,7 +4901,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Vervangen van een Debiteur op basis van overeenkomstige sleutelvelden.
operationId: replaceDebiteur
parameters:
@@ -4936,7 +4936,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Debiteur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDebiteur
@@ -4973,7 +4973,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Retourneert een Debiteur met de gegeven identifier
+ summary: Retourneert een Debiteur met de gegeven identifier
operationId: readDebiteurById
parameters:
- name: id
@@ -5010,7 +5010,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: Vervangen van een Debiteur
+ summary: Vervangen van een Debiteur
operationId: replaceDebiteurById
parameters:
- name: 'id'
@@ -5048,7 +5048,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: Wijzigen van een Debiteur
+ summary: Wijzigen van een Debiteur
operationId: updateDebiteurById
parameters:
- name: 'id'
@@ -5087,7 +5087,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Ophalen van ExterneIncassos
+ summary: Ophalen van ExterneIncassos
operationId: listExterneIncassos
parameters:
- name: params
@@ -5137,7 +5137,7 @@ paths:
post:
tags:
- 'ExterneIncassos'
- description: Voegt een nieuw(e) ExterneIncasso toe.
+ summary: Voegt een nieuw(e) ExterneIncasso toe.
operationId: createExterneIncasso
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5177,7 +5177,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Vervangen van een ExterneIncasso op basis van overeenkomstige sleutelvelden.
operationId: replaceExterneIncasso
parameters:
@@ -5212,7 +5212,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExterneIncasso. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExterneIncasso
@@ -5249,7 +5249,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Retourneert een ExterneIncasso met de gegeven identifier
+ summary: Retourneert een ExterneIncasso met de gegeven identifier
operationId: readExterneIncassoById
parameters:
- name: id
@@ -5286,7 +5286,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: Vervangen van een ExterneIncasso
+ summary: Vervangen van een ExterneIncasso
operationId: replaceExterneIncassoById
parameters:
- name: 'id'
@@ -5324,7 +5324,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: Wijzigen van een ExterneIncasso
+ summary: Wijzigen van een ExterneIncasso
operationId: updateExterneIncassoById
parameters:
- name: 'id'
@@ -5363,7 +5363,7 @@ paths:
get:
tags:
- 'ExterneIncassoActies'
- description: Ophalen van ExterneIncassoActies
+ summary: Ophalen van ExterneIncassoActies
operationId: listExterneIncassoActies
parameters:
- name: params
@@ -5413,7 +5413,7 @@ paths:
post:
tags:
- 'ExterneIncassoActies'
- description: Voegt een nieuw(e) ExterneIncassoActie toe.
+ summary: Voegt een nieuw(e) ExterneIncassoActie toe.
operationId: createExterneIncassoActie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5453,7 +5453,7 @@ paths:
put:
tags:
- 'ExterneIncassoActies'
- description: |
+ summary: |
Vervangen van een ExterneIncassoActie op basis van overeenkomstige sleutelvelden.
operationId: replaceExterneIncassoActie
parameters:
@@ -5488,7 +5488,7 @@ paths:
patch:
tags:
- 'ExterneIncassoActies'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExterneIncassoActie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExterneIncassoActie
@@ -5525,7 +5525,7 @@ paths:
get:
tags:
- 'ExterneIncassoActies'
- description: Retourneert een ExterneIncassoActie met de gegeven identifier
+ summary: Retourneert een ExterneIncassoActie met de gegeven identifier
operationId: readExterneIncassoActieById
parameters:
- name: id
@@ -5562,7 +5562,7 @@ paths:
put:
tags:
- 'ExterneIncassoActies'
- description: Vervangen van een ExterneIncassoActie
+ summary: Vervangen van een ExterneIncassoActie
operationId: replaceExterneIncassoActieById
parameters:
- name: 'id'
@@ -5600,7 +5600,7 @@ paths:
patch:
tags:
- 'ExterneIncassoActies'
- description: Wijzigen van een ExterneIncassoActie
+ summary: Wijzigen van een ExterneIncassoActie
operationId: updateExterneIncassoActieById
parameters:
- name: 'id'
@@ -5639,7 +5639,7 @@ paths:
get:
tags:
- 'Facturen'
- description: Ophalen van Facturen
+ summary: Ophalen van Facturen
operationId: listFacturen
parameters:
- name: params
@@ -5689,7 +5689,7 @@ paths:
post:
tags:
- 'Facturen'
- description: Voegt een nieuw(e) Factuur toe.
+ summary: Voegt een nieuw(e) Factuur toe.
operationId: createFactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5729,7 +5729,7 @@ paths:
put:
tags:
- 'Facturen'
- description: |
+ summary: |
Vervangen van een Factuur op basis van overeenkomstige sleutelvelden.
operationId: replaceFactuur
parameters:
@@ -5764,7 +5764,7 @@ paths:
patch:
tags:
- 'Facturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Factuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFactuur
@@ -5801,7 +5801,7 @@ paths:
get:
tags:
- 'Facturen'
- description: Retourneert een Factuur met de gegeven identifier
+ summary: Retourneert een Factuur met de gegeven identifier
operationId: readFactuurById
parameters:
- name: id
@@ -5838,7 +5838,7 @@ paths:
put:
tags:
- 'Facturen'
- description: Vervangen van een Factuur
+ summary: Vervangen van een Factuur
operationId: replaceFactuurById
parameters:
- name: 'id'
@@ -5876,7 +5876,7 @@ paths:
patch:
tags:
- 'Facturen'
- description: Wijzigen van een Factuur
+ summary: Wijzigen van een Factuur
operationId: updateFactuurById
parameters:
- name: 'id'
@@ -5915,7 +5915,7 @@ paths:
get:
tags:
- 'Factuurbetalingen'
- description: Ophalen van Factuurbetalingen
+ summary: Ophalen van Factuurbetalingen
operationId: listFactuurbetalingen
parameters:
- name: params
@@ -5965,7 +5965,7 @@ paths:
post:
tags:
- 'Factuurbetalingen'
- description: Voegt een nieuw(e) Factuurbetaling toe.
+ summary: Voegt een nieuw(e) Factuurbetaling toe.
operationId: createFactuurbetaling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6005,7 +6005,7 @@ paths:
put:
tags:
- 'Factuurbetalingen'
- description: |
+ summary: |
Vervangen van een Factuurbetaling op basis van overeenkomstige sleutelvelden.
operationId: replaceFactuurbetaling
parameters:
@@ -6040,7 +6040,7 @@ paths:
patch:
tags:
- 'Factuurbetalingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Factuurbetaling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFactuurbetaling
@@ -6077,7 +6077,7 @@ paths:
get:
tags:
- 'Factuurbetalingen'
- description: Retourneert een Factuurbetaling met de gegeven identifier
+ summary: Retourneert een Factuurbetaling met de gegeven identifier
operationId: readFactuurbetalingById
parameters:
- name: id
@@ -6114,7 +6114,7 @@ paths:
put:
tags:
- 'Factuurbetalingen'
- description: Vervangen van een Factuurbetaling
+ summary: Vervangen van een Factuurbetaling
operationId: replaceFactuurbetalingById
parameters:
- name: 'id'
@@ -6152,7 +6152,7 @@ paths:
patch:
tags:
- 'Factuurbetalingen'
- description: Wijzigen van een Factuurbetaling
+ summary: Wijzigen van een Factuurbetaling
operationId: updateFactuurbetalingById
parameters:
- name: 'id'
@@ -6191,7 +6191,7 @@ paths:
get:
tags:
- 'Factuurregels'
- description: Ophalen van Factuurregels
+ summary: Ophalen van Factuurregels
operationId: listFactuurregels
parameters:
- name: params
@@ -6241,7 +6241,7 @@ paths:
post:
tags:
- 'Factuurregels'
- description: Voegt een nieuw(e) Factuurregel toe.
+ summary: Voegt een nieuw(e) Factuurregel toe.
operationId: createFactuurregel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6281,7 +6281,7 @@ paths:
put:
tags:
- 'Factuurregels'
- description: |
+ summary: |
Vervangen van een Factuurregel op basis van overeenkomstige sleutelvelden.
operationId: replaceFactuurregel
parameters:
@@ -6316,7 +6316,7 @@ paths:
patch:
tags:
- 'Factuurregels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Factuurregel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFactuurregel
@@ -6353,7 +6353,7 @@ paths:
get:
tags:
- 'Factuurregels'
- description: Retourneert een Factuurregel met de gegeven identifier
+ summary: Retourneert een Factuurregel met de gegeven identifier
operationId: readFactuurregelById
parameters:
- name: id
@@ -6390,7 +6390,7 @@ paths:
put:
tags:
- 'Factuurregels'
- description: Vervangen van een Factuurregel
+ summary: Vervangen van een Factuurregel
operationId: replaceFactuurregelById
parameters:
- name: 'id'
@@ -6428,7 +6428,7 @@ paths:
patch:
tags:
- 'Factuurregels'
- description: Wijzigen van een Factuurregel
+ summary: Wijzigen van een Factuurregel
operationId: updateFactuurregelById
parameters:
- name: 'id'
@@ -6467,7 +6467,7 @@ paths:
get:
tags:
- 'FinancieelBedrijven'
- description: Ophalen van FinancieelBedrijven
+ summary: Ophalen van FinancieelBedrijven
operationId: listFinancieelBedrijven
parameters:
- name: params
@@ -6517,7 +6517,7 @@ paths:
post:
tags:
- 'FinancieelBedrijven'
- description: Voegt een nieuw(e) FinancieelBedrijf toe.
+ summary: Voegt een nieuw(e) FinancieelBedrijf toe.
operationId: createFinancieelBedrijf
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6557,7 +6557,7 @@ paths:
put:
tags:
- 'FinancieelBedrijven'
- description: |
+ summary: |
Vervangen van een FinancieelBedrijf op basis van overeenkomstige sleutelvelden.
operationId: replaceFinancieelBedrijf
parameters:
@@ -6592,7 +6592,7 @@ paths:
patch:
tags:
- 'FinancieelBedrijven'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een FinancieelBedrijf. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFinancieelBedrijf
@@ -6629,7 +6629,7 @@ paths:
get:
tags:
- 'FinancieelBedrijven'
- description: Retourneert een FinancieelBedrijf met de gegeven identifier
+ summary: Retourneert een FinancieelBedrijf met de gegeven identifier
operationId: readFinancieelBedrijfById
parameters:
- name: id
@@ -6666,7 +6666,7 @@ paths:
put:
tags:
- 'FinancieelBedrijven'
- description: Vervangen van een FinancieelBedrijf
+ summary: Vervangen van een FinancieelBedrijf
operationId: replaceFinancieelBedrijfById
parameters:
- name: 'id'
@@ -6704,7 +6704,7 @@ paths:
patch:
tags:
- 'FinancieelBedrijven'
- description: Wijzigen van een FinancieelBedrijf
+ summary: Wijzigen van een FinancieelBedrijf
operationId: updateFinancieelBedrijfById
parameters:
- name: 'id'
@@ -6743,7 +6743,7 @@ paths:
get:
tags:
- 'Grootboekmutaties'
- description: Ophalen van Grootboekmutaties
+ summary: Ophalen van Grootboekmutaties
operationId: listGrootboekmutaties
parameters:
- name: params
@@ -6793,7 +6793,7 @@ paths:
post:
tags:
- 'Grootboekmutaties'
- description: Voegt een nieuw(e) Grootboekmutatie toe.
+ summary: Voegt een nieuw(e) Grootboekmutatie toe.
operationId: createGrootboekmutatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6833,7 +6833,7 @@ paths:
put:
tags:
- 'Grootboekmutaties'
- description: |
+ summary: |
Vervangen van een Grootboekmutatie op basis van overeenkomstige sleutelvelden.
operationId: replaceGrootboekmutatie
parameters:
@@ -6868,7 +6868,7 @@ paths:
patch:
tags:
- 'Grootboekmutaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Grootboekmutatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGrootboekmutatie
@@ -6905,7 +6905,7 @@ paths:
get:
tags:
- 'Grootboekmutaties'
- description: Retourneert een Grootboekmutatie met de gegeven identifier
+ summary: Retourneert een Grootboekmutatie met de gegeven identifier
operationId: readGrootboekmutatieById
parameters:
- name: id
@@ -6942,7 +6942,7 @@ paths:
put:
tags:
- 'Grootboekmutaties'
- description: Vervangen van een Grootboekmutatie
+ summary: Vervangen van een Grootboekmutatie
operationId: replaceGrootboekmutatieById
parameters:
- name: 'id'
@@ -6980,7 +6980,7 @@ paths:
patch:
tags:
- 'Grootboekmutaties'
- description: Wijzigen van een Grootboekmutatie
+ summary: Wijzigen van een Grootboekmutatie
operationId: updateGrootboekmutatieById
parameters:
- name: 'id'
@@ -7019,7 +7019,7 @@ paths:
get:
tags:
- 'Grootboekrekeningen'
- description: Ophalen van Grootboekrekeningen
+ summary: Ophalen van Grootboekrekeningen
operationId: listGrootboekrekeningen
parameters:
- name: params
@@ -7069,7 +7069,7 @@ paths:
post:
tags:
- 'Grootboekrekeningen'
- description: Voegt een nieuw(e) Grootboekrekening toe.
+ summary: Voegt een nieuw(e) Grootboekrekening toe.
operationId: createGrootboekrekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7109,7 +7109,7 @@ paths:
put:
tags:
- 'Grootboekrekeningen'
- description: |
+ summary: |
Vervangen van een Grootboekrekening op basis van overeenkomstige sleutelvelden.
operationId: replaceGrootboekrekening
parameters:
@@ -7144,7 +7144,7 @@ paths:
patch:
tags:
- 'Grootboekrekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Grootboekrekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGrootboekrekening
@@ -7181,7 +7181,7 @@ paths:
get:
tags:
- 'Grootboekrekeningen'
- description: Retourneert een Grootboekrekening met de gegeven identifier
+ summary: Retourneert een Grootboekrekening met de gegeven identifier
operationId: readGrootboekrekeningById
parameters:
- name: id
@@ -7218,7 +7218,7 @@ paths:
put:
tags:
- 'Grootboekrekeningen'
- description: Vervangen van een Grootboekrekening
+ summary: Vervangen van een Grootboekrekening
operationId: replaceGrootboekrekeningById
parameters:
- name: 'id'
@@ -7256,7 +7256,7 @@ paths:
patch:
tags:
- 'Grootboekrekeningen'
- description: Wijzigen van een Grootboekrekening
+ summary: Wijzigen van een Grootboekrekening
operationId: updateGrootboekrekeningById
parameters:
- name: 'id'
@@ -7295,7 +7295,7 @@ paths:
get:
tags:
- 'Incassomachtigingen'
- description: Ophalen van Incassomachtigingen
+ summary: Ophalen van Incassomachtigingen
operationId: listIncassomachtigingen
parameters:
- name: params
@@ -7345,7 +7345,7 @@ paths:
post:
tags:
- 'Incassomachtigingen'
- description: Voegt een nieuw(e) Incassomachtiging toe.
+ summary: Voegt een nieuw(e) Incassomachtiging toe.
operationId: createIncassomachtiging
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7385,7 +7385,7 @@ paths:
put:
tags:
- 'Incassomachtigingen'
- description: |
+ summary: |
Vervangen van een Incassomachtiging op basis van overeenkomstige sleutelvelden.
operationId: replaceIncassomachtiging
parameters:
@@ -7420,7 +7420,7 @@ paths:
patch:
tags:
- 'Incassomachtigingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Incassomachtiging. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateIncassomachtiging
@@ -7457,7 +7457,7 @@ paths:
get:
tags:
- 'Incassomachtigingen'
- description: Retourneert een Incassomachtiging met de gegeven identifier
+ summary: Retourneert een Incassomachtiging met de gegeven identifier
operationId: readIncassomachtigingById
parameters:
- name: id
@@ -7494,7 +7494,7 @@ paths:
put:
tags:
- 'Incassomachtigingen'
- description: Vervangen van een Incassomachtiging
+ summary: Vervangen van een Incassomachtiging
operationId: replaceIncassomachtigingById
parameters:
- name: 'id'
@@ -7532,7 +7532,7 @@ paths:
patch:
tags:
- 'Incassomachtigingen'
- description: Wijzigen van een Incassomachtiging
+ summary: Wijzigen van een Incassomachtiging
operationId: updateIncassomachtigingById
parameters:
- name: 'id'
@@ -7571,7 +7571,7 @@ paths:
get:
tags:
- 'IncassoOpdrachten'
- description: Ophalen van IncassoOpdrachten
+ summary: Ophalen van IncassoOpdrachten
operationId: listIncassoOpdrachten
parameters:
- name: params
@@ -7621,7 +7621,7 @@ paths:
post:
tags:
- 'IncassoOpdrachten'
- description: Voegt een nieuw(e) IncassoOpdracht toe.
+ summary: Voegt een nieuw(e) IncassoOpdracht toe.
operationId: createIncassoOpdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7661,7 +7661,7 @@ paths:
put:
tags:
- 'IncassoOpdrachten'
- description: |
+ summary: |
Vervangen van een IncassoOpdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceIncassoOpdracht
parameters:
@@ -7696,7 +7696,7 @@ paths:
patch:
tags:
- 'IncassoOpdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een IncassoOpdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateIncassoOpdracht
@@ -7733,7 +7733,7 @@ paths:
get:
tags:
- 'IncassoOpdrachten'
- description: Retourneert een IncassoOpdracht met de gegeven identifier
+ summary: Retourneert een IncassoOpdracht met de gegeven identifier
operationId: readIncassoOpdrachtById
parameters:
- name: id
@@ -7770,7 +7770,7 @@ paths:
put:
tags:
- 'IncassoOpdrachten'
- description: Vervangen van een IncassoOpdracht
+ summary: Vervangen van een IncassoOpdracht
operationId: replaceIncassoOpdrachtById
parameters:
- name: 'id'
@@ -7808,7 +7808,7 @@ paths:
patch:
tags:
- 'IncassoOpdrachten'
- description: Wijzigen van een IncassoOpdracht
+ summary: Wijzigen van een IncassoOpdracht
operationId: updateIncassoOpdrachtById
parameters:
- name: 'id'
@@ -7847,7 +7847,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Ophalen van Inkoopfacturen
+ summary: Ophalen van Inkoopfacturen
operationId: listInkoopfacturen
parameters:
- name: params
@@ -7897,7 +7897,7 @@ paths:
post:
tags:
- 'Inkoopfacturen'
- description: Voegt een nieuw(e) Inkoopfactuur toe.
+ summary: Voegt een nieuw(e) Inkoopfactuur toe.
operationId: createInkoopfactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7937,7 +7937,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Vervangen van een Inkoopfactuur op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopfactuur
parameters:
@@ -7972,7 +7972,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkoopfactuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopfactuur
@@ -8009,7 +8009,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Retourneert een Inkoopfactuur met de gegeven identifier
+ summary: Retourneert een Inkoopfactuur met de gegeven identifier
operationId: readInkoopfactuurById
parameters:
- name: id
@@ -8046,7 +8046,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: Vervangen van een Inkoopfactuur
+ summary: Vervangen van een Inkoopfactuur
operationId: replaceInkoopfactuurById
parameters:
- name: 'id'
@@ -8084,7 +8084,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: Wijzigen van een Inkoopfactuur
+ summary: Wijzigen van een Inkoopfactuur
operationId: updateInkoopfactuurById
parameters:
- name: 'id'
@@ -8123,7 +8123,7 @@ paths:
get:
tags:
- 'InkoopfactuurRegels'
- description: Ophalen van InkoopfactuurRegels
+ summary: Ophalen van InkoopfactuurRegels
operationId: listInkoopfactuurRegels
parameters:
- name: params
@@ -8173,7 +8173,7 @@ paths:
post:
tags:
- 'InkoopfactuurRegels'
- description: Voegt een nieuw(e) InkoopfactuurRegel toe.
+ summary: Voegt een nieuw(e) InkoopfactuurRegel toe.
operationId: createInkoopfactuurRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8213,7 +8213,7 @@ paths:
put:
tags:
- 'InkoopfactuurRegels'
- description: |
+ summary: |
Vervangen van een InkoopfactuurRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopfactuurRegel
parameters:
@@ -8248,7 +8248,7 @@ paths:
patch:
tags:
- 'InkoopfactuurRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een InkoopfactuurRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopfactuurRegel
@@ -8285,7 +8285,7 @@ paths:
get:
tags:
- 'InkoopfactuurRegels'
- description: Retourneert een InkoopfactuurRegel met de gegeven identifier
+ summary: Retourneert een InkoopfactuurRegel met de gegeven identifier
operationId: readInkoopfactuurRegelById
parameters:
- name: id
@@ -8322,7 +8322,7 @@ paths:
put:
tags:
- 'InkoopfactuurRegels'
- description: Vervangen van een InkoopfactuurRegel
+ summary: Vervangen van een InkoopfactuurRegel
operationId: replaceInkoopfactuurRegelById
parameters:
- name: 'id'
@@ -8360,7 +8360,7 @@ paths:
patch:
tags:
- 'InkoopfactuurRegels'
- description: Wijzigen van een InkoopfactuurRegel
+ summary: Wijzigen van een InkoopfactuurRegel
operationId: updateInkoopfactuurRegelById
parameters:
- name: 'id'
@@ -8399,7 +8399,7 @@ paths:
get:
tags:
- 'Inkoopopdrachten'
- description: Ophalen van Inkoopopdrachten
+ summary: Ophalen van Inkoopopdrachten
operationId: listInkoopopdrachten
parameters:
- name: params
@@ -8449,7 +8449,7 @@ paths:
post:
tags:
- 'Inkoopopdrachten'
- description: Voegt een nieuw(e) Inkoopopdracht toe.
+ summary: Voegt een nieuw(e) Inkoopopdracht toe.
operationId: createInkoopopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8489,7 +8489,7 @@ paths:
put:
tags:
- 'Inkoopopdrachten'
- description: |
+ summary: |
Vervangen van een Inkoopopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopopdracht
parameters:
@@ -8524,7 +8524,7 @@ paths:
patch:
tags:
- 'Inkoopopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkoopopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopopdracht
@@ -8561,7 +8561,7 @@ paths:
get:
tags:
- 'Inkoopopdrachten'
- description: Retourneert een Inkoopopdracht met de gegeven identifier
+ summary: Retourneert een Inkoopopdracht met de gegeven identifier
operationId: readInkoopopdrachtById
parameters:
- name: id
@@ -8598,7 +8598,7 @@ paths:
put:
tags:
- 'Inkoopopdrachten'
- description: Vervangen van een Inkoopopdracht
+ summary: Vervangen van een Inkoopopdracht
operationId: replaceInkoopopdrachtById
parameters:
- name: 'id'
@@ -8636,7 +8636,7 @@ paths:
patch:
tags:
- 'Inkoopopdrachten'
- description: Wijzigen van een Inkoopopdracht
+ summary: Wijzigen van een Inkoopopdracht
operationId: updateInkoopopdrachtById
parameters:
- name: 'id'
@@ -8675,7 +8675,7 @@ paths:
get:
tags:
- 'InkoopopdrachtRegels'
- description: Ophalen van InkoopopdrachtRegels
+ summary: Ophalen van InkoopopdrachtRegels
operationId: listInkoopopdrachtRegels
parameters:
- name: params
@@ -8725,7 +8725,7 @@ paths:
post:
tags:
- 'InkoopopdrachtRegels'
- description: Voegt een nieuw(e) InkoopopdrachtRegel toe.
+ summary: Voegt een nieuw(e) InkoopopdrachtRegel toe.
operationId: createInkoopopdrachtRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8765,7 +8765,7 @@ paths:
put:
tags:
- 'InkoopopdrachtRegels'
- description: |
+ summary: |
Vervangen van een InkoopopdrachtRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopopdrachtRegel
parameters:
@@ -8800,7 +8800,7 @@ paths:
patch:
tags:
- 'InkoopopdrachtRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een InkoopopdrachtRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopopdrachtRegel
@@ -8837,7 +8837,7 @@ paths:
get:
tags:
- 'InkoopopdrachtRegels'
- description: Retourneert een InkoopopdrachtRegel met de gegeven identifier
+ summary: Retourneert een InkoopopdrachtRegel met de gegeven identifier
operationId: readInkoopopdrachtRegelById
parameters:
- name: id
@@ -8874,7 +8874,7 @@ paths:
put:
tags:
- 'InkoopopdrachtRegels'
- description: Vervangen van een InkoopopdrachtRegel
+ summary: Vervangen van een InkoopopdrachtRegel
operationId: replaceInkoopopdrachtRegelById
parameters:
- name: 'id'
@@ -8912,7 +8912,7 @@ paths:
patch:
tags:
- 'InkoopopdrachtRegels'
- description: Wijzigen van een InkoopopdrachtRegel
+ summary: Wijzigen van een InkoopopdrachtRegel
operationId: updateInkoopopdrachtRegelById
parameters:
- name: 'id'
@@ -8951,7 +8951,7 @@ paths:
get:
tags:
- 'Leningen'
- description: Ophalen van Leningen
+ summary: Ophalen van Leningen
operationId: listLeningen
parameters:
- name: params
@@ -9001,7 +9001,7 @@ paths:
post:
tags:
- 'Leningen'
- description: Voegt een nieuw(e) Lening toe.
+ summary: Voegt een nieuw(e) Lening toe.
operationId: createLening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9041,7 +9041,7 @@ paths:
put:
tags:
- 'Leningen'
- description: |
+ summary: |
Vervangen van een Lening op basis van overeenkomstige sleutelvelden.
operationId: replaceLening
parameters:
@@ -9076,7 +9076,7 @@ paths:
patch:
tags:
- 'Leningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Lening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateLening
@@ -9113,7 +9113,7 @@ paths:
get:
tags:
- 'Leningen'
- description: Retourneert een Lening met de gegeven identifier
+ summary: Retourneert een Lening met de gegeven identifier
operationId: readLeningById
parameters:
- name: id
@@ -9150,7 +9150,7 @@ paths:
put:
tags:
- 'Leningen'
- description: Vervangen van een Lening
+ summary: Vervangen van een Lening
operationId: replaceLeningById
parameters:
- name: 'id'
@@ -9188,7 +9188,7 @@ paths:
patch:
tags:
- 'Leningen'
- description: Wijzigen van een Lening
+ summary: Wijzigen van een Lening
operationId: updateLeningById
parameters:
- name: 'id'
@@ -9227,7 +9227,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Ophalen van Offertes
+ summary: Ophalen van Offertes
operationId: listOffertes
parameters:
- name: params
@@ -9277,7 +9277,7 @@ paths:
post:
tags:
- 'Offertes'
- description: Voegt een nieuw(e) Offerte toe.
+ summary: Voegt een nieuw(e) Offerte toe.
operationId: createOfferte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9317,7 +9317,7 @@ paths:
put:
tags:
- 'Offertes'
- description: |
+ summary: |
Vervangen van een Offerte op basis van overeenkomstige sleutelvelden.
operationId: replaceOfferte
parameters:
@@ -9352,7 +9352,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Offerte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOfferte
@@ -9389,7 +9389,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Retourneert een Offerte met de gegeven identifier
+ summary: Retourneert een Offerte met de gegeven identifier
operationId: readOfferteById
parameters:
- name: id
@@ -9426,7 +9426,7 @@ paths:
put:
tags:
- 'Offertes'
- description: Vervangen van een Offerte
+ summary: Vervangen van een Offerte
operationId: replaceOfferteById
parameters:
- name: 'id'
@@ -9464,7 +9464,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: Wijzigen van een Offerte
+ summary: Wijzigen van een Offerte
operationId: updateOfferteById
parameters:
- name: 'id'
@@ -9503,7 +9503,7 @@ paths:
get:
tags:
- 'Offerteregels'
- description: Ophalen van Offerteregels
+ summary: Ophalen van Offerteregels
operationId: listOfferteregels
parameters:
- name: params
@@ -9553,7 +9553,7 @@ paths:
post:
tags:
- 'Offerteregels'
- description: Voegt een nieuw(e) Offerteregel toe.
+ summary: Voegt een nieuw(e) Offerteregel toe.
operationId: createOfferteregel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9593,7 +9593,7 @@ paths:
put:
tags:
- 'Offerteregels'
- description: |
+ summary: |
Vervangen van een Offerteregel op basis van overeenkomstige sleutelvelden.
operationId: replaceOfferteregel
parameters:
@@ -9628,7 +9628,7 @@ paths:
patch:
tags:
- 'Offerteregels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Offerteregel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOfferteregel
@@ -9665,7 +9665,7 @@ paths:
get:
tags:
- 'Offerteregels'
- description: Retourneert een Offerteregel met de gegeven identifier
+ summary: Retourneert een Offerteregel met de gegeven identifier
operationId: readOfferteregelById
parameters:
- name: id
@@ -9702,7 +9702,7 @@ paths:
put:
tags:
- 'Offerteregels'
- description: Vervangen van een Offerteregel
+ summary: Vervangen van een Offerteregel
operationId: replaceOfferteregelById
parameters:
- name: 'id'
@@ -9740,7 +9740,7 @@ paths:
patch:
tags:
- 'Offerteregels'
- description: Wijzigen van een Offerteregel
+ summary: Wijzigen van een Offerteregel
operationId: updateOfferteregelById
parameters:
- name: 'id'
@@ -9779,7 +9779,7 @@ paths:
get:
tags:
- 'Prijsaanpassingen'
- description: Ophalen van Prijsaanpassingen
+ summary: Ophalen van Prijsaanpassingen
operationId: listPrijsaanpassingen
parameters:
- name: params
@@ -9829,7 +9829,7 @@ paths:
post:
tags:
- 'Prijsaanpassingen'
- description: Voegt een nieuw(e) Prijsaanpassing toe.
+ summary: Voegt een nieuw(e) Prijsaanpassing toe.
operationId: createPrijsaanpassing
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9869,7 +9869,7 @@ paths:
put:
tags:
- 'Prijsaanpassingen'
- description: |
+ summary: |
Vervangen van een Prijsaanpassing op basis van overeenkomstige sleutelvelden.
operationId: replacePrijsaanpassing
parameters:
@@ -9904,7 +9904,7 @@ paths:
patch:
tags:
- 'Prijsaanpassingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Prijsaanpassing. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePrijsaanpassing
@@ -9941,7 +9941,7 @@ paths:
get:
tags:
- 'Prijsaanpassingen'
- description: Retourneert een Prijsaanpassing met de gegeven identifier
+ summary: Retourneert een Prijsaanpassing met de gegeven identifier
operationId: readPrijsaanpassingById
parameters:
- name: id
@@ -9978,7 +9978,7 @@ paths:
put:
tags:
- 'Prijsaanpassingen'
- description: Vervangen van een Prijsaanpassing
+ summary: Vervangen van een Prijsaanpassing
operationId: replacePrijsaanpassingById
parameters:
- name: 'id'
@@ -10016,7 +10016,7 @@ paths:
patch:
tags:
- 'Prijsaanpassingen'
- description: Wijzigen van een Prijsaanpassing
+ summary: Wijzigen van een Prijsaanpassing
operationId: updatePrijsaanpassingById
parameters:
- name: 'id'
@@ -10055,7 +10055,7 @@ paths:
get:
tags:
- 'ToegelatenInstellingen'
- description: Ophalen van ToegelatenInstellingen
+ summary: Ophalen van ToegelatenInstellingen
operationId: listToegelatenInstellingen
parameters:
- name: params
@@ -10105,7 +10105,7 @@ paths:
post:
tags:
- 'ToegelatenInstellingen'
- description: Voegt een nieuw(e) ToegelatenInstelling toe.
+ summary: Voegt een nieuw(e) ToegelatenInstelling toe.
operationId: createToegelatenInstelling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10145,7 +10145,7 @@ paths:
put:
tags:
- 'ToegelatenInstellingen'
- description: |
+ summary: |
Vervangen van een ToegelatenInstelling op basis van overeenkomstige sleutelvelden.
operationId: replaceToegelatenInstelling
parameters:
@@ -10180,7 +10180,7 @@ paths:
patch:
tags:
- 'ToegelatenInstellingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ToegelatenInstelling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateToegelatenInstelling
@@ -10217,7 +10217,7 @@ paths:
get:
tags:
- 'ToegelatenInstellingen'
- description: Retourneert een ToegelatenInstelling met de gegeven identifier
+ summary: Retourneert een ToegelatenInstelling met de gegeven identifier
operationId: readToegelatenInstellingById
parameters:
- name: id
@@ -10254,7 +10254,7 @@ paths:
put:
tags:
- 'ToegelatenInstellingen'
- description: Vervangen van een ToegelatenInstelling
+ summary: Vervangen van een ToegelatenInstelling
operationId: replaceToegelatenInstellingById
parameters:
- name: 'id'
@@ -10292,7 +10292,7 @@ paths:
patch:
tags:
- 'ToegelatenInstellingen'
- description: Wijzigen van een ToegelatenInstelling
+ summary: Wijzigen van een ToegelatenInstelling
operationId: updateToegelatenInstellingById
parameters:
- name: 'id'
@@ -10331,7 +10331,7 @@ paths:
get:
tags:
- 'Verbijzonderingen'
- description: Ophalen van Verbijzonderingen
+ summary: Ophalen van Verbijzonderingen
operationId: listVerbijzonderingen
parameters:
- name: params
@@ -10381,7 +10381,7 @@ paths:
post:
tags:
- 'Verbijzonderingen'
- description: Voegt een nieuw(e) Verbijzondering toe.
+ summary: Voegt een nieuw(e) Verbijzondering toe.
operationId: createVerbijzondering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10421,7 +10421,7 @@ paths:
put:
tags:
- 'Verbijzonderingen'
- description: |
+ summary: |
Vervangen van een Verbijzondering op basis van overeenkomstige sleutelvelden.
operationId: replaceVerbijzondering
parameters:
@@ -10456,7 +10456,7 @@ paths:
patch:
tags:
- 'Verbijzonderingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Verbijzondering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVerbijzondering
@@ -10493,7 +10493,7 @@ paths:
get:
tags:
- 'Verbijzonderingen'
- description: Retourneert een Verbijzondering met de gegeven identifier
+ summary: Retourneert een Verbijzondering met de gegeven identifier
operationId: readVerbijzonderingById
parameters:
- name: id
@@ -10530,7 +10530,7 @@ paths:
put:
tags:
- 'Verbijzonderingen'
- description: Vervangen van een Verbijzondering
+ summary: Vervangen van een Verbijzondering
operationId: replaceVerbijzonderingById
parameters:
- name: 'id'
@@ -10568,7 +10568,7 @@ paths:
patch:
tags:
- 'Verbijzonderingen'
- description: Wijzigen van een Verbijzondering
+ summary: Wijzigen van een Verbijzondering
operationId: updateVerbijzonderingById
parameters:
- name: 'id'
@@ -10607,7 +10607,7 @@ paths:
get:
tags:
- 'Verkoopfacturen'
- description: Ophalen van Verkoopfacturen
+ summary: Ophalen van Verkoopfacturen
operationId: listVerkoopfacturen
parameters:
- name: params
@@ -10657,7 +10657,7 @@ paths:
post:
tags:
- 'Verkoopfacturen'
- description: Voegt een nieuw(e) Verkoopfactuur toe.
+ summary: Voegt een nieuw(e) Verkoopfactuur toe.
operationId: createVerkoopfactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10697,7 +10697,7 @@ paths:
put:
tags:
- 'Verkoopfacturen'
- description: |
+ summary: |
Vervangen van een Verkoopfactuur op basis van overeenkomstige sleutelvelden.
operationId: replaceVerkoopfactuur
parameters:
@@ -10732,7 +10732,7 @@ paths:
patch:
tags:
- 'Verkoopfacturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Verkoopfactuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVerkoopfactuur
@@ -10769,7 +10769,7 @@ paths:
get:
tags:
- 'Verkoopfacturen'
- description: Retourneert een Verkoopfactuur met de gegeven identifier
+ summary: Retourneert een Verkoopfactuur met de gegeven identifier
operationId: readVerkoopfactuurById
parameters:
- name: id
@@ -10806,7 +10806,7 @@ paths:
put:
tags:
- 'Verkoopfacturen'
- description: Vervangen van een Verkoopfactuur
+ summary: Vervangen van een Verkoopfactuur
operationId: replaceVerkoopfactuurById
parameters:
- name: 'id'
@@ -10844,7 +10844,7 @@ paths:
patch:
tags:
- 'Verkoopfacturen'
- description: Wijzigen van een Verkoopfactuur
+ summary: Wijzigen van een Verkoopfactuur
operationId: updateVerkoopfactuurById
parameters:
- name: 'id'
@@ -10916,10 +10916,94 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Financien.All.Read: alleen lezen van alle resources
+ Financien.All.ReadWrite: lezen en schrijven van alle resources
+ Financien.Aanbestedingen.Read: alleen lezen van Aanbestedingen
+ Financien.Aanbestedingen.ReadWrite: lezen en schrijven van Aanbestedingen
+ Financien.Afletteringen.Read: alleen lezen van Afletteringen
+ Financien.Afletteringen.ReadWrite: lezen en schrijven van Afletteringen
+ Financien.Bankafschriften.Read: alleen lezen van Bankafschriften
+ Financien.Bankafschriften.ReadWrite: lezen en schrijven van Bankafschriften
+ Financien.BankafschriftRegels.Read: alleen lezen van BankafschriftRegels
+ Financien.BankafschriftRegels.ReadWrite: lezen en schrijven van BankafschriftRegels
+ Financien.Begrotingen.Read: alleen lezen van Begrotingen
+ Financien.Begrotingen.ReadWrite: lezen en schrijven van Begrotingen
+ Financien.Betaalopdrachten.Read: alleen lezen van Betaalopdrachten
+ Financien.Betaalopdrachten.ReadWrite: lezen en schrijven van Betaalopdrachten
+ Financien.Betaalwijzen.Read: alleen lezen van Betaalwijzen
+ Financien.Betaalwijzen.ReadWrite: lezen en schrijven van Betaalwijzen
+ Financien.Betalingsregelingen.Read: alleen lezen van Betalingsregelingen
+ Financien.Betalingsregelingen.ReadWrite: lezen en schrijven van Betalingsregelingen
+ Financien.BetalingsregelingTermijnen.Read: alleen lezen van BetalingsregelingTermijnen
+ Financien.BetalingsregelingTermijnen.ReadWrite: lezen en schrijven van BetalingsregelingTermijnen
+ Financien.Boekingen.Read: alleen lezen van Boekingen
+ Financien.Boekingen.ReadWrite: lezen en schrijven van Boekingen
+ Financien.Boekingdetails.Read: alleen lezen van Boekingdetails
+ Financien.Boekingdetails.ReadWrite: lezen en schrijven van Boekingdetails
+ Financien.Boekjaren.Read: alleen lezen van Boekjaren
+ Financien.Boekjaren.ReadWrite: lezen en schrijven van Boekjaren
+ Financien.BoekjaarPerioden.Read: alleen lezen van BoekjaarPerioden
+ Financien.BoekjaarPerioden.ReadWrite: lezen en schrijven van BoekjaarPerioden
+ Financien.BoekjaarPeriodesaldos.Read: alleen lezen van BoekjaarPeriodesaldos
+ Financien.BoekjaarPeriodesaldos.ReadWrite: lezen en schrijven van BoekjaarPeriodesaldos
+ Financien.BtwAangiften.Read: alleen lezen van BtwAangiften
+ Financien.BtwAangiften.ReadWrite: lezen en schrijven van BtwAangiften
+ Financien.BtwTarieven.Read: alleen lezen van BtwTarieven
+ Financien.BtwTarieven.ReadWrite: lezen en schrijven van BtwTarieven
+ Financien.Crediteuren.Read: alleen lezen van Crediteuren
+ Financien.Crediteuren.ReadWrite: lezen en schrijven van Crediteuren
+ Financien.Debiteuren.Read: alleen lezen van Debiteuren
+ Financien.Debiteuren.ReadWrite: lezen en schrijven van Debiteuren
+ Financien.ExterneIncassos.Read: alleen lezen van ExterneIncassos
+ Financien.ExterneIncassos.ReadWrite: lezen en schrijven van ExterneIncassos
+ Financien.ExterneIncassoActies.Read: alleen lezen van ExterneIncassoActies
+ Financien.ExterneIncassoActies.ReadWrite: lezen en schrijven van ExterneIncassoActies
+ Financien.Facturen.Read: alleen lezen van Facturen
+ Financien.Facturen.ReadWrite: lezen en schrijven van Facturen
+ Financien.Factuurbetalingen.Read: alleen lezen van Factuurbetalingen
+ Financien.Factuurbetalingen.ReadWrite: lezen en schrijven van Factuurbetalingen
+ Financien.Factuurregels.Read: alleen lezen van Factuurregels
+ Financien.Factuurregels.ReadWrite: lezen en schrijven van Factuurregels
+ Financien.FinancieelBedrijven.Read: alleen lezen van FinancieelBedrijven
+ Financien.FinancieelBedrijven.ReadWrite: lezen en schrijven van FinancieelBedrijven
+ Financien.Grootboekmutaties.Read: alleen lezen van Grootboekmutaties
+ Financien.Grootboekmutaties.ReadWrite: lezen en schrijven van Grootboekmutaties
+ Financien.Grootboekrekeningen.Read: alleen lezen van Grootboekrekeningen
+ Financien.Grootboekrekeningen.ReadWrite: lezen en schrijven van Grootboekrekeningen
+ Financien.Incassomachtigingen.Read: alleen lezen van Incassomachtigingen
+ Financien.Incassomachtigingen.ReadWrite: lezen en schrijven van Incassomachtigingen
+ Financien.IncassoOpdrachten.Read: alleen lezen van IncassoOpdrachten
+ Financien.IncassoOpdrachten.ReadWrite: lezen en schrijven van IncassoOpdrachten
+ Financien.Inkoopfacturen.Read: alleen lezen van Inkoopfacturen
+ Financien.Inkoopfacturen.ReadWrite: lezen en schrijven van Inkoopfacturen
+ Financien.InkoopfactuurRegels.Read: alleen lezen van InkoopfactuurRegels
+ Financien.InkoopfactuurRegels.ReadWrite: lezen en schrijven van InkoopfactuurRegels
+ Financien.Inkoopopdrachten.Read: alleen lezen van Inkoopopdrachten
+ Financien.Inkoopopdrachten.ReadWrite: lezen en schrijven van Inkoopopdrachten
+ Financien.InkoopopdrachtRegels.Read: alleen lezen van InkoopopdrachtRegels
+ Financien.InkoopopdrachtRegels.ReadWrite: lezen en schrijven van InkoopopdrachtRegels
+ Financien.Leningen.Read: alleen lezen van Leningen
+ Financien.Leningen.ReadWrite: lezen en schrijven van Leningen
+ Financien.Offertes.Read: alleen lezen van Offertes
+ Financien.Offertes.ReadWrite: lezen en schrijven van Offertes
+ Financien.Offerteregels.Read: alleen lezen van Offerteregels
+ Financien.Offerteregels.ReadWrite: lezen en schrijven van Offerteregels
+ Financien.Prijsaanpassingen.Read: alleen lezen van Prijsaanpassingen
+ Financien.Prijsaanpassingen.ReadWrite: lezen en schrijven van Prijsaanpassingen
+ Financien.ToegelatenInstellingen.Read: alleen lezen van ToegelatenInstellingen
+ Financien.ToegelatenInstellingen.ReadWrite: lezen en schrijven van ToegelatenInstellingen
+ Financien.Verbijzonderingen.Read: alleen lezen van Verbijzonderingen
+ Financien.Verbijzonderingen.ReadWrite: lezen en schrijven van Verbijzonderingen
+ Financien.Verkoopfacturen.Read: alleen lezen van Verkoopfacturen
+ Financien.Verkoopfacturen.ReadWrite: lezen en schrijven van Verkoopfacturen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Financien.All.Read: alleen lezen van alle resources
Financien.All.ReadWrite: lezen en schrijven van alle resources
@@ -11069,17 +11153,13 @@ components:
description: Het afgeletterde bedrag.
huurBoeking:
allOf:
- - $ref: '#/components/schemas/Boeking'
+ - $ref: '#/components/schemas/Boeking-sleutels'
description: Boeking die ten grondslag ligt aan de aflettering.
tegenHuurBoeking:
allOf:
- - $ref: '#/components/schemas/Boeking'
+ - $ref: '#/components/schemas/Boeking-sleutels'
description: Boeking waarop is afgeletterd.
- Boekingbericht:
- allOf:
- - $ref: '#/components/schemas/Boeking'
- - $ref: '#/components/schemas/Bericht-basis'
- Boeking:
+ Boeking-sleutels:
type: object
properties:
id:
@@ -11098,155 +11178,70 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort boeking. Bijvoorbeeld;vordering, ontvangst of uitbetaling. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Detaillering van het soort boeking. Bijvoorbeeld;storno, kasbetaling, acceptgiro, enzovoort. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGDETAILSOORT.
- omschrijving:
+ Bankafschriftbericht:
+ allOf:
+ - $ref: '#/components/schemas/Bankafschrift'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Bankafschrift:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Omschrijving van de boeking.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de boeking. Bijvoorbeeld;voorlopig, gefiatteerd. Referentiedatasoort BOEKINGSTATUS.
- boekdatum:
- type: string
- format: date
- description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- factuurdatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: Boekstuk- of factuurdatum van de boeking.
- valutadatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: Valutadatum van de boeking.
- vervaldatum:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: date
- description: Vervaldatum van de boeking.
- kortingsdatum:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ omschrijving:
type: string
- format: date
- description: Kortingsdatum.
- aflettering:
+ format: any
+ description: Omschrijving van het gegeven.
+ status:
allOf:
- - $ref: '#/components/schemas/Aflettering-sleutels'
- description: De grondslag aflettering behorende bij de boeking.
- afletteringen:
- description: De afletteringen behorende bij de boeking.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Status van het afschrift: ingelezen/verwerkt. Referentiedatasoort BANKAFSCHRIFTSTATUS.'
+ afBedrag:
+ type: number
+ format: float
+ description: Totaal bedrag af op dit afschrift.
+ bankafschriftRegels:
+ description: De bankafschriftregels van het bankafschrift.
type: array
items:
- $ref: '#/components/schemas/Aflettering-sleutels'
- bankafschriftRegel:
- allOf:
- - $ref: '#/components/schemas/BankafschriftRegel'
- description: De bankafschriftregel waaraan de boeking gekoppeld is.
- bedrag:
+ $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ beginsaldo:
type: number
format: float
- description: Het initiele bedrag van de boeking (inclusief btw).
- betaalgegeven:
+ description: Beginsaldo vermeld op dit afschrift.
+ bijBedrag:
+ type: number
+ format: float
+ description: Totaal bedrag bij op dit afschrift.
+ eindsaldo:
+ type: number
+ format: float
+ description: Eindsaldo vermeld op dit afschrift.
+ postenAantal:
+ type: integer
+ format: int32
+ description: Aantal posten.
+ rekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- betalingskenmerk:
- type: string
- format: any
- description: Betalingskenmerk van bijvoorbeeld acceptgiro of kwitantienummer.
- betalingsregelingen:
- description: Betalingsregelingen waar de boeking onderdeel van kan zijn.
- type: array
- items:
- $ref: '#/components/schemas/Betalingsregeling'
- boekingdetails:
- description: De boekingdetails behorende bij de boeking.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail'
- btwAangiftes:
- description: De btw aangiftes behorend bij deze factuur.
- type: array
- items:
- $ref: '#/components/schemas/BtwAangifte'
- btwBedrag:
- type: number
- format: float
- description: Totaal Bedrag btw.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw hoog voor op aangifte btw.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw laag voor op aangifte btw.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- crediteur:
- allOf:
- - $ref: '#/components/schemas/Crediteur'
- description: De crediteur van de boeking.
- debiteur:
- allOf:
- - $ref: '#/components/schemas/Debiteur'
- description: De debiteur van de boeking.
- externeIncassos:
- description: Externe incassos waar de boeking onderdeel van kan zijn.
- type: array
- items:
- $ref: '#/components/schemas/ExterneIncasso'
- grootboekmutatie:
- allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
- description: De grootboekmutatie behorende bij de boeking.
- huurgeschil:
- type: string
- format: uri
- description: Referentie naar Huurgeschil in informatiedomein Overeenkomsten
- incassomachtiging:
- allOf:
- - $ref: '#/components/schemas/Incassomachtiging'
- description: De incassomachtiging behorende bij de boeking.
- incassoOpdracht:
- allOf:
- - $ref: '#/components/schemas/IncassoOpdracht'
- description: Incasso opdracht waar de boeking aan gekoppeld is.
- organisatieBetaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- overeenkomst:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ relatie:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- saldo:
- type: number
- format: float
- description: Het saldo of openstaande bedrag van de boeking.
- verbijzondering:
- allOf:
- - $ref: '#/components/schemas/Verbijzondering'
- description: Verbijzondering van de boeking.
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -11273,7 +11268,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -11285,7 +11280,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -11321,7 +11316,7 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Aflettering-sleutels:
+ BankafschriftRegel-sleutels:
type: object
properties:
id:
@@ -11339,7 +11334,7 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
BankafschriftRegelbericht:
allOf:
- $ref: '#/components/schemas/BankafschriftRegel'
@@ -11381,11 +11376,11 @@ components:
description: Bedrag bij.
bankafschrift:
allOf:
- - $ref: '#/components/schemas/Bankafschrift'
+ - $ref: '#/components/schemas/Bankafschrift-sleutels'
description: Het bankafschrift waarvan de bankafschriftregel onderdeel is.
betaalopdracht:
allOf:
- - $ref: '#/components/schemas/Betaalopdracht'
+ - $ref: '#/components/schemas/Betaalopdracht-sleutels'
description: De Betaalopdracht die gekoppeld is aan de bankafschriftregel.
betalingskenmerk:
type: string
@@ -11404,21 +11399,97 @@ components:
description: De inkoopfactuurbetalingen behorende bij deze bankafschriftregel.
type: array
items:
- $ref: '#/components/schemas/Factuurbetaling'
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
incassoOpdrachten:
description: Incasso opdrachten waar de bankafschriftregel aan gekoppeld is.
type: array
items:
- $ref: '#/components/schemas/IncassoOpdracht'
+ $ref: '#/components/schemas/IncassoOpdracht-sleutels'
rekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- Bankafschriftbericht:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ Bankafschrift-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Betaalopdracht-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Factuurbetaling-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ IncassoOpdracht-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Begrotingbericht:
allOf:
- - $ref: '#/components/schemas/Bankafschrift'
+ - $ref: '#/components/schemas/Begroting'
- $ref: '#/components/schemas/Bericht-basis'
- Bankafschrift:
+ Begroting:
type: object
properties:
id:
@@ -11436,49 +11507,76 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- status:
+ description: De omschrijving van het gegeven.
+ periode:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Status van het afschrift: ingelezen/verwerkt. Referentiedatasoort BANKAFSCHRIFTSTATUS.'
- afBedrag:
- type: number
- format: float
- description: Totaal bedrag af op dit afschrift.
- bankafschriftRegels:
- description: De bankafschriftregels van het bankafschrift.
- type: array
- items:
- $ref: '#/components/schemas/BankafschriftRegel-sleutels'
- beginsaldo:
- type: number
- format: float
- description: Beginsaldo vermeld op dit afschrift.
- bijBedrag:
+ - $ref: '#/components/schemas/BoekjaarPeriode-sleutels'
+ description: De periode van deze begroting.
+ creditbedrag:
type: number
format: float
- description: Totaal bedrag bij op dit afschrift.
- eindsaldo:
+ description: Bedrag debet.
+ debetbedrag:
type: number
format: float
- description: Eindsaldo vermeld op dit afschrift.
- postenAantal:
- type: integer
- format: int32
- description: Aantal posten.
- rekening:
+ description: Bedrag credit.
+ grootboekrekeningen:
+ description: De grootboekrekeningen van deze begroting (collectie type).
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ verbijzonderingen:
+ description: De verbijzonderingen van bij deze begroting.
+ type: array
+ items:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ versie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De versieaanduiding van de begroting, bijvoorbeeld;Oorspronkelijk budget, Mutatiebudget, etc. Referentiedatasoort BEGROTINGVERSIE.
+ BoekjaarPeriode-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- relatie:
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- BankafschriftRegel-sleutels:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Grootboekrekening-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Verbijzondering-sleutels:
type: object
properties:
id:
@@ -11549,12 +11647,12 @@ components:
description: De inkoopfactuurbetalingen behorende bij de betaalopdracht.
type: array
items:
- $ref: '#/components/schemas/Factuurbetaling'
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
grootboekmutaties:
description: De grootboekmutaties behorende bij de betaalopdracht.
type: array
items:
- $ref: '#/components/schemas/Grootboekmutatie'
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
postenAantal:
type: integer
format: int32
@@ -11562,12 +11660,8 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- Factuurbetalingbericht:
- allOf:
- - $ref: '#/components/schemas/Factuurbetaling'
- - $ref: '#/components/schemas/Bericht-basis'
- Factuurbetaling:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ Grootboekmutatie-sleutels:
type: object
properties:
id:
@@ -11585,61 +11679,63 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- omschrijving:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Betaalwijzebericht:
+ allOf:
+ - $ref: '#/components/schemas/Betaalwijze'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Betaalwijze:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van de betaling, bijvoorbeeld betaald of te verwerken. Referentiedatasoort FACTUURSTATUS.
- datum:
+ description: De wijze van incasso waarop de huurovereenkomst wordt betaald. Referentiedatasoort BETAALWIJZESOORT.
+ begindatum:
type: string
format: date
- description: Datum van de betaling.
- bankafschriftRegel:
+ description: De begindatum van de betaalwijze.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de betaalwijze.
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ deelsoort:
allOf:
- - $ref: '#/components/schemas/BankafschriftRegel-sleutels'
- description: De bankafschriftregel waarop deze factuurbetaling is vermeld.
- bedrag:
- type: number
- format: float
- description: Bedrag van de betaling.
- betaalkenmerk:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De verdeelsleutel waarmee de vergoeding van de overeenkomst betaald moet worden over één of meerdere betalers, bijvoorbeeld percentueel. Referentiedatasoort BETAALWIJZEDEELSOORT.
+ deelwaarde:
type: string
format: any
- description: Betalingskenmerk.
- betaalopdracht:
+ description: Het (maximale) bedrag of het percentage van het totaal die via deze betaalwijze betaald moet worden.
+ incassomachtiging:
allOf:
- - $ref: '#/components/schemas/Betaalopdracht-sleutels'
- description: De betaalopdracht van deze factuurbetaling.
- facturen:
- description: De factuur van deze factuurbetaling.
- type: array
- items:
- $ref: '#/components/schemas/Factuur'
- grootboekmutatie:
+ - $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ description: De digitale machtiging voor het uitvoeren van de incassoopdrachten. SEPA.
+ incassomoment:
allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
- description: De grootboekmutatie behorende bij de factuurbetaling.
- kortingsbedrag:
- type: number
- format: float
- description: Genomen korting.
- rekening:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- rekeningBetaling:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- volgnummerInBetaalopdracht:
- type: integer
- format: int32
- description: Het volgnummer van de betaling binnen de betaalopdracht.
- Betaalopdracht-sleutels:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het moment waarop de incasso wordt gedaan. Referentiedatasoort INCASSOMOMENT.
+ Incassomachtiging-sleutels:
type: object
properties:
id:
@@ -11657,8 +11753,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Factuur-basis:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
+ Betalingsregelingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Betalingsregeling'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Betalingsregeling:
type: object
properties:
id:
@@ -11677,148 +11777,91 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Soort van de factuur: Inkoopfactuur of Verkoopfactuur. Referentiedatasoort FACTUURSOORT.'
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
+ description: Omschrijving van het gegeven.
+ toelichting:
+ type: string
+ format: any
+ description: Nadere toelichting waarin extra informatie met betrekking tot de betalingsregeling kan worden opgenomen (memo, opmerkingen).
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De status van de factuur. Bijv. Goedgekeurd, Geblokkeerd, Betaald, Gedeeltelijk betaald etc. Referentiedatasoort INKOOPFACTUURSTATUS.
- ontvangstdatum:
- type: string
- format: date
- description: Datum waarop de factuur is ontvangen.
- boekdatum:
- type: string
- format: date
- description: Datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- factuurdatum:
+ description: 'Status van de betalingsregeling. Voorbeeld: actief, bevroren, geannuleerd, enzovoort. Referentiedatasoort BETALINGSREGELINGSTATUS.'
+ begindatum:
type: string
format: date
- description: Factuurdatum van de factuur.
- plandatum:
+ description: Datum waarop de regeling is of wordt gestart.
+ einddatum:
type: string
format: date
- description: Geplande datum voor betaling van de factuur.
- vervaldatum:
+ description: Datum waarop de regeling is of wordt beëindigd.
+ afspraakdatum:
type: string
format: date
- description: De datum waarop de factuur uiterlijk betaald dient te zijn.
+ description: Datum waarop de regeling is overeengekomen.
bedrag:
type: number
format: float
- description: Bedrag van de factuur.
+ description: Het initiele bedrag van de betalingsregeling.
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
betaalwijze:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De betaalwijze van de factuur. Bijv. Contant, Op rekening, Automatische incasso etc. Referentiedatasoort FACTUURBETAALWIJZE.
- betalingAkkoord:
- type: boolean
- description: Gefiatteerd voor betaling.
- betalingskenmerk:
- type: string
- format: any
- description: Betalingskenmerk van de factuur.
- btwAangifte:
+ - $ref: '#/components/schemas/Betaalwijze-sleutels'
+ description: De afgesproken betaalwijze voor de betalingsregeling.
+ boekingen:
+ description: De boekingen behorende bij de betalingsregeling.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ debiteur:
allOf:
- - $ref: '#/components/schemas/BtwAangifte'
- description: De btw aangifte behorend bij deze factuur
- btwBedrag:
- type: number
- format: float
- description: Totale btw bedrag op de factuur.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw hoog voor op aangifte btw.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw laag voor op aangifte btw.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- btwTerugTeVorderen:
- type: boolean
- description: btw terug te vorderen ja/nee.
- btwVerlegd:
- type: boolean
- description: btw verlegd ja/nee.
- correctiesoort:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur voor wie de betalingsregeling is opgesteld.
+ eindeReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort correctie op de factuur. Bijv. intern, extern. Referentiedatasoort CORRECTIESOORT.
- externFactuurnummer:
+ description: 'Reden dat de betalingsregeling is beëindigd. Voorbeeld: voldaan, enzovoort. Referentiedatasoort BETALINGSREGELINGEINDEREDEN.'
+ incassowijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Wijze van incasso waarop de betalingsregeling wordt betaald. OBSOLETE Referentiedatasoort INCASSOWIJZE.
+ deprecated: true
+ organisatieBetaalgegeven:
type: string
- format: any
- description: Extern factuurnummer van de factuur.
- factuurbetalingen:
- description: De betalingen behorende bij de factuur.
- type: array
- items:
- $ref: '#/components/schemas/Factuurbetaling-sleutels'
- factuurGeblokkeerd:
- type: boolean
- description: Geblokkeerd ja/nee.
- factuurregels:
- description: De factuurregels behorende bij deze factuur.
- type: array
- items:
- $ref: '#/components/schemas/Factuurregel'
- gRekeningbedrag:
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ prolongatieInterval:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: De interval die aangeeft na hoeveel tijd er wordt geprolongeerd op de betalingsregeling.
+ prolongatieTotDatum:
+ type: string
+ format: date
+ description: De betalingsregeling is geprolongeerd tot deze datum.
+ saldo:
type: number
format: float
- description: Bedrag G rekening.
- grootboekmutaties:
- description: De grootboekmutaties behorende bij deze factuur.
+ description: Het saldo of openstaande bedrag van de betalingsregeling.
+ termijnen:
+ description: De betalingsregeling termijnen behorende bij de betalingsregeling.
type: array
items:
- $ref: '#/components/schemas/Grootboekmutatie'
- korting:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Korting die wordt gegeven op het factuurbedrag.
- openstaandBedrag:
+ $ref: '#/components/schemas/BetalingsregelingTermijn-sleutels'
+ termijnenAantal:
type: number
format: float
- description: Bedrag dat nog openstaat op de factuur.
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- toeslag:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Toeslag die in rekening wordt gebracht op het factuurbedrag.
- BtwAangiftebericht:
- allOf:
- - $ref: '#/components/schemas/BtwAangifte'
- - $ref: '#/components/schemas/Bericht-basis'
- BtwAangifte:
+ description: Het aantal termijnen waaruit de betalingsregeling bestaat.
+ Betaalwijze-sleutels:
type: object
properties:
id:
@@ -11837,51 +11880,26 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- omschrijving:
+ Debiteur-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de btw aangifte, bijvoorbeeld Voorlopig, In Behandeling. Referentiedatasoort BTWAANGIFTESTATUS.
- datum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: Datum aangifte.
- begindatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: Datum vanaf de btw op de aangifte wordt opgenomen.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: date
- description: Datum tot en met de btw op de aangifte wordt opgenomen.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf'
- description: Het bedrijf van de btw aangifte.
- boekingen:
- description: De boekingen van de btw aangifte.
- type: array
- items:
- $ref: '#/components/schemas/Boeking-sleutels'
- facturen:
- description: De creditfacturen van de btw aangifte.
- type: array
- items:
- $ref: '#/components/schemas/Factuur-sleutels'
- inkoopfacturen:
- description: De inkoopfacturen van de btw aangifte. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/Inkoopfactuur'
- deprecated: true
- FinancieelBedrijfbericht:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf'
- - $ref: '#/components/schemas/Bericht-basis'
- FinancieelBedrijf:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BetalingsregelingTermijn-sleutels:
type: object
properties:
id:
@@ -11899,76 +11917,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft het type van het bedrijf aan: VVE, TI, servicebedrijf. Referentiedatasoort BEDRIJFSOORT.'
- naam:
- type: string
- format: any
- description: De naam van het bedrijf.
- betaalcyclusDuur:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: Geeft de duur aan die benodigd is voor het betaalproces.
- boekjaren:
- description: De boekjaren btw behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Boekjaar'
- btwAangiftes:
- description: De aangifte btw behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/BtwAangifte-sleutels'
- consolidatieBedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Geeft aan in welk bedrijf dit bedrijf geconsolideerd is.
- crediteuren:
- description: De crediteuren behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Crediteur'
- debiteuren:
- description: De debiteuren behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Debiteur'
- deelnemingspercentage:
- type: number
- format: float
- description: Indien het een deelname betreft bevat dit het percentage deelname.
- geconsolideerdebedrijven:
- description: Geeft aan welke bedrijven in dit bedrijf geconsolideerd zijn.
- type: array
- items:
- $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- grootboekrekeningen:
- description: De grootboekrekeningen behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Grootboekrekening'
- maatschappelijkLabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het label waarmee wordt aangegeven of de activiteiten die binnen het financieel bedrijf worden verricht verantwoord worden als zijnde DAEB- of niet-DAEB-activiteiten. Als sprake is van een verbinding kan het financieel bedrijf ook het label ‘Geconsolideerde NIET-DAEB verbinding’ hebben. Referentiedatasoort MAATSCHAPPELIJKLABEL.
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- verbijzonderingen:
- description: De verbijzonderingen behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Verbijzondering'
- Boekjaarbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BetalingsregelingTermijnbericht:
allOf:
- - $ref: '#/components/schemas/Boekjaar'
+ - $ref: '#/components/schemas/BetalingsregelingTermijn'
- $ref: '#/components/schemas/Bericht-basis'
- Boekjaar:
+ BetalingsregelingTermijn:
type: object
properties:
id:
@@ -11990,33 +11944,32 @@ components:
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
+ description: Omschrijving van het gegeven.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van het boekjaar, bijvoorbeeld;open, geblokkeerd, gesloten. Referentiedatasoort BOEKJAARSTATUS.
- begindatum:
+ description: Status van de termijn, bv. openstaand, betaald. Referentiedatasoort BETALINGSREGELINGTERMIJNSTATUS.
+ datum:
type: string
format: date
- description: Begindatum van het boekjaar.
- einddatum:
+ description: Datum waarop de termijn betaald is.
+ vervaldatum:
type: string
format: date
- description: Einddatum van het boekjaar.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Het bedrijf waarvoor dit boekjaar.
- boekjaarperiodes:
- description: De boekjaarperiodes behorende bij het boekjaar.
- type: array
- items:
- $ref: '#/components/schemas/BoekjaarPeriode'
- periodeSoort:
+ description: Vervaldatum van de termijn.
+ bedrag:
+ type: number
+ format: float
+ description: Initiële bedrag van de termijn.
+ betalingsregeling:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort periode waarin het boekjaar is ingedeeld, bijvoorbeeld;maand, week, 4-week, etc. Referentiedatasoort BOEKJAARPERIODESOORT.
- FinancieelBedrijf-sleutels:
+ - $ref: '#/components/schemas/Betalingsregeling-sleutels'
+ description: Betalingsregeling waaraan de termijn is gekoppeld.
+ saldo:
+ type: number
+ format: float
+ description: Het saldo of openstaande bedrag van de termijn.
+ Betalingsregeling-sleutels:
type: object
properties:
id:
@@ -12034,12 +11987,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- BoekjaarPeriodebericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Boekingbericht:
allOf:
- - $ref: '#/components/schemas/BoekjaarPeriode'
+ - $ref: '#/components/schemas/Boeking'
- $ref: '#/components/schemas/Bericht-basis'
- BoekjaarPeriode:
+ Boeking:
type: object
properties:
id:
@@ -12061,95 +12014,157 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De soort boekjaarperiode, bijvoorbeeld Week, Maand, Jaar. Referentiedatasoort BOEKJAARPERIODESOORT.
+ description: Soort boeking. Bijvoorbeeld;vordering, ontvangst of uitbetaling. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detaillering van het soort boeking. Bijvoorbeeld;storno, kasbetaling, acceptgiro, enzovoort. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGDETAILSOORT.
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
+ description: Omschrijving van de boeking.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van de periode, bijvoorbeeld;open, geblokkeerd. Referentiedatasoort BOEKJAARPERIODESTATUS.
- begindatum:
+ description: Status van de boeking. Bijvoorbeeld;voorlopig, gefiatteerd. Referentiedatasoort BOEKINGSTATUS.
+ boekdatum:
type: string
format: date
- description: De begindatum van de periode.
- einddatum:
+ description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ factuurdatum:
type: string
format: date
- description: De einddatum van de periode.
- begrotingen:
- description: De begroting behorende bij de periode.
- type: array
- items:
- $ref: '#/components/schemas/Begroting'
- boekjaar:
- allOf:
- - $ref: '#/components/schemas/Boekjaar-sleutels'
- description: Het boekjaar waarbinnen deze periode valt.
- boekjaarperiodesaldos:
- description: Het boekjaarperiodesaldo van de periode.
- type: array
- items:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo'
- Begrotingbericht:
- allOf:
- - $ref: '#/components/schemas/Begroting'
- - $ref: '#/components/schemas/Bericht-basis'
- Begroting:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ description: Boekstuk- of factuurdatum van de boeking.
+ valutadatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ format: date
+ description: Valutadatum van de boeking.
+ vervaldatum:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
- omschrijving:
+ format: date
+ description: Vervaldatum van de boeking.
+ kortingsdatum:
type: string
- format: any
- description: De omschrijving van het gegeven.
- periode:
+ format: date
+ description: Kortingsdatum.
+ aflettering:
allOf:
- - $ref: '#/components/schemas/BoekjaarPeriode-sleutels'
- description: De periode van deze begroting.
- creditbedrag:
- type: number
- format: float
- description: Bedrag debet.
- debetbedrag:
- type: number
- format: float
- description: Bedrag credit.
- grootboekrekeningen:
- description: De grootboekrekeningen van deze begroting (collectie type).
- type: array
- items:
- $ref: '#/components/schemas/Grootboekrekening'
- verbijzonderingen:
- description: De verbijzonderingen van bij deze begroting.
+ - $ref: '#/components/schemas/Aflettering-sleutels'
+ description: De grondslag aflettering behorende bij de boeking.
+ afletteringen:
+ description: De afletteringen behorende bij de boeking.
type: array
items:
- $ref: '#/components/schemas/Verbijzondering'
- versie:
+ $ref: '#/components/schemas/Aflettering-sleutels'
+ bankafschriftRegel:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De versieaanduiding van de begroting, bijvoorbeeld;Oorspronkelijk budget, Mutatiebudget, etc. Referentiedatasoort BEGROTINGVERSIE.
- BoekjaarPeriode-sleutels:
- type: object
- properties:
- id:
- type: string
+ - $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ description: De bankafschriftregel waaraan de boeking gekoppeld is.
+ bedrag:
+ type: number
+ format: float
+ description: Het initiele bedrag van de boeking (inclusief btw).
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ betalingskenmerk:
+ type: string
+ format: any
+ description: Betalingskenmerk van bijvoorbeeld acceptgiro of kwitantienummer.
+ betalingsregelingen:
+ description: Betalingsregelingen waar de boeking onderdeel van kan zijn.
+ type: array
+ items:
+ $ref: '#/components/schemas/Betalingsregeling-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de boeking.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
+ btwAangiftes:
+ description: De btw aangiftes behorend bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/BtwAangifte-sleutels'
+ btwBedrag:
+ type: number
+ format: float
+ description: Totaal Bedrag btw.
+ btwGeenGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw hoog voor op aangifte btw.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw laag voor op aangifte btw.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ crediteur:
+ allOf:
+ - $ref: '#/components/schemas/Crediteur-sleutels'
+ description: De crediteur van de boeking.
+ debiteur:
+ allOf:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur van de boeking.
+ externeIncassos:
+ description: Externe incassos waar de boeking onderdeel van kan zijn.
+ type: array
+ items:
+ $ref: '#/components/schemas/ExterneIncasso-sleutels'
+ grootboekmutatie:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ description: De grootboekmutatie behorende bij de boeking.
+ huurgeschil:
+ type: string
+ format: uri
+ description: Referentie naar Huurgeschil-sleutels in informatiedomein Overeenkomsten
+ incassomachtiging:
+ allOf:
+ - $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ description: De incassomachtiging behorende bij de boeking.
+ incassoOpdracht:
+ allOf:
+ - $ref: '#/components/schemas/IncassoOpdracht-sleutels'
+ description: Incasso opdracht waar de boeking aan gekoppeld is.
+ organisatieBetaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ saldo:
+ type: number
+ format: float
+ description: Het saldo of openstaande bedrag van de boeking.
+ verbijzondering:
+ allOf:
+ - $ref: '#/components/schemas/Verbijzondering-sleutels'
+ description: Verbijzondering van de boeking.
+ Aflettering-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
format: any
description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
idExtern:
@@ -12164,11 +12179,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Grootboekrekeningbericht:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening'
- - $ref: '#/components/schemas/Bericht-basis'
- Grootboekrekening:
+ Boekingdetail-sleutels:
type: object
properties:
id:
@@ -12186,56 +12197,27 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Aanduiding van de soort grootboekrekening. Administraties kunnen verschillen in indeling en detaillering. De referentiedata wordt gevormd door het ReferentieGrootboekSchema (RGS) zoals gepubliceerd op https://www.referentiegrootboekschema.nl/kbase?field_category_target_id=27 (Kennisbank). Voorbeelden: *B – Balans *BIva – Immateriële vaste activa *BIvaKouVvp – Verkrijgings- of vervaardigingsprijs Referentiedatasoort GROOTBOEKREKENINGSOORT.'
- omschrijving:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BtwAangifte-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de rekening, bijvoorbeeld;actief, historisch. Referentiedatasoort GROOTBOEKREKENINGSTATUS.
- begindatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De begindatum waarop geboekt mag worden op de grootboekrekening.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: De einddatum waarop geboekt mag worden op de grootboekrekening.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Het bedrijf van deze grootboekrekening.
- begrotingen:
- description: De begrotingen behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/Begroting-sleutels'
- boekingdetails:
- description: De boekingdetails behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail'
- boekjaarperiodesaldos:
- description: De boekjaarperiodesaldi behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo'
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- referentiegrootboekschemacode:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
format: any
- description: De verwijzing naar de code in het referentiegrootboekschema.
- Begroting-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Crediteur-sleutels:
type: object
properties:
id:
@@ -12253,7 +12235,26 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ ExterneIncasso-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
Boekingdetailbericht:
allOf:
- $ref: '#/components/schemas/Boekingdetail'
@@ -12299,11 +12300,11 @@ components:
description: Bedrag btw op deze regel
btwTarief:
allOf:
- - $ref: '#/components/schemas/BtwTarief'
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
description: Het btw tarief van dit boekingdetail (hoog, laag, geen of nul).
grootboekmutatie:
allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
description: De grootboekmutatie behorende bij het boekingdetail.
grootboekrekening:
allOf:
@@ -12319,9 +12320,9 @@ components:
description: Prijs per meeteenheid.
verbijzondering:
allOf:
- - $ref: '#/components/schemas/Verbijzondering'
+ - $ref: '#/components/schemas/Verbijzondering-sleutels'
description: Verbijzondering van de boekingdetail.
- Boeking-sleutels:
+ BtwTarief-sleutels:
type: object
properties:
id:
@@ -12340,11 +12341,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- BtwTariefbericht:
+ Boekjaarbericht:
allOf:
- - $ref: '#/components/schemas/BtwTarief'
+ - $ref: '#/components/schemas/Boekjaar'
- $ref: '#/components/schemas/Bericht-basis'
- BtwTarief:
+ Boekjaar:
type: object
properties:
id:
@@ -12366,41 +12367,33 @@ components:
omschrijving:
type: string
format: any
- description: Omschrijving van het tarief, bijvoorbeeld;hoog, laag, geen, nul.
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van het boekjaar, bijvoorbeeld;open, geblokkeerd, gesloten. Referentiedatasoort BOEKJAARSTATUS.
begindatum:
type: string
format: date
- description: Datum waarop het tarief voorhet type ingaat.
+ description: Begindatum van het boekjaar.
einddatum:
type: string
format: date
- description: Datum waarop het tarief voorhet type eindigt.
- boekingdetails:
- description: De btw tarieven van de boekingdetails.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail-sleutels'
- factuurregels:
- description: De btw tarieven van de inkoopfactuurregels.
- type: array
- items:
- $ref: '#/components/schemas/Factuurregel'
- grootboekmutaties:
- description: De btw tarieven van de grootboekmutaties.
- type: array
- items:
- $ref: '#/components/schemas/Grootboekmutatie'
- inkoopfactuurregels:
- description: De btw tarieven van de inkoopfactuurregels. OBSOLETE
+ description: Einddatum van het boekjaar.
+ bedrijf:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf waarvoor dit boekjaar.
+ boekjaarperiodes:
+ description: De boekjaarperiodes behorende bij het boekjaar.
type: array
items:
- $ref: '#/components/schemas/InkoopfactuurRegel'
- deprecated: true
- percentage:
- type: number
- format: float
- description: Het btw percentage van het tarief.
- Boekingdetail-sleutels:
+ $ref: '#/components/schemas/BoekjaarPeriode-sleutels'
+ periodeSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort periode waarin het boekjaar is ingedeeld, bijvoorbeeld;maand, week, 4-week, etc. Referentiedatasoort BOEKJAARPERIODESOORT.
+ FinancieelBedrijf-sleutels:
type: object
properties:
id:
@@ -12418,8 +12411,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurregel-basis:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ BoekjaarPeriodebericht:
+ allOf:
+ - $ref: '#/components/schemas/BoekjaarPeriode'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BoekjaarPeriode:
type: object
properties:
id:
@@ -12438,45 +12435,41 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De soort boekjaarperiode, bijvoorbeeld Week, Maand, Jaar. Referentiedatasoort BOEKJAARPERIODESOORT.
omschrijving:
type: string
format: any
description: De omschrijving van het gegeven.
- bedrag:
- type: number
- format: float
- description: Bedrag.
- btwAangiftebedrag:
- type: number
- format: float
- description: Aangiftebedrag btw op deze regel.
- btwTarief:
+ status:
allOf:
- - $ref: '#/components/schemas/BtwTarief-sleutels'
- description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen of nul.
- grootboekmutaties:
- description: De grootboekmutaties behorende bij de factuurregel.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de periode, bijvoorbeeld;open, geblokkeerd. Referentiedatasoort BOEKJAARPERIODESTATUS.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de periode.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de periode.
+ begrotingen:
+ description: De begroting behorende bij de periode.
type: array
items:
- $ref: '#/components/schemas/Grootboekmutatie'
- grootboekrekening:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening-sleutels'
- description: Het rekeningnummer.
- korting:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Korting die wordt gegeven op het factuurregelbedrag.
- toeslag:
+ $ref: '#/components/schemas/Begroting-sleutels'
+ boekjaar:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Toeslag die in rekening wordt gebracht op het factuurregelbedrag.
- verbijzonderingen:
- description: Verbijzondering van de grootboekboeking.
+ - $ref: '#/components/schemas/Boekjaar-sleutels'
+ description: Het boekjaar waarbinnen deze periode valt.
+ boekjaarperiodesaldos:
+ description: Het boekjaarperiodesaldo van de periode.
type: array
items:
- $ref: '#/components/schemas/Verbijzondering'
- BtwTarief-sleutels:
+ $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ Begroting-sleutels:
type: object
properties:
id:
@@ -12494,12 +12487,8 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Grootboekmutatiebericht:
- allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Grootboekmutatie:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
+ Boekjaar-sleutels:
type: object
properties:
id:
@@ -12517,121 +12506,26 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BoekjaarPeriodesaldo-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- boekdatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- betaalopdrachten:
- description: De betaalopdracht behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Betaalopdracht-sleutels'
- boekingdetails:
- description: De boekingdetails behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail-sleutels'
- boekingen:
- description: De boekingen behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Boeking-sleutels'
- boekjaarPeriodesaldo:
- allOf:
- - $ref: '#/components/schemas/BoekjaarPeriodesaldo'
- description: Het saldo van de periode waarop deze grootboekmutatie betrekking heeft.
- boekstuknummer:
- type: integer
- format: int32
- description: Nummer van het boekstuk waarin deze mutatie is ontstaan.
- boekstuknummerCode:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: Tijdelijke constructie om boekstuknummers door te geven die geen nummers zijn. In volgende major versie wordt dit opgeheven en veranderd attribuut boekstuknummer naar string.
- boekstukregel:
- type: integer
- format: int32
- description: Het regelnummer binnen het boekstuk waarin deze mutatie is ontstaan.
- btwBedrag:
- type: number
- format: float
- description: Btw-bedrag op de mutatie.
- btwTarieven:
- description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen, nul.
- type: array
- items:
- $ref: '#/components/schemas/BtwTarief-sleutels'
- creditbedrag:
- type: number
- format: float
- description: Bedrag credit.
- debetbedrag:
- type: number
- format: float
- description: Bedrag debet.
- facturen:
- description: De creditfacturen behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Factuur-sleutels'
- factuurbetalingen:
- description: De factuurbetalingen behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Factuurbetaling-sleutels'
- factuurregels:
- description: De factuurregels behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Factuurregel-sleutels'
- grootboekrekening:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening-sleutels'
- description: De grootboekrekening waarop de mutatie wordt geboekt.
- herkomst:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft de herkomst van de grootboekmutatie aan: memo, subadministratie etc. Referentiedatasoort GROOTBOEKMUTATIEHERKOMST.'
- incassoOpdrachten:
- description: De incasso opdrachten behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/IncassoOpdracht'
- inkoopfacturen:
- description: De inkoopfacturen behorende bij de grootboekmutatie. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/Inkoopfactuur'
- deprecated: true
- inkoopfactuurRegels:
- description: De inkoopfactuurregels behorende bij de grootboekmutatie. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/InkoopfactuurRegel'
- deprecated: true
- inkoopopdrachten:
- description: De inkoopopdrachten behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Inkoopopdracht'
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- verbijzondering:
- allOf:
- - $ref: '#/components/schemas/Verbijzondering'
- description: Verbijzondering van de grootboekmutatie.
- volgnummer:
- type: integer
- format: int32
- description: Volgnummer van de grootboekmutatie.
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
BoekjaarPeriodesaldobericht:
allOf:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo'
@@ -12680,8 +12574,12 @@ components:
description: De verbijzonderingen van dit periodesaldo.
type: array
items:
- $ref: '#/components/schemas/Verbijzondering'
- Grootboekmutatie-sleutels:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ BtwAangiftebericht:
+ allOf:
+ - $ref: '#/components/schemas/BtwAangifte'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BtwAangifte:
type: object
properties:
id:
@@ -12699,8 +12597,48 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Grootboekrekening-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de btw aangifte, bijvoorbeeld Voorlopig, In Behandeling. Referentiedatasoort BTWAANGIFTESTATUS.
+ datum:
+ type: string
+ format: date
+ description: Datum aangifte.
+ begindatum:
+ type: string
+ format: date
+ description: Datum vanaf de btw op de aangifte wordt opgenomen.
+ einddatum:
+ type: string
+ format: date
+ description: Datum tot en met de btw op de aangifte wordt opgenomen.
+ bedrijf:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf van de btw aangifte.
+ boekingen:
+ description: De boekingen van de btw aangifte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ facturen:
+ description: De creditfacturen van de btw aangifte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuur-sleutels'
+ inkoopfacturen:
+ description: De inkoopfacturen van de btw aangifte. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ deprecated: true
+ Factuur-sleutels:
type: object
properties:
id:
@@ -12718,12 +12656,31 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Verbijzonderingbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Inkoopfactuur-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BtwTariefbericht:
allOf:
- - $ref: '#/components/schemas/Verbijzondering'
+ - $ref: '#/components/schemas/BtwTarief'
- $ref: '#/components/schemas/Bericht-basis'
- Verbijzondering:
+ BtwTarief:
type: object
properties:
id:
@@ -12741,80 +12698,45 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft het soort verbijzondering aan, bijvoorbeeld;kostenplaats, kostensoort, dimensie. Referentiedatasoort VERBIJZONDERINGSOORT.
- detailsoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Optionele nadere verbijzondering van de verbijzonderingsoort Dimensie. Hier kan een eigen dimensiesoort, waarvoor geen referentiedata voor Verbijzondering bestaat, worden toegevoegd. Referentiedatasoort VERBIJZONDERINGDETAILSOORT.
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de verbijzondering. Referentiedatasoort VERBIJZONDERINGSTATUS.
- beginjaar:
- type: integer
- format: int32
- description: Open vanaf jaar, bepaalt de periode waarin geboekt mag worden.
- beginperiode:
- type: integer
- format: int32
- description: Open vanaf periode, bepaalt de periode waarin geboekt mag worden.
- eindjaar:
- type: integer
- format: int32
- description: Open t/m jaar, bepaalt de periode waarin geboekt mag worden.
- eindperiode:
- type: integer
- format: int32
- description: Open t/m periode, bepaalt de periode waarin geboekt mag worden.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Het bedrijf van deze verbijzondering.
- begrotingen:
- description: De begroting behorende bij de verbijzondering.
- type: array
- items:
- $ref: '#/components/schemas/Begroting-sleutels'
- boeking:
- description: De boekingen behorende bij de verbijzondering.
- type: array
- items:
- $ref: '#/components/schemas/Boeking-sleutels'
+ description: Omschrijving van het tarief, bijvoorbeeld;hoog, laag, geen, nul.
+ begindatum:
+ type: string
+ format: date
+ description: Datum waarop het tarief voorhet type ingaat.
+ einddatum:
+ type: string
+ format: date
+ description: Datum waarop het tarief voorhet type eindigt.
boekingdetails:
- description: De boekingdetails behorende bij de verbijzondering.
+ description: De btw tarieven van de boekingdetails.
type: array
items:
$ref: '#/components/schemas/Boekingdetail-sleutels'
- boekjaarperiodesaldos:
- description: Het boekjaarperiodesaldo van de verbijzondering.
+ factuurregels:
+ description: De btw tarieven van de inkoopfactuurregels.
type: array
items:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ $ref: '#/components/schemas/Factuurregel-sleutels'
grootboekmutaties:
- description: De grootboekmutaties behorende bij de verbijzondering.
+ description: De btw tarieven van de grootboekmutaties.
type: array
items:
$ref: '#/components/schemas/Grootboekmutatie-sleutels'
inkoopfactuurregels:
- description: De inkoopfactuurregels behorende bij de verbijzondering.
+ description: De btw tarieven van de inkoopfactuurregels. OBSOLETE
type: array
items:
- $ref: '#/components/schemas/InkoopfactuurRegel'
- viaMemoriaalBoekenToestaan:
- type: boolean
- description: Boeking via memoriaal toegestaan ja/nee.
- viaSubBoekenToestaan:
- type: boolean
- description: Boeking via sub toegestaan ja/nee.
- BoekjaarPeriodesaldo-sleutels:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ deprecated: true
+ percentage:
+ type: number
+ format: float
+ description: Het btw percentage van het tarief.
+ Factuurregel-sleutels:
type: object
properties:
id:
@@ -12833,30 +12755,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- InkoopfactuurRegelbericht:
- allOf:
- - $ref: '#/components/schemas/InkoopfactuurRegel'
- - $ref: '#/components/schemas/Bericht-basis'
- InkoopfactuurRegel:
- allOf:
- - $ref: '#/components/schemas/Factuurregel-basis'
- - type: object
- properties:
- factuur:
- allOf:
- - $ref: '#/components/schemas/Factuur-sleutels'
- description: De creditfactuur van deze factuurregel.
- inkoopfactuur:
- allOf:
- - $ref: '#/components/schemas/Inkoopfactuur'
- description: De inkoopfactuur van deze inkoopfactuurregel. OBSOLETE
- deprecated: true
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels waar deze inkoopfactuurregel aan gekoppeld is
- type: array
- items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- Factuur-sleutels:
+ InkoopfactuurRegel-sleutels:
type: object
properties:
id:
@@ -12875,40 +12774,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurbericht:
- allOf:
- - $ref: '#/components/schemas/Factuur'
- - $ref: '#/components/schemas/Bericht-basis'
- Factuur:
- oneOf:
- - $ref: '#/components/schemas/Inkoopfactuur'
- - $ref: '#/components/schemas/Verkoopfactuur'
- - $ref: '#/components/schemas/Factuur-basis'
- Inkoopfactuurbericht:
- allOf:
- - $ref: '#/components/schemas/Inkoopfactuur'
- - $ref: '#/components/schemas/Bericht-basis'
- Inkoopfactuur:
- allOf:
- - $ref: '#/components/schemas/Factuur-basis'
- - type: object
- properties:
- ontvangstdatum:
- type: string
- format: date
- description: Datum waarop de factuur is ontvangen.
- crediteur:
- allOf:
- - $ref: '#/components/schemas/Crediteur'
- description: De crediteur van deze factuur.
- inkoopopdracht:
- allOf:
- - $ref: '#/components/schemas/Inkoopopdracht'
- description: De inkoopopdracht waaraan deze factuur gekoppeld is.
- rekening:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
Crediteurbericht:
allOf:
- $ref: '#/components/schemas/Crediteur'
@@ -12972,7 +12837,7 @@ components:
gRekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
gRekeningPercentage:
type: number
format: float
@@ -12987,7 +12852,7 @@ components:
description: De inkoopopdrachten van de crediteur.
type: array
items:
- $ref: '#/components/schemas/Inkoopopdracht'
+ $ref: '#/components/schemas/Inkoopopdracht-sleutels'
kortingdagen:
type: integer
format: int32
@@ -12997,11 +12862,11 @@ components:
items:
type: string
format: uri
- description: Referenties naar Betaalgegeven in informatiedomein Relaties
+ description: Referenties naar Betaalgegeven-sleutels in informatiedomein Relaties
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
saldo:
type: number
format: float
@@ -13025,7 +12890,7 @@ components:
wkaRegeling:
type: boolean
description: Geeft aan of de crediteur onder de WKA regeling valt.
- Inkoopfactuur-sleutels:
+ Inkoopopdracht-sleutels:
type: object
properties:
id:
@@ -13043,12 +12908,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Inkoopopdrachtbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Debiteurbericht:
allOf:
- - $ref: '#/components/schemas/Inkoopopdracht'
+ - $ref: '#/components/schemas/Debiteur'
- $ref: '#/components/schemas/Bericht-basis'
- Inkoopopdracht:
+ Debiteur:
type: object
properties:
id:
@@ -13066,102 +12931,59 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
- type: string
- format: any
- description: De omschrijving van het gegeven.
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Soort debiteur: huurder, gemeente, etc. Referentiedatasoort DEBITEURSOORT.'
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De status van de inkoopopdracht. Referentiedatasoort INKOOPOPDRACHTSTATUS.
- opdrachtdatum:
- type: string
- format: date
- description: De datum waarop de opdracht is verstrekt.
- boekdatum:
- type: string
- format: date
- description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- crediteur:
+ description: Status van de debiteur, bijvoorbeeld;geblokkeerd, alleen voor betalen, etc. Referentiedatasoort DEBITEURSTATUS.
+ bedrijf:
allOf:
- - $ref: '#/components/schemas/Crediteur-sleutels'
- description: De crediteur van deze inkoopopdracht.
- facturen:
- description: De creditfacturen behorende bij deze inkoopopdracht.
- type: array
- items:
- $ref: '#/components/schemas/Factuur-sleutels'
- grootboekmutaties:
- description: De grootboekmutaties behorende bij deze inkoopopdracht.
- type: array
- items:
- $ref: '#/components/schemas/Grootboekmutatie-sleutels'
- inkoopfacturen:
- description: De inkoopfacturen behorende bij deze inkoopopdracht. OBSOLETE
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Bedrijf gekoppeld aan de debiteur.
+ boekingen:
+ description: De boekingen van de debiteur.
type: array
items:
- $ref: '#/components/schemas/Inkoopfactuur-sleutels'
- deprecated: true
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels behorende bij deze inkoopopdracht.
+ $ref: '#/components/schemas/Boeking-sleutels'
+ btwPlichtig:
+ type: boolean
+ description: Geeft aan of de debiteur btw plichtig is ja/nee.
+ incassomachtigingen:
+ description: De incassomachtigingen van de debiteur.
type: array
items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- onderhoudsorder:
- type: string
- format: uri
- description: Referentie naar Onderhoudsorder in informatiedomein Onderhoud
- projectorders:
+ $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ kortingsdagen:
+ type: integer
+ format: int32
+ description: Aantal dagen waarin de debiteur de korting van het factuurbedrag mag aftrekken.
+ rekeningen:
type: array
items:
type: string
format: uri
- description: Referenties naar Projectorder in informatiedomein Projectontwikkeling
+ description: Referenties naar Betaalgegeven-sleutels in informatiedomein Relaties
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- Crediteur-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- InkoopopdrachtRegelbericht:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ saldo:
+ type: number
+ format: float
+ description: Openstaand saldo.
+ vervaltermijn:
+ type: integer
+ format: int32
+ description: Standaard vervaltermijn voor uit te sturen facturen in dagen.
+ ExterneIncassobericht:
allOf:
- - $ref: '#/components/schemas/InkoopopdrachtRegel'
+ - $ref: '#/components/schemas/ExterneIncasso'
- $ref: '#/components/schemas/Bericht-basis'
- InkoopopdrachtRegel:
+ ExterneIncasso:
type: object
properties:
id:
@@ -13179,61 +13001,68 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Soort externe incasso. Bijvoorbeeld: deurwaarder, incassobureau. Referentiedatasoort EXTERNEINCASSOSOORT.'
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
- soort:
+ description: Omschrijving van het gegeven.
+ status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan welk soort inkoopopdrachtregel het betreft. Bijv. Meerwerk, Minderwerk, Initieel etc. Referentiedatasoort INKOOPOPDRACHTREGELSOORT.
- plandatum:
+ description: 'Status van de externe incasso. Bijvoorbeeld: lopend, afgesloten, bevroren. Referentiedatasoort EXTERNEINCASSOSTATUS.'
+ begindatum:
type: string
format: date
- description: Plandatum voor betaling.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
+ description: Datum waarop het is gestart.
+ einddatum:
+ type: string
+ format: date
+ description: Datum waarop het is afgesloten.
+ overdrachtsdatum:
+ type: string
+ format: date
+ description: Datum waarop is overgedragen.
+ bedrag:
type: number
format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- btwTarief:
- allOf:
- - $ref: '#/components/schemas/BtwTarief-sleutels'
- description: Het BTW-tarief dat van toepassing is op de inkoopopdrachtregel.
- grootboekmutatie:
- allOf:
- - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
- description: De grootboekmutaties behorende bij deze inkoopopdrachtregel.
- grootboekrekening:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening-sleutels'
- description: De grootboekrekening behorende bij deze inkoopopdrachtregel.
- inkoopfactuurregels:
- description: De inkoopfactuurregels behorende bij deze inkoopopdrachtregel.
+ description: Het bedrag dat is overgedragen.
+ boekingen:
+ description: De boekingen behorende bij de externe incasso.
type: array
items:
- $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
- inkoopopdracht:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ debiteur:
allOf:
- - $ref: '#/components/schemas/Inkoopopdracht-sleutels'
- description: De inkoopopdracht van deze inkoopopdrachtregel.
- onderhoudsTaak:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur waaraan de boeking gekoppeld is.
+ externeincassoacties:
+ description: De externe incasso acties behorende bij de externe incasso
+ type: array
+ items:
+ $ref: '#/components/schemas/ExterneIncassoActie-sleutels'
+ overeenkomst:
type: string
format: uri
- description: Referentie naar Onderhoudstaak in informatiedomein Onderhoud
- InkoopfactuurRegel-sleutels:
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ saldo:
+ type: number
+ format: float
+ description: Het saldo of openstaande bedrag.
+ ExterneIncassoActie-sleutels:
type: object
properties:
id:
@@ -13252,7 +13081,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Inkoopopdracht-sleutels:
+ ExterneIncassoActiebericht:
+ allOf:
+ - $ref: '#/components/schemas/ExterneIncassoActie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ ExterneIncassoActie:
type: object
properties:
id:
@@ -13270,8 +13103,36 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Factuurbetaling-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort actie. Referentiedatasoort EXTERNEINCASSOACTIESOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: Omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de actie. Referentiedatasoort EXTERNEINCASSOACTIESTATUS.
+ begindatum:
+ type: string
+ format: date
+ description: Datum en tijd waarop de actie is gestart.
+ einddatum:
+ type: string
+ format: date
+ description: Datum en tijd waarop de actie is beeindigd.
+ externeIncasso:
+ allOf:
+ - $ref: '#/components/schemas/ExterneIncasso-sleutels'
+ description: Externe incasso waartoe de actie behoort.
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ Factuur-basis:
type: object
properties:
id:
@@ -13290,7 +13151,150 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurregel-sleutels:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Soort van de factuur: Inkoopfactuur of Verkoopfactuur. Referentiedatasoort FACTUURSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de factuur. Bijv. Goedgekeurd, Geblokkeerd, Betaald, Gedeeltelijk betaald etc. Referentiedatasoort INKOOPFACTUURSTATUS.
+ ontvangstdatum:
+ type: string
+ format: date
+ description: Datum waarop de factuur is ontvangen.
+ boekdatum:
+ type: string
+ format: date
+ description: Datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ factuurdatum:
+ type: string
+ format: date
+ description: Factuurdatum van de factuur.
+ plandatum:
+ type: string
+ format: date
+ description: Geplande datum voor betaling van de factuur.
+ vervaldatum:
+ type: string
+ format: date
+ description: De datum waarop de factuur uiterlijk betaald dient te zijn.
+ bedrag:
+ type: number
+ format: float
+ description: Bedrag van de factuur.
+ betaalwijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De betaalwijze van de factuur. Bijv. Contant, Op rekening, Automatische incasso etc. Referentiedatasoort FACTUURBETAALWIJZE.
+ betalingAkkoord:
+ type: boolean
+ description: Gefiatteerd voor betaling.
+ betalingskenmerk:
+ type: string
+ format: any
+ description: Betalingskenmerk van de factuur.
+ btwAangifte:
+ allOf:
+ - $ref: '#/components/schemas/BtwAangifte-sleutels'
+ description: De btw aangifte behorend bij deze factuur
+ btwBedrag:
+ type: number
+ format: float
+ description: Totale btw bedrag op de factuur.
+ btwGeenGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw hoog voor op aangifte btw.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw laag voor op aangifte btw.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ btwTerugTeVorderen:
+ type: boolean
+ description: btw terug te vorderen ja/nee.
+ btwVerlegd:
+ type: boolean
+ description: btw verlegd ja/nee.
+ correctiesoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort correctie op de factuur. Bijv. intern, extern. Referentiedatasoort CORRECTIESOORT.
+ externFactuurnummer:
+ type: string
+ format: any
+ description: Extern factuurnummer van de factuur.
+ factuurbetalingen:
+ description: De betalingen behorende bij de factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
+ factuurGeblokkeerd:
+ type: boolean
+ description: Geblokkeerd ja/nee.
+ factuurregels:
+ description: De factuurregels behorende bij deze factuur. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurregel-sleutels'
+ deprecated: true
+ gRekeningbedrag:
+ type: number
+ format: float
+ description: Bedrag G rekening.
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ korting:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Korting die wordt gegeven op het factuurbedrag.
+ openstaandBedrag:
+ type: number
+ format: float
+ description: Bedrag dat nog openstaat op de factuur.
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ regels:
+ description: De factuurregels behorende bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurregel-sleutels'
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ toeslag:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Toeslag die in rekening wordt gebracht op het factuurbedrag.
+ Prijsaanpassing-sleutels:
type: object
properties:
id:
@@ -13308,20 +13312,21 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurregelbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Factuurbericht:
allOf:
- - $ref: '#/components/schemas/Factuurregel'
+ - $ref: '#/components/schemas/Factuur'
- $ref: '#/components/schemas/Bericht-basis'
- Factuurregel:
+ Factuur:
oneOf:
- - $ref: '#/components/schemas/InkoopfactuurRegel'
- - $ref: '#/components/schemas/Factuurregel-basis'
- IncassoOpdrachtbericht:
+ - $ref: '#/components/schemas/Inkoopfactuur'
+ - $ref: '#/components/schemas/Verkoopfactuur'
+ - $ref: '#/components/schemas/Factuur-basis'
+ Factuurbetalingbericht:
allOf:
- - $ref: '#/components/schemas/IncassoOpdracht'
+ - $ref: '#/components/schemas/Factuurbetaling'
- $ref: '#/components/schemas/Bericht-basis'
- IncassoOpdracht:
+ Factuurbetaling:
type: object
properties:
id:
@@ -13339,62 +13344,61 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- aanmaakdatum:
- type: string
- format: date
- description: Aanmaakdatum van de opdracht
- fiatdatum:
- type: string
- format: date
- description: Datum gefiatteerd voor verzenden
- plandatum:
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de betaling, bijvoorbeeld betaald of te verwerken. Referentiedatasoort FACTUURSTATUS.
+ datum:
type: string
format: date
- description: Plandatum van afschrijven
- bankafschriftRegels:
- description: De bankafschrift regels behorende bij de incasso opdracht
- type: array
- items:
- $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ description: Datum van de betaling.
+ bankafschriftRegel:
+ allOf:
+ - $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ description: De bankafschriftregel waarop deze factuurbetaling is vermeld.
bedrag:
type: number
format: float
- description: Totaalbedrag te ontvangen in deze opdracht.
- boekingen:
- description: De boekingen behorende bij de incasso opdracht
+ description: Bedrag van de betaling.
+ betaalkenmerk:
+ type: string
+ format: any
+ description: Betalingskenmerk.
+ betaalopdracht:
+ allOf:
+ - $ref: '#/components/schemas/Betaalopdracht-sleutels'
+ description: De betaalopdracht van deze factuurbetaling.
+ facturen:
+ description: De factuur van deze factuurbetaling.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
+ $ref: '#/components/schemas/Factuur-sleutels'
grootboekmutatie:
allOf:
- $ref: '#/components/schemas/Grootboekmutatie-sleutels'
- description: De grootboekmutatie behorende bij de incasso opdracht
- postenAantal:
- type: integer
- format: int32
- description: Aantal posten in deze opdracht
+ description: De grootboekmutatie behorende bij de factuurbetaling.
+ kortingsbedrag:
+ type: number
+ format: float
+ description: Genomen korting.
rekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- relatie:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ rekeningBetaling:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- saldo:
- type: number
- format: float
- description: Het (nog) niet ontvangen bedrag in deze opdracht.
- Prijsaanpassingbericht:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- - $ref: '#/components/schemas/Bericht-basis'
- Prijsaanpassing:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ volgnummerInBetaalopdracht:
+ type: integer
+ format: int32
+ description: Het volgnummer van de betaling binnen de betaalopdracht.
+ Factuurregel-basis:
type: object
properties:
id:
@@ -13412,66 +13416,58 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort prijsaanpassing: Korting of toeslag Referentiedatasoort PRIJSAANPASSINGSOORT.'
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
omschrijving:
type: string
format: any
- description: Tekstveld met een omschrijving of nadere specificatie van het soort toeslag of korting.
+ description: De omschrijving van het gegeven.
bedrag:
type: number
format: float
- description: Het bedrag dat extra in rekening wordt gebracht, of de korting die wordt gegeven, op het factuur(regel)bedrag.
- percentage:
+ description: Bedrag.
+ btwAangiftebedrag:
type: number
format: float
- description: Getal waarmee de hoogte van de toeslag of korting wordt gespecificeerd in procenten van het totale regelbedrag of de totale regelhoeveelheid. Dit gegeven wordt alleen ter informatie meegegeven.
- Boekjaar-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- BtwAangifte-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Debiteurbericht:
+ description: Aangiftebedrag btw op deze regel.
+ btwTarief:
+ allOf:
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
+ description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen of nul.
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij de factuurregel.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ grootboekrekening:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ description: Het rekeningnummer.
+ korting:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Korting die wordt gegeven op het factuurregelbedrag.
+ toeslag:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Toeslag die in rekening wordt gebracht op het factuurregelbedrag.
+ verbijzonderingen:
+ description: Verbijzondering van de grootboekboeking.
+ type: array
+ items:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ Factuurregelbericht:
allOf:
- - $ref: '#/components/schemas/Debiteur'
+ - $ref: '#/components/schemas/Factuurregel'
- $ref: '#/components/schemas/Bericht-basis'
- Debiteur:
+ Factuurregel:
+ oneOf:
+ - $ref: '#/components/schemas/InkoopfactuurRegel'
+ - $ref: '#/components/schemas/Factuurregel-basis'
+ FinancieelBedrijfbericht:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf'
+ - $ref: '#/components/schemas/Bericht-basis'
+ FinancieelBedrijf:
type: object
properties:
id:
@@ -13489,59 +13485,76 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Soort debiteur: huurder, gemeente, etc. Referentiedatasoort DEBITEURSOORT.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de debiteur, bijvoorbeeld;geblokkeerd, alleen voor betalen, etc. Referentiedatasoort DEBITEURSTATUS.
- bedrijf:
+ description: 'Geeft het type van het bedrijf aan: VVE, TI, servicebedrijf. Referentiedatasoort BEDRIJFSOORT.'
+ naam:
+ type: string
+ format: any
+ description: De naam van het bedrijf.
+ betaalcyclusDuur:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: Geeft de duur aan die benodigd is voor het betaalproces.
+ boekjaren:
+ description: De boekjaren btw behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekjaar-sleutels'
+ btwAangiftes:
+ description: De aangifte btw behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/BtwAangifte-sleutels'
+ consolidatieBedrijf:
allOf:
- $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Bedrijf gekoppeld aan de debiteur.
- boekingen:
- description: De boekingen van de debiteur.
+ description: Geeft aan in welk bedrijf dit bedrijf geconsolideerd is.
+ crediteuren:
+ description: De crediteuren behorende bij het financieel bedrijf.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
- btwPlichtig:
- type: boolean
- description: Geeft aan of de debiteur btw plichtig is ja/nee.
- incassomachtigingen:
- description: De incassomachtigingen van de debiteur.
+ $ref: '#/components/schemas/Crediteur-sleutels'
+ debiteuren:
+ description: De debiteuren behorende bij het financieel bedrijf.
type: array
items:
- $ref: '#/components/schemas/Incassomachtiging'
- kortingsdagen:
- type: integer
- format: int32
- description: Aantal dagen waarin de debiteur de korting van het factuurbedrag mag aftrekken.
- rekeningen:
+ $ref: '#/components/schemas/Debiteur-sleutels'
+ deelnemingspercentage:
+ type: number
+ format: float
+ description: Indien het een deelname betreft bevat dit het percentage deelname.
+ geconsolideerdebedrijven:
+ description: Geeft aan welke bedrijven in dit bedrijf geconsolideerd zijn.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Betaalgegeven in informatiedomein Relaties
+ $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ grootboekrekeningen:
+ description: De grootboekrekeningen behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ maatschappelijkLabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het label waarmee wordt aangegeven of de activiteiten die binnen het financieel bedrijf worden verricht verantwoord worden als zijnde DAEB- of niet-DAEB-activiteiten. Als sprake is van een verbinding kan het financieel bedrijf ook het label ‘Geconsolideerde NIET-DAEB verbinding’ hebben. Referentiedatasoort MAATSCHAPPELIJKLABEL.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- saldo:
- type: number
- format: float
- description: Openstaand saldo.
- vervaltermijn:
- type: integer
- format: int32
- description: Standaard vervaltermijn voor uit te sturen facturen in dagen.
- Incassomachtigingbericht:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ verbijzonderingen:
+ description: De verbijzonderingen behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ Grootboekmutatiebericht:
allOf:
- - $ref: '#/components/schemas/Incassomachtiging'
+ - $ref: '#/components/schemas/Grootboekmutatie'
- $ref: '#/components/schemas/Bericht-basis'
- Incassomachtiging:
+ Grootboekmutatie:
type: object
properties:
id:
@@ -13559,57 +13572,122 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Soort machtiging: doorlopend/eenmalig. Referentiedatasoort MACHTIGINGSOORT.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de machtiging/ Bijv. Actief, Ingetrokken, . Referentiedatasoort MACHTIGINGSTATUS.
- begindatum:
- type: string
- format: date
- description: De begindatum van de incassomachtiging.
- einddatum:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ omschrijving:
type: string
- format: date
- description: De einddatum van de incassomachtiging.
- afgiftedatum:
+ format: any
+ description: De omschrijving van het gegeven.
+ boekdatum:
type: string
format: date
- description: De afgiftedatum van de machtiging
+ description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ betaalopdrachten:
+ description: De betaalopdracht behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Betaalopdracht-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
boekingen:
- description: De boekingen behorende bij de incassomachtiging.
+ description: De boekingen behorende bij de grootboekmutatie.
type: array
items:
$ref: '#/components/schemas/Boeking-sleutels'
- debiteur:
+ boekjaarPeriodesaldo:
allOf:
- - $ref: '#/components/schemas/Debiteur-sleutels'
- description: De debiteur van de machtiging.
- incassantId:
- type: string
- format: any
- description: Het incassantId van de machtiging.
- kenmerkMachtiging:
- type: string
- format: any
- description: Het kenmerk machtiging waarin het doel van de machtiging staat beschreven. Bijvoorbeeld inschrijving regio Almere.
- machtigingsnummer:
+ - $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ description: Het saldo van de periode waarop deze grootboekmutatie betrekking heeft.
+ boekstuknummer:
+ type: integer
+ format: int32
+ description: Nummer van het boekstuk waarin deze mutatie is ontstaan.
+ boekstuknummerCode:
type: string
format: any
- description: Het nummer van de machtiging.
- maximumBedrag:
+ description: Tijdelijke constructie om boekstuknummers door te geven die geen nummers zijn. In volgende major versie wordt dit opgeheven en veranderd attribuut boekstuknummer naar string.
+ boekstukregel:
+ type: integer
+ format: int32
+ description: Het regelnummer binnen het boekstuk waarin deze mutatie is ontstaan.
+ btwBedrag:
type: number
format: float
- description: Het maximale bedrag dat per incasso geincasseerd mag worden.
- rekening:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- Debiteur-sleutels:
+ description: Btw-bedrag op de mutatie.
+ btwTarieven:
+ description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen, nul.
+ type: array
+ items:
+ $ref: '#/components/schemas/BtwTarief-sleutels'
+ creditbedrag:
+ type: number
+ format: float
+ description: Bedrag credit.
+ debetbedrag:
+ type: number
+ format: float
+ description: Bedrag debet.
+ facturen:
+ description: De creditfacturen behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuur-sleutels'
+ factuurbetalingen:
+ description: De factuurbetalingen behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
+ factuurregels:
+ description: De factuurregels behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurregel-sleutels'
+ grootboekrekening:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ description: De grootboekrekening waarop de mutatie wordt geboekt.
+ herkomst:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Geeft de herkomst van de grootboekmutatie aan: memo, subadministratie etc. Referentiedatasoort GROOTBOEKMUTATIEHERKOMST.'
+ incassoOpdrachten:
+ description: De incasso opdrachten behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/IncassoOpdracht-sleutels'
+ inkoopfacturen:
+ description: De inkoopfacturen behorende bij de grootboekmutatie. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ deprecated: true
+ inkoopfactuurRegels:
+ description: De inkoopfactuurregels behorende bij de grootboekmutatie. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ deprecated: true
+ inkoopopdrachten:
+ description: De inkoopopdrachten behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopopdracht-sleutels'
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ verbijzondering:
+ allOf:
+ - $ref: '#/components/schemas/Verbijzondering-sleutels'
+ description: Verbijzondering van de grootboekmutatie.
+ volgnummer:
+ type: integer
+ format: int32
+ description: Volgnummer van de grootboekmutatie.
+ InkoopopdrachtRegel-sleutels:
type: object
properties:
id:
@@ -13627,12 +13705,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Betalingsregelingbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Grootboekrekeningbericht:
allOf:
- - $ref: '#/components/schemas/Betalingsregeling'
+ - $ref: '#/components/schemas/Grootboekrekening'
- $ref: '#/components/schemas/Bericht-basis'
- Betalingsregeling:
+ Grootboekrekening:
type: object
properties:
id:
@@ -13650,96 +13728,60 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Aanduiding van de soort grootboekrekening. Administraties kunnen verschillen in indeling en detaillering. De referentiedata wordt gevormd door het ReferentieGrootboekSchema (RGS) zoals gepubliceerd op https://www.referentiegrootboekschema.nl/kbase?field_category_target_id=27 (Kennisbank). Voorbeelden: *B – Balans *BIva – Immateriële vaste activa *BIvaKouVvp – Verkrijgings- of vervaardigingsprijs Referentiedatasoort GROOTBOEKREKENINGSOORT.'
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- toelichting:
- type: string
- format: any
- description: Nadere toelichting waarin extra informatie met betrekking tot de betalingsregeling kan worden opgenomen (memo, opmerkingen).
+ description: De omschrijving van het gegeven.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Status van de betalingsregeling. Voorbeeld: actief, bevroren, geannuleerd, enzovoort. Referentiedatasoort BETALINGSREGELINGSTATUS.'
+ description: Status van de rekening, bijvoorbeeld;actief, historisch. Referentiedatasoort GROOTBOEKREKENINGSTATUS.
begindatum:
type: string
format: date
- description: Datum waarop de regeling is of wordt gestart.
+ description: De begindatum waarop geboekt mag worden op de grootboekrekening.
einddatum:
type: string
format: date
- description: Datum waarop de regeling is of wordt beëindigd.
- afspraakdatum:
- type: string
- format: date
- description: Datum waarop de regeling is overeengekomen.
- bedrag:
- type: number
- format: float
- description: Het initiele bedrag van de betalingsregeling.
- betaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- betaalwijze:
+ description: De einddatum waarop geboekt mag worden op de grootboekrekening.
+ bedrijf:
allOf:
- - $ref: '#/components/schemas/Betaalwijze'
- description: De afgesproken betaalwijze voor de betalingsregeling.
- boekingen:
- description: De boekingen behorende bij de betalingsregeling.
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf van deze grootboekrekening.
+ begrotingen:
+ description: De begrotingen behorende bij de grootboekrekening.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
- debiteur:
- allOf:
- - $ref: '#/components/schemas/Debiteur'
- description: De debiteur voor wie de betalingsregeling is opgesteld.
- eindeReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Reden dat de betalingsregeling is beëindigd. Voorbeeld: voldaan, enzovoort. Referentiedatasoort BETALINGSREGELINGEINDEREDEN.'
- incassowijze:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Wijze van incasso waarop de betalingsregeling wordt betaald. OBSOLETE Referentiedatasoort INCASSOWIJZE.
- deprecated: true
- organisatieBetaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- overeenkomst:
- type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- prolongatieInterval:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: De interval die aangeeft na hoeveel tijd er wordt geprolongeerd op de betalingsregeling.
- prolongatieTotDatum:
- type: string
- format: date
- description: De betalingsregeling is geprolongeerd tot deze datum.
- saldo:
- type: number
- format: float
- description: Het saldo of openstaande bedrag van de betalingsregeling.
- termijnen:
- description: De betalingsregeling termijnen behorende bij de betalingsregeling.
+ $ref: '#/components/schemas/Begroting-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de grootboekrekening.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
+ boekjaarperiodesaldos:
+ description: De boekjaarperiodesaldi behorende bij de grootboekrekening.
type: array
items:
- $ref: '#/components/schemas/BetalingsregelingTermijn'
- termijnenAantal:
- type: number
- format: float
- description: Het aantal termijnen waaruit de betalingsregeling bestaat.
- Betaalwijzebericht:
+ $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels behorende bij de grootboekrekening.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ referentiegrootboekschemacode:
+ type: string
+ format: any
+ description: De verwijzing naar de code in het referentiegrootboekschema.
+ Incassomachtigingbericht:
allOf:
- - $ref: '#/components/schemas/Betaalwijze'
+ - $ref: '#/components/schemas/Incassomachtiging'
- $ref: '#/components/schemas/Bericht-basis'
- Betaalwijze:
+ Incassomachtiging:
type: object
properties:
id:
@@ -13757,44 +13799,61 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De wijze van incasso waarop de huurovereenkomst wordt betaald. Referentiedatasoort BETAALWIJZESOORT.
+ description: 'Soort machtiging: doorlopend/eenmalig. Referentiedatasoort MACHTIGINGSOORT.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de machtiging/ Bijv. Actief, Ingetrokken, . Referentiedatasoort MACHTIGINGSTATUS.
begindatum:
type: string
format: date
- description: De begindatum van de betaalwijze.
+ description: De begindatum van de incassomachtiging.
einddatum:
type: string
format: date
- description: De einddatum van de betaalwijze.
- betaalgegeven:
+ description: De einddatum van de incassomachtiging.
+ afgiftedatum:
type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- deelsoort:
+ format: date
+ description: De afgiftedatum van de machtiging
+ boekingen:
+ description: De boekingen behorende bij de incassomachtiging.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ debiteur:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De verdeelsleutel waarmee de vergoeding van de overeenkomst betaald moet worden over één of meerdere betalers, bijvoorbeeld percentueel. Referentiedatasoort BETAALWIJZEDEELSOORT.
- deelwaarde:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur van de machtiging.
+ incassantId:
type: string
format: any
- description: Het (maximale) bedrag of het percentage van het totaal die via deze betaalwijze betaald moet worden.
- incassomachtiging:
- allOf:
- - $ref: '#/components/schemas/Incassomachtiging'
- description: De digitale machtiging voor het uitvoeren van de incassoopdrachten. SEPA.
- incassomoment:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het moment waarop de incasso wordt gedaan. Referentiedatasoort INCASSOMOMENT.
- BetalingsregelingTermijnbericht:
+ description: Het incassantId van de machtiging.
+ kenmerkMachtiging:
+ type: string
+ format: any
+ description: Het kenmerk machtiging waarin het doel van de machtiging staat beschreven. Bijvoorbeeld inschrijving regio Almere.
+ machtigingsnummer:
+ type: string
+ format: any
+ description: Het nummer van de machtiging.
+ maximumBedrag:
+ type: number
+ format: float
+ description: Het maximale bedrag dat per incasso geincasseerd mag worden.
+ rekening:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ IncassoOpdrachtbericht:
allOf:
- - $ref: '#/components/schemas/BetalingsregelingTermijn'
+ - $ref: '#/components/schemas/IncassoOpdracht'
- $ref: '#/components/schemas/Bericht-basis'
- BetalingsregelingTermijn:
+ IncassoOpdracht:
type: object
properties:
id:
@@ -13812,59 +13871,110 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
omschrijving:
type: string
format: any
description: Omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de termijn, bv. openstaand, betaald. Referentiedatasoort BETALINGSREGELINGTERMIJNSTATUS.
- datum:
+ aanmaakdatum:
type: string
format: date
- description: Datum waarop de termijn betaald is.
- vervaldatum:
+ description: Aanmaakdatum van de opdracht
+ fiatdatum:
type: string
format: date
- description: Vervaldatum van de termijn.
+ description: Datum gefiatteerd voor verzenden
+ plandatum:
+ type: string
+ format: date
+ description: Plandatum van afschrijven
+ bankafschriftRegels:
+ description: De bankafschrift regels behorende bij de incasso opdracht
+ type: array
+ items:
+ $ref: '#/components/schemas/BankafschriftRegel-sleutels'
bedrag:
type: number
format: float
- description: Initiële bedrag van de termijn.
- betalingsregeling:
+ description: Totaalbedrag te ontvangen in deze opdracht.
+ boekingen:
+ description: De boekingen behorende bij de incasso opdracht
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ grootboekmutatie:
allOf:
- - $ref: '#/components/schemas/Betalingsregeling-sleutels'
- description: Betalingsregeling waaraan de termijn is gekoppeld.
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ description: De grootboekmutatie behorende bij de incasso opdracht
+ postenAantal:
+ type: integer
+ format: int32
+ description: Aantal posten in deze opdracht
+ rekening:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
saldo:
type: number
format: float
- description: Het saldo of openstaande bedrag van de termijn.
- Betalingsregeling-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- ExterneIncassobericht:
+ description: Het (nog) niet ontvangen bedrag in deze opdracht.
+ Inkoopfactuurbericht:
allOf:
- - $ref: '#/components/schemas/ExterneIncasso'
+ - $ref: '#/components/schemas/Inkoopfactuur'
- $ref: '#/components/schemas/Bericht-basis'
- ExterneIncasso:
+ Inkoopfactuur:
+ allOf:
+ - $ref: '#/components/schemas/Factuur-basis'
+ - type: object
+ properties:
+ ontvangstdatum:
+ type: string
+ format: date
+ description: Datum waarop de factuur is ontvangen.
+ crediteur:
+ allOf:
+ - $ref: '#/components/schemas/Crediteur-sleutels'
+ description: De crediteur van deze factuur.
+ inkoopopdracht:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopopdracht-sleutels'
+ description: De inkoopopdracht waaraan deze factuur gekoppeld is.
+ rekening:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ InkoopfactuurRegelbericht:
+ allOf:
+ - $ref: '#/components/schemas/InkoopfactuurRegel'
+ - $ref: '#/components/schemas/Bericht-basis'
+ InkoopfactuurRegel:
+ allOf:
+ - $ref: '#/components/schemas/Factuurregel-basis'
+ - type: object
+ properties:
+ factuur:
+ allOf:
+ - $ref: '#/components/schemas/Factuur-sleutels'
+ description: De creditfactuur van deze factuurregel.
+ inkoopfactuur:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ description: De inkoopfactuur van deze inkoopfactuurregel. OBSOLETE
+ deprecated: true
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels waar deze inkoopfactuurregel aan gekoppeld is
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ Inkoopopdrachtbericht:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopopdracht'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Inkoopopdracht:
type: object
properties:
id:
@@ -13882,72 +13992,83 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Soort externe incasso. Bijvoorbeeld: deurwaarder, incassobureau. Referentiedatasoort EXTERNEINCASSOSOORT.'
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
+ description: De omschrijving van het gegeven.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Status van de externe incasso. Bijvoorbeeld: lopend, afgesloten, bevroren. Referentiedatasoort EXTERNEINCASSOSTATUS.'
- begindatum:
- type: string
- format: date
- description: Datum waarop het is gestart.
- einddatum:
+ description: De status van de inkoopopdracht. Referentiedatasoort INKOOPOPDRACHTSTATUS.
+ opdrachtdatum:
type: string
format: date
- description: Datum waarop het is afgesloten.
- overdrachtsdatum:
+ description: De datum waarop de opdracht is verstrekt.
+ boekdatum:
type: string
format: date
- description: Datum waarop is overgedragen.
- bedrag:
+ description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ btwGeenGrondslagbedrag:
type: number
format: float
- description: Het bedrag dat is overgedragen.
- boekingen:
- description: De boekingen behorende bij de externe incasso.
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ crediteur:
+ allOf:
+ - $ref: '#/components/schemas/Crediteur-sleutels'
+ description: De crediteur van deze inkoopopdracht.
+ facturen:
+ description: De creditfacturen behorende bij deze inkoopopdracht.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
- debiteur:
- allOf:
- - $ref: '#/components/schemas/Debiteur'
- description: De debiteur waaraan de boeking gekoppeld is.
- externeincassoacties:
- description: De externe incasso acties behorende bij de externe incasso
+ $ref: '#/components/schemas/Factuur-sleutels'
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij deze inkoopopdracht.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ inkoopfacturen:
+ description: De inkoopfacturen behorende bij deze inkoopopdracht. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ deprecated: true
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels behorende bij deze inkoopopdracht.
type: array
items:
- $ref: '#/components/schemas/ExterneIncassoActie'
- overeenkomst:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ onderhoudsorder:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- overeenkomsten:
+ description: Referentie naar Onderhoudsorder-sleutels in informatiedomein Onderhoud
+ projectorders:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Projectorder-sleutels in informatiedomein Projectontwikkeling
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- saldo:
- type: number
- format: float
- description: Het saldo of openstaande bedrag.
- ExterneIncassoActiebericht:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ InkoopopdrachtRegelbericht:
allOf:
- - $ref: '#/components/schemas/ExterneIncassoActie'
+ - $ref: '#/components/schemas/InkoopopdrachtRegel'
- $ref: '#/components/schemas/Bericht-basis'
- ExterneIncassoActie:
+ InkoopopdrachtRegel:
type: object
properties:
id:
@@ -13965,54 +14086,60 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort actie. Referentiedatasoort EXTERNEINCASSOACTIESOORT.
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- status:
+ description: De omschrijving van het gegeven.
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van de actie. Referentiedatasoort EXTERNEINCASSOACTIESTATUS.
- begindatum:
- type: string
- format: date
- description: Datum en tijd waarop de actie is gestart.
- einddatum:
+ description: Geeft aan welk soort inkoopopdrachtregel het betreft. Bijv. Meerwerk, Minderwerk, Initieel etc. Referentiedatasoort INKOOPOPDRACHTREGELSOORT.
+ plandatum:
type: string
format: date
- description: Datum en tijd waarop de actie is beeindigd.
- externeIncasso:
+ description: Plandatum voor betaling.
+ btwGeenGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ btwTarief:
allOf:
- - $ref: '#/components/schemas/ExterneIncasso-sleutels'
- description: Externe incasso waartoe de actie behoort.
- relatie:
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
+ description: Het BTW-tarief dat van toepassing is op de inkoopopdrachtregel.
+ grootboekmutatie:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ description: De grootboekmutaties behorende bij deze inkoopopdrachtregel.
+ grootboekrekening:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ description: De grootboekrekening behorende bij deze inkoopopdrachtregel.
+ inkoopfactuurregels:
+ description: De inkoopfactuurregels behorende bij deze inkoopopdrachtregel.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ inkoopopdracht:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopopdracht-sleutels'
+ description: De inkoopopdracht van deze inkoopopdrachtregel.
+ onderhoudsTaak:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- ExterneIncasso-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: Referentie naar Onderhoudstaak-sleutels in informatiedomein Onderhoud
Leningbericht:
allOf:
- $ref: '#/components/schemas/Lening'
@@ -14084,7 +14211,7 @@ components:
description: Toegepaste opslag ten opzichte van de Euribor rente.
financier:
allOf:
- - $ref: '#/components/schemas/Crediteur'
+ - $ref: '#/components/schemas/Crediteur-sleutels'
description: De financier van de lening wordt opgenomen als crediteur in de financiële administratie.
nominaalSchuldrestant:
type: number
@@ -14095,7 +14222,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
rentepercentage:
type: number
format: float
@@ -14165,23 +14292,48 @@ components:
description: Totale btw bedrag op de offerte
korting:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: De korting die wordt gegeven op het totale offertebedrag. Een korting kan ook van toepassing zijn op een offerteregel (klasse Offerteregel).
offerteregels:
- description: sleutels
+ description: De offerteregels van de offerte. OBSOLETE
type: array
items:
- $ref: '#/components/schemas/Offerteregel'
+ $ref: '#/components/schemas/Offerteregel-sleutels'
+ deprecated: true
+ regels:
+ description: De offerte regels van de offerte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Offerteregel-sleutels'
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
toeslag:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: Het bedrag dat extra in rekening wordt gebracht op het totale offertebedrag. Een toeslag kan ook van toepassing zijn op een offerteregel (klasse Offerteregel).
+ Offerteregel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Offerteregelbericht:
allOf:
- $ref: '#/components/schemas/Offerteregel'
@@ -14223,11 +14375,11 @@ components:
description: Het soort besteding. Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
btwTarief:
allOf:
- - $ref: '#/components/schemas/BtwTarief'
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
description: Het op de netto prijs van toepassing zijnde BTW tarief. Hiermee kan de bruto prijs worden uitgerekend.
korting:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: De korting die wordt gegeven op het bedrag van de offerteregel. Een korting kan ook van toepassing zijn op het totale offertebedrag (klasse Offerte).
meeteenheid:
allOf:
@@ -14239,7 +14391,7 @@ components:
description: De offerte waar de offerteregel bij hoort.
toeslag:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: Het bedrag dat extra in rekening wordt gebracht op het bedrag van de offerteregel. Een toeslag kan ook van toepassing zijn op het totale offertebedrag (klasse Offerte.
Offerte-sleutels:
type: object
@@ -14260,6 +14412,45 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Prijsaanpassingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Prijsaanpassing:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort prijsaanpassing: Korting of toeslag Referentiedatasoort PRIJSAANPASSINGSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: Tekstveld met een omschrijving of nadere specificatie van het soort toeslag of korting.
+ bedrag:
+ type: number
+ format: float
+ description: Het bedrag dat extra in rekening wordt gebracht, of de korting die wordt gegeven, op het factuur(regel)bedrag.
+ percentage:
+ type: number
+ format: float
+ description: Getal waarmee de hoogte van de toeslag of korting wordt gespecificeerd in procenten van het totale regelbedrag of de totale regelhoeveelheid. Dit gegeven wordt alleen ter informatie meegegeven.
ToegelatenInstellingbericht:
allOf:
- $ref: '#/components/schemas/ToegelatenInstelling'
@@ -14295,6 +14486,101 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Indicatie waarmee wordt aangegeven op welke wijze de TI haar DAEB-activiteiten administratief scheidt van haar eventuele niet-DAEB activiteiten: Verlicht regime, Administratieve scheiding, Juridische scheiding of Hybride Referentiedatasoort VERANTWOORDINGREGIME.'
+ Verbijzonderingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Verbijzondering'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Verbijzondering:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft het soort verbijzondering aan, bijvoorbeeld;kostenplaats, kostensoort, dimensie. Referentiedatasoort VERBIJZONDERINGSOORT.
+ detailsoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Optionele nadere verbijzondering van de verbijzonderingsoort Dimensie. Hier kan een eigen dimensiesoort, waarvoor geen referentiedata voor Verbijzondering bestaat, worden toegevoegd. Referentiedatasoort VERBIJZONDERINGDETAILSOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de verbijzondering. Referentiedatasoort VERBIJZONDERINGSTATUS.
+ beginjaar:
+ type: integer
+ format: int32
+ description: Open vanaf jaar, bepaalt de periode waarin geboekt mag worden.
+ beginperiode:
+ type: integer
+ format: int32
+ description: Open vanaf periode, bepaalt de periode waarin geboekt mag worden.
+ eindjaar:
+ type: integer
+ format: int32
+ description: Open t/m jaar, bepaalt de periode waarin geboekt mag worden.
+ eindperiode:
+ type: integer
+ format: int32
+ description: Open t/m periode, bepaalt de periode waarin geboekt mag worden.
+ bedrijf:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf van deze verbijzondering.
+ begrotingen:
+ description: De begroting behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Begroting-sleutels'
+ boeking:
+ description: De boekingen behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
+ boekjaarperiodesaldos:
+ description: Het boekjaarperiodesaldo van de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ inkoopfactuurregels:
+ description: De inkoopfactuurregels behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ viaMemoriaalBoekenToestaan:
+ type: boolean
+ description: Boeking via memoriaal toegestaan ja/nee.
+ viaSubBoekenToestaan:
+ type: boolean
+ description: Boeking via sub toegestaan ja/nee.
Verkoopfactuurbericht:
allOf:
- $ref: '#/components/schemas/Verkoopfactuur'
@@ -14310,7 +14596,7 @@ components:
description: Datum waarop de factuur is verzonden.
Debiteur:
allOf:
- - $ref: '#/components/schemas/Debiteur'
+ - $ref: '#/components/schemas/Debiteur-sleutels'
description: De debiteur van deze factuur.
Bericht-basis:
type: object
diff --git a/Informatiedomeinen/Kwaliteit.yaml b/Informatiedomeinen/Kwaliteit.yaml
index 97b937c..b795606 100644
--- a/Informatiedomeinen/Kwaliteit.yaml
+++ b/Informatiedomeinen/Kwaliteit.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://kwaliteit.vera.io:{port}/{basePath}
description: Productieserver
@@ -39,7 +39,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -55,7 +55,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Ophalen van Kwaliteitsmetingsresultaten
+ summary: Ophalen van Kwaliteitsmetingsresultaten
operationId: listKwaliteitsmetingsresultaten
parameters:
- name: params
@@ -105,7 +105,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
operationId: createKwaliteitsmetingsresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -145,7 +145,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsresultaat
parameters:
@@ -180,7 +180,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsresultaat
@@ -217,7 +217,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
operationId: readKwaliteitsmetingsresultaatById
parameters:
- name: id
@@ -254,7 +254,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Vervangen van een Kwaliteitsmetingsresultaat
+ summary: Vervangen van een Kwaliteitsmetingsresultaat
operationId: replaceKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -292,7 +292,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Wijzigen van een Kwaliteitsmetingsresultaat
+ summary: Wijzigen van een Kwaliteitsmetingsresultaat
operationId: updateKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -331,7 +331,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Ophalen van Kwaliteitsmetingsverzoeken
+ summary: Ophalen van Kwaliteitsmetingsverzoeken
operationId: listKwaliteitsmetingsverzoeken
parameters:
- name: params
@@ -381,7 +381,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
operationId: createKwaliteitsmetingsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -421,7 +421,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsverzoek
parameters:
@@ -456,7 +456,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsverzoek
@@ -493,7 +493,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
operationId: readKwaliteitsmetingsverzoekById
parameters:
- name: id
@@ -530,7 +530,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Vervangen van een Kwaliteitsmetingsverzoek
+ summary: Vervangen van een Kwaliteitsmetingsverzoek
operationId: replaceKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -568,7 +568,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Wijzigen van een Kwaliteitsmetingsverzoek
+ summary: Wijzigen van een Kwaliteitsmetingsverzoek
operationId: updateKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -607,7 +607,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Ophalen van Onderzoeksopdrachten
+ summary: Ophalen van Onderzoeksopdrachten
operationId: listOnderzoeksopdrachten
parameters:
- name: params
@@ -657,7 +657,7 @@ paths:
post:
tags:
- 'Onderzoeksopdrachten'
- description: Voegt een nieuw(e) Onderzoeksopdracht toe.
+ summary: Voegt een nieuw(e) Onderzoeksopdracht toe.
operationId: createOnderzoeksopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -697,7 +697,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Vervangen van een Onderzoeksopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksopdracht
parameters:
@@ -732,7 +732,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksopdracht
@@ -769,7 +769,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Retourneert een Onderzoeksopdracht met de gegeven identifier
+ summary: Retourneert een Onderzoeksopdracht met de gegeven identifier
operationId: readOnderzoeksopdrachtById
parameters:
- name: id
@@ -806,7 +806,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: Vervangen van een Onderzoeksopdracht
+ summary: Vervangen van een Onderzoeksopdracht
operationId: replaceOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -844,7 +844,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: Wijzigen van een Onderzoeksopdracht
+ summary: Wijzigen van een Onderzoeksopdracht
operationId: updateOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -883,7 +883,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Ophalen van Onderzoeksresultaten
+ summary: Ophalen van Onderzoeksresultaten
operationId: listOnderzoeksresultaten
parameters:
- name: params
@@ -933,7 +933,7 @@ paths:
post:
tags:
- 'Onderzoeksresultaten'
- description: Voegt een nieuw(e) Onderzoeksresultaat toe.
+ summary: Voegt een nieuw(e) Onderzoeksresultaat toe.
operationId: createOnderzoeksresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -973,7 +973,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Vervangen van een Onderzoeksresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksresultaat
parameters:
@@ -1008,7 +1008,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksresultaat
@@ -1045,7 +1045,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Retourneert een Onderzoeksresultaat met de gegeven identifier
+ summary: Retourneert een Onderzoeksresultaat met de gegeven identifier
operationId: readOnderzoeksresultaatById
parameters:
- name: id
@@ -1082,7 +1082,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: Vervangen van een Onderzoeksresultaat
+ summary: Vervangen van een Onderzoeksresultaat
operationId: replaceOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1120,7 +1120,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: Wijzigen van een Onderzoeksresultaat
+ summary: Wijzigen van een Onderzoeksresultaat
operationId: updateOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1159,7 +1159,7 @@ paths:
get:
tags:
- 'Vragenlijsten'
- description: Ophalen van Vragenlijsten
+ summary: Ophalen van Vragenlijsten
operationId: listVragenlijsten
parameters:
- name: params
@@ -1209,7 +1209,7 @@ paths:
post:
tags:
- 'Vragenlijsten'
- description: Voegt een nieuw(e) Vragenlijst toe.
+ summary: Voegt een nieuw(e) Vragenlijst toe.
operationId: createVragenlijst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1249,7 +1249,7 @@ paths:
put:
tags:
- 'Vragenlijsten'
- description: |
+ summary: |
Vervangen van een Vragenlijst op basis van overeenkomstige sleutelvelden.
operationId: replaceVragenlijst
parameters:
@@ -1284,7 +1284,7 @@ paths:
patch:
tags:
- 'Vragenlijsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Vragenlijst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVragenlijst
@@ -1321,7 +1321,7 @@ paths:
get:
tags:
- 'Vragenlijsten'
- description: Retourneert een Vragenlijst met de gegeven identifier
+ summary: Retourneert een Vragenlijst met de gegeven identifier
operationId: readVragenlijstById
parameters:
- name: id
@@ -1358,7 +1358,7 @@ paths:
put:
tags:
- 'Vragenlijsten'
- description: Vervangen van een Vragenlijst
+ summary: Vervangen van een Vragenlijst
operationId: replaceVragenlijstById
parameters:
- name: 'id'
@@ -1396,7 +1396,7 @@ paths:
patch:
tags:
- 'Vragenlijsten'
- description: Wijzigen van een Vragenlijst
+ summary: Wijzigen van een Vragenlijst
operationId: updateVragenlijstById
parameters:
- name: 'id'
@@ -1435,7 +1435,7 @@ paths:
get:
tags:
- 'VragenlijstAntwoorden'
- description: Ophalen van VragenlijstAntwoorden
+ summary: Ophalen van VragenlijstAntwoorden
operationId: listVragenlijstAntwoorden
parameters:
- name: params
@@ -1485,7 +1485,7 @@ paths:
post:
tags:
- 'VragenlijstAntwoorden'
- description: Voegt een nieuw(e) VragenlijstAntwoord toe.
+ summary: Voegt een nieuw(e) VragenlijstAntwoord toe.
operationId: createVragenlijstAntwoord
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1525,7 +1525,7 @@ paths:
put:
tags:
- 'VragenlijstAntwoorden'
- description: |
+ summary: |
Vervangen van een VragenlijstAntwoord op basis van overeenkomstige sleutelvelden.
operationId: replaceVragenlijstAntwoord
parameters:
@@ -1560,7 +1560,7 @@ paths:
patch:
tags:
- 'VragenlijstAntwoorden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een VragenlijstAntwoord. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVragenlijstAntwoord
@@ -1597,7 +1597,7 @@ paths:
get:
tags:
- 'VragenlijstAntwoorden'
- description: Retourneert een VragenlijstAntwoord met de gegeven identifier
+ summary: Retourneert een VragenlijstAntwoord met de gegeven identifier
operationId: readVragenlijstAntwoordById
parameters:
- name: id
@@ -1634,7 +1634,7 @@ paths:
put:
tags:
- 'VragenlijstAntwoorden'
- description: Vervangen van een VragenlijstAntwoord
+ summary: Vervangen van een VragenlijstAntwoord
operationId: replaceVragenlijstAntwoordById
parameters:
- name: 'id'
@@ -1672,7 +1672,7 @@ paths:
patch:
tags:
- 'VragenlijstAntwoorden'
- description: Wijzigen van een VragenlijstAntwoord
+ summary: Wijzigen van een VragenlijstAntwoord
operationId: updateVragenlijstAntwoordById
parameters:
- name: 'id'
@@ -1711,7 +1711,7 @@ paths:
get:
tags:
- 'VragenlijstRegels'
- description: Ophalen van VragenlijstRegels
+ summary: Ophalen van VragenlijstRegels
operationId: listVragenlijstRegels
parameters:
- name: params
@@ -1761,7 +1761,7 @@ paths:
post:
tags:
- 'VragenlijstRegels'
- description: Voegt een nieuw(e) VragenlijstRegel toe.
+ summary: Voegt een nieuw(e) VragenlijstRegel toe.
operationId: createVragenlijstRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1801,7 +1801,7 @@ paths:
put:
tags:
- 'VragenlijstRegels'
- description: |
+ summary: |
Vervangen van een VragenlijstRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceVragenlijstRegel
parameters:
@@ -1836,7 +1836,7 @@ paths:
patch:
tags:
- 'VragenlijstRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een VragenlijstRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVragenlijstRegel
@@ -1873,7 +1873,7 @@ paths:
get:
tags:
- 'VragenlijstRegels'
- description: Retourneert een VragenlijstRegel met de gegeven identifier
+ summary: Retourneert een VragenlijstRegel met de gegeven identifier
operationId: readVragenlijstRegelById
parameters:
- name: id
@@ -1910,7 +1910,7 @@ paths:
put:
tags:
- 'VragenlijstRegels'
- description: Vervangen van een VragenlijstRegel
+ summary: Vervangen van een VragenlijstRegel
operationId: replaceVragenlijstRegelById
parameters:
- name: 'id'
@@ -1948,7 +1948,7 @@ paths:
patch:
tags:
- 'VragenlijstRegels'
- description: Wijzigen van een VragenlijstRegel
+ summary: Wijzigen van een VragenlijstRegel
operationId: updateVragenlijstRegelById
parameters:
- name: 'id'
@@ -2020,10 +2020,30 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Kwaliteit.All.Read: alleen lezen van alle resources
+ Kwaliteit.All.ReadWrite: lezen en schrijven van alle resources
+ Kwaliteit.Kwaliteitsmetingsresultaten.Read: alleen lezen van Kwaliteitsmetingsresultaten
+ Kwaliteit.Kwaliteitsmetingsresultaten.ReadWrite: lezen en schrijven van Kwaliteitsmetingsresultaten
+ Kwaliteit.Kwaliteitsmetingsverzoeken.Read: alleen lezen van Kwaliteitsmetingsverzoeken
+ Kwaliteit.Kwaliteitsmetingsverzoeken.ReadWrite: lezen en schrijven van Kwaliteitsmetingsverzoeken
+ Kwaliteit.Onderzoeksopdrachten.Read: alleen lezen van Onderzoeksopdrachten
+ Kwaliteit.Onderzoeksopdrachten.ReadWrite: lezen en schrijven van Onderzoeksopdrachten
+ Kwaliteit.Onderzoeksresultaten.Read: alleen lezen van Onderzoeksresultaten
+ Kwaliteit.Onderzoeksresultaten.ReadWrite: lezen en schrijven van Onderzoeksresultaten
+ Kwaliteit.Vragenlijsten.Read: alleen lezen van Vragenlijsten
+ Kwaliteit.Vragenlijsten.ReadWrite: lezen en schrijven van Vragenlijsten
+ Kwaliteit.VragenlijstAntwoorden.Read: alleen lezen van VragenlijstAntwoorden
+ Kwaliteit.VragenlijstAntwoorden.ReadWrite: lezen en schrijven van VragenlijstAntwoorden
+ Kwaliteit.VragenlijstRegels.Read: alleen lezen van VragenlijstRegels
+ Kwaliteit.VragenlijstRegels.ReadWrite: lezen en schrijven van VragenlijstRegels
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Kwaliteit.All.Read: alleen lezen van alle resources
Kwaliteit.All.ReadWrite: lezen en schrijven van alle resources
@@ -2090,11 +2110,11 @@ components:
description: de waarde van de beoordeling op basis van de gespecificeerde beoordelingsSchaal.
kwaliteitsmetingsverzoek:
allOf:
- - $ref: '#/components/schemas/Kwaliteitsmetingsverzoek'
+ - $ref: '#/components/schemas/Kwaliteitsmetingsverzoek-sleutels'
description: Het kwaliteitsmetingsverzoek behorende bij het resultaat.
onderzoeksopdracht:
allOf:
- - $ref: '#/components/schemas/Onderzoeksopdracht'
+ - $ref: '#/components/schemas/Onderzoeksopdracht-sleutels'
description: De onderzoeksopdracht die de basis is voor de analyse en het resultaat van de kwaliteitsmeting.
resultaatReactie:
allOf:
@@ -2130,7 +2150,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -2142,7 +2162,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -2178,6 +2198,44 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ Kwaliteitsmetingsverzoek-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderzoeksopdracht-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Kwaliteitsmetingsverzoekbericht:
allOf:
- $ref: '#/components/schemas/Kwaliteitsmetingsverzoek'
@@ -2216,15 +2274,15 @@ components:
afgerondeZaak:
type: string
format: uri
- description: Referentie naar Zaak in informatiedomein Dossier
+ description: Referentie naar Zaak-sleutels in informatiedomein Dossier
contactmoment:
type: string
format: uri
- description: Referentie naar Contactmoment in informatiedomein Relaties
+ description: Referentie naar Contactmoment-sleutels in informatiedomein Relaties
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
kwaliteitsmetingresultaat:
allOf:
- $ref: '#/components/schemas/Kwaliteitsmetingsresultaat-sleutels'
@@ -2232,25 +2290,25 @@ components:
onderhoudsverzoek:
type: string
format: uri
- description: Referentie naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referentie naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
onderzoeksopdracht:
allOf:
- - $ref: '#/components/schemas/Onderzoeksopdracht'
+ - $ref: '#/components/schemas/Onderzoeksopdracht-sleutels'
description: De onderzoeksopdracht die uitgevoerd is naar aanleiding van het kwaliteitsmetingsverzoek.
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
teEnqueterenRelatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Kwaliteitsmetingsresultaat-sleutels:
type: object
properties:
@@ -2309,11 +2367,11 @@ components:
description: De antwoorden die door de relatie zijn gegeven behorende bij de onderzoeksopdracht.
type: array
items:
- $ref: '#/components/schemas/VragenlijstAntwoord'
+ $ref: '#/components/schemas/VragenlijstAntwoord-sleutels'
contactgegeven:
type: string
format: uri
- description: Referentie naar Contactgegeven in informatiedomein Relaties
+ description: Referentie naar Contactgegeven-sleutels in informatiedomein Relaties
kanaal:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2321,20 +2379,16 @@ components:
postadres:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
vragenlijst:
allOf:
- - $ref: '#/components/schemas/Vragenlijst'
+ - $ref: '#/components/schemas/Vragenlijst-sleutels'
description: De vragenlijst die gebruikt moet worden bij het uitvoeren van de onderzoeksopdracht.
- VragenlijstAntwoordbericht:
- allOf:
- - $ref: '#/components/schemas/VragenlijstAntwoord'
- - $ref: '#/components/schemas/Bericht-basis'
- VragenlijstAntwoord:
+ VragenlijstAntwoord-sleutels:
type: object
properties:
id:
@@ -2353,23 +2407,30 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- antwoord:
+ Vragenlijst-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Antwoord op de gestelde vraag
- toelichting:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: Toelichting bij het antwoord
- vraag:
- allOf:
- - $ref: '#/components/schemas/VragenlijstRegel'
- description: De vraag die hoort bij het gegeven antwoord
- VragenlijstRegelbericht:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderzoeksresultaatbericht:
allOf:
- - $ref: '#/components/schemas/VragenlijstRegel'
+ - $ref: '#/components/schemas/Onderzoeksresultaat'
- $ref: '#/components/schemas/Bericht-basis'
- VragenlijstRegel:
+ Onderzoeksresultaat:
type: object
properties:
id:
@@ -2388,28 +2449,15 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft het soort van de vraag aan: open vraag, ja/nee vraag, meerkeuzevraag, optie, NPS, cijferschaal, etc. Referentiedatasoort VRAAGSOORT.'
- omschrijving:
- type: string
- format: any
- description: Beknopte omschrijving van de vraag.
- opties:
- description: De mogelijke opties bij de vraag indien geen open vraag. Referentiedatasoort ANTWOORDOPTIES.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- volgordenummer:
- type: integer
- format: int32
- description: Volgordenummer van de vraag in de vragenlijst.
- vragenlijsten:
- description: De vragenlijsten waar de vraag gebruikt wordt.
+ antwoorden:
+ description: De antwoorden die door de relatie zijn gegeven behorende bij de onderzoeksopdracht.
type: array
items:
- $ref: '#/components/schemas/Vragenlijst'
+ $ref: '#/components/schemas/VragenlijstAntwoord-sleutels'
+ opdracht:
+ allOf:
+ - $ref: '#/components/schemas/Onderzoeksopdracht-sleutels'
+ description: De onderzoeksopdracht.
Vragenlijstbericht:
allOf:
- $ref: '#/components/schemas/Vragenlijst'
@@ -2465,11 +2513,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Onderzoeksresultaatbericht:
+ VragenlijstAntwoordbericht:
allOf:
- - $ref: '#/components/schemas/Onderzoeksresultaat'
+ - $ref: '#/components/schemas/VragenlijstAntwoord'
- $ref: '#/components/schemas/Bericht-basis'
- Onderzoeksresultaat:
+ VragenlijstAntwoord:
type: object
properties:
id:
@@ -2488,15 +2536,63 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- antwoorden:
- description: De antwoorden die door de relatie zijn gegeven behorende bij de onderzoeksopdracht.
+ antwoord:
+ type: string
+ format: any
+ description: Antwoord op de gestelde vraag
+ toelichting:
+ type: string
+ format: any
+ description: Toelichting bij het antwoord
+ vraag:
+ allOf:
+ - $ref: '#/components/schemas/VragenlijstRegel-sleutels'
+ description: De vraag die hoort bij het gegeven antwoord
+ VragenlijstRegelbericht:
+ allOf:
+ - $ref: '#/components/schemas/VragenlijstRegel'
+ - $ref: '#/components/schemas/Bericht-basis'
+ VragenlijstRegel:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Geeft het soort van de vraag aan: open vraag, ja/nee vraag, meerkeuzevraag, optie, NPS, cijferschaal, etc. Referentiedatasoort VRAAGSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: Beknopte omschrijving van de vraag.
+ opties:
+ description: De mogelijke opties bij de vraag indien geen open vraag. Referentiedatasoort ANTWOORDOPTIES.
type: array
items:
- $ref: '#/components/schemas/VragenlijstAntwoord'
- opdracht:
- allOf:
- - $ref: '#/components/schemas/Onderzoeksopdracht'
- description: De onderzoeksopdracht.
+ $ref: '#/components/schemas/Referentiedata'
+ volgordenummer:
+ type: integer
+ format: int32
+ description: Volgordenummer van de vraag in de vragenlijst.
+ vragenlijsten:
+ description: De vragenlijsten waar de vraag gebruikt wordt.
+ type: array
+ items:
+ $ref: '#/components/schemas/Vragenlijst-sleutels'
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Onderhoud.yaml b/Informatiedomeinen/Onderhoud.yaml
index 4c927cc..bc2a585 100644
--- a/Informatiedomeinen/Onderhoud.yaml
+++ b/Informatiedomeinen/Onderhoud.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://onderhoud.vera.io:{port}/{basePath}
description: Productieserver
@@ -43,7 +43,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -59,7 +59,7 @@ paths:
get:
tags:
- 'Defecten'
- description: Ophalen van Defecten
+ summary: Ophalen van Defecten
operationId: listDefecten
parameters:
- name: params
@@ -109,7 +109,7 @@ paths:
post:
tags:
- 'Defecten'
- description: Voegt een nieuw(e) Defect toe.
+ summary: Voegt een nieuw(e) Defect toe.
operationId: createDefect
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -149,7 +149,7 @@ paths:
put:
tags:
- 'Defecten'
- description: |
+ summary: |
Vervangen van een Defect op basis van overeenkomstige sleutelvelden.
operationId: replaceDefect
parameters:
@@ -184,7 +184,7 @@ paths:
patch:
tags:
- 'Defecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Defect. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDefect
@@ -221,7 +221,7 @@ paths:
get:
tags:
- 'Defecten'
- description: Retourneert een Defect met de gegeven identifier
+ summary: Retourneert een Defect met de gegeven identifier
operationId: readDefectById
parameters:
- name: id
@@ -258,7 +258,7 @@ paths:
put:
tags:
- 'Defecten'
- description: Vervangen van een Defect
+ summary: Vervangen van een Defect
operationId: replaceDefectById
parameters:
- name: 'id'
@@ -296,7 +296,7 @@ paths:
patch:
tags:
- 'Defecten'
- description: Wijzigen van een Defect
+ summary: Wijzigen van een Defect
operationId: updateDefectById
parameters:
- name: 'id'
@@ -335,7 +335,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Ophalen van Inspectierapporten
+ summary: Ophalen van Inspectierapporten
operationId: listInspectierapporten
parameters:
- name: params
@@ -385,7 +385,7 @@ paths:
post:
tags:
- 'Inspectierapporten'
- description: Voegt een nieuw(e) Inspectierapport toe.
+ summary: Voegt een nieuw(e) Inspectierapport toe.
operationId: createInspectierapport
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -425,7 +425,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Vervangen van een Inspectierapport op basis van overeenkomstige sleutelvelden.
operationId: replaceInspectierapport
parameters:
@@ -460,7 +460,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inspectierapport. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInspectierapport
@@ -497,7 +497,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Retourneert een Inspectierapport met de gegeven identifier
+ summary: Retourneert een Inspectierapport met de gegeven identifier
operationId: readInspectierapportById
parameters:
- name: id
@@ -534,7 +534,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: Vervangen van een Inspectierapport
+ summary: Vervangen van een Inspectierapport
operationId: replaceInspectierapportById
parameters:
- name: 'id'
@@ -572,7 +572,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: Wijzigen van een Inspectierapport
+ summary: Wijzigen van een Inspectierapport
operationId: updateInspectierapportById
parameters:
- name: 'id'
@@ -611,7 +611,7 @@ paths:
get:
tags:
- 'Onderhoudsbestedingen'
- description: Ophalen van Onderhoudsbestedingen
+ summary: Ophalen van Onderhoudsbestedingen
operationId: listOnderhoudsbestedingen
parameters:
- name: params
@@ -661,7 +661,7 @@ paths:
post:
tags:
- 'Onderhoudsbestedingen'
- description: Voegt een nieuw(e) Onderhoudsbesteding toe.
+ summary: Voegt een nieuw(e) Onderhoudsbesteding toe.
operationId: createOnderhoudsbesteding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -701,7 +701,7 @@ paths:
put:
tags:
- 'Onderhoudsbestedingen'
- description: |
+ summary: |
Vervangen van een Onderhoudsbesteding op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsbesteding
parameters:
@@ -736,7 +736,7 @@ paths:
patch:
tags:
- 'Onderhoudsbestedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsbesteding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsbesteding
@@ -773,7 +773,7 @@ paths:
get:
tags:
- 'Onderhoudsbestedingen'
- description: Retourneert een Onderhoudsbesteding met de gegeven identifier
+ summary: Retourneert een Onderhoudsbesteding met de gegeven identifier
operationId: readOnderhoudsbestedingById
parameters:
- name: id
@@ -810,7 +810,7 @@ paths:
put:
tags:
- 'Onderhoudsbestedingen'
- description: Vervangen van een Onderhoudsbesteding
+ summary: Vervangen van een Onderhoudsbesteding
operationId: replaceOnderhoudsbestedingById
parameters:
- name: 'id'
@@ -848,7 +848,7 @@ paths:
patch:
tags:
- 'Onderhoudsbestedingen'
- description: Wijzigen van een Onderhoudsbesteding
+ summary: Wijzigen van een Onderhoudsbesteding
operationId: updateOnderhoudsbestedingById
parameters:
- name: 'id'
@@ -887,7 +887,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Ophalen van Onderhoudsorders
+ summary: Ophalen van Onderhoudsorders
operationId: listOnderhoudsorders
parameters:
- name: params
@@ -937,7 +937,7 @@ paths:
post:
tags:
- 'Onderhoudsorders'
- description: Voegt een nieuw(e) Onderhoudsorder toe.
+ summary: Voegt een nieuw(e) Onderhoudsorder toe.
operationId: createOnderhoudsorder
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -977,7 +977,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Vervangen van een Onderhoudsorder op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsorder
parameters:
@@ -1012,7 +1012,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsorder. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsorder
@@ -1049,7 +1049,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Retourneert een Onderhoudsorder met de gegeven identifier
+ summary: Retourneert een Onderhoudsorder met de gegeven identifier
operationId: readOnderhoudsorderById
parameters:
- name: id
@@ -1086,7 +1086,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: Vervangen van een Onderhoudsorder
+ summary: Vervangen van een Onderhoudsorder
operationId: replaceOnderhoudsorderById
parameters:
- name: 'id'
@@ -1124,7 +1124,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: Wijzigen van een Onderhoudsorder
+ summary: Wijzigen van een Onderhoudsorder
operationId: updateOnderhoudsorderById
parameters:
- name: 'id'
@@ -1163,7 +1163,7 @@ paths:
get:
tags:
- 'Onderhoudstaken'
- description: Ophalen van Onderhoudstaken
+ summary: Ophalen van Onderhoudstaken
operationId: listOnderhoudstaken
parameters:
- name: params
@@ -1213,7 +1213,7 @@ paths:
post:
tags:
- 'Onderhoudstaken'
- description: Voegt een nieuw(e) Onderhoudstaak toe.
+ summary: Voegt een nieuw(e) Onderhoudstaak toe.
operationId: createOnderhoudstaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1253,7 +1253,7 @@ paths:
put:
tags:
- 'Onderhoudstaken'
- description: |
+ summary: |
Vervangen van een Onderhoudstaak op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudstaak
parameters:
@@ -1288,7 +1288,7 @@ paths:
patch:
tags:
- 'Onderhoudstaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudstaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudstaak
@@ -1325,7 +1325,7 @@ paths:
get:
tags:
- 'Onderhoudstaken'
- description: Retourneert een Onderhoudstaak met de gegeven identifier
+ summary: Retourneert een Onderhoudstaak met de gegeven identifier
operationId: readOnderhoudstaakById
parameters:
- name: id
@@ -1362,7 +1362,7 @@ paths:
put:
tags:
- 'Onderhoudstaken'
- description: Vervangen van een Onderhoudstaak
+ summary: Vervangen van een Onderhoudstaak
operationId: replaceOnderhoudstaakById
parameters:
- name: 'id'
@@ -1400,7 +1400,7 @@ paths:
patch:
tags:
- 'Onderhoudstaken'
- description: Wijzigen van een Onderhoudstaak
+ summary: Wijzigen van een Onderhoudstaak
operationId: updateOnderhoudstaakById
parameters:
- name: 'id'
@@ -1439,7 +1439,7 @@ paths:
get:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Ophalen van Onderhoudstaakvoorcalculaties
+ summary: Ophalen van Onderhoudstaakvoorcalculaties
operationId: listOnderhoudstaakvoorcalculaties
parameters:
- name: params
@@ -1489,7 +1489,7 @@ paths:
post:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Voegt een nieuw(e) Onderhoudstaakvoorcalculatie toe.
+ summary: Voegt een nieuw(e) Onderhoudstaakvoorcalculatie toe.
operationId: createOnderhoudstaakvoorcalculatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1529,7 +1529,7 @@ paths:
put:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: |
+ summary: |
Vervangen van een Onderhoudstaakvoorcalculatie op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudstaakvoorcalculatie
parameters:
@@ -1564,7 +1564,7 @@ paths:
patch:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudstaakvoorcalculatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudstaakvoorcalculatie
@@ -1601,7 +1601,7 @@ paths:
get:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Retourneert een Onderhoudstaakvoorcalculatie met de gegeven identifier
+ summary: Retourneert een Onderhoudstaakvoorcalculatie met de gegeven identifier
operationId: readOnderhoudstaakvoorcalculatieById
parameters:
- name: id
@@ -1638,7 +1638,7 @@ paths:
put:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Vervangen van een Onderhoudstaakvoorcalculatie
+ summary: Vervangen van een Onderhoudstaakvoorcalculatie
operationId: replaceOnderhoudstaakvoorcalculatieById
parameters:
- name: 'id'
@@ -1676,7 +1676,7 @@ paths:
patch:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Wijzigen van een Onderhoudstaakvoorcalculatie
+ summary: Wijzigen van een Onderhoudstaakvoorcalculatie
operationId: updateOnderhoudstaakvoorcalculatieById
parameters:
- name: 'id'
@@ -1715,7 +1715,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Ophalen van Onderhoudsverzoeken
+ summary: Ophalen van Onderhoudsverzoeken
operationId: listOnderhoudsverzoeken
parameters:
- name: params
@@ -1765,7 +1765,7 @@ paths:
post:
tags:
- 'Onderhoudsverzoeken'
- description: Voegt een nieuw(e) Onderhoudsverzoek toe.
+ summary: Voegt een nieuw(e) Onderhoudsverzoek toe.
operationId: createOnderhoudsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1805,7 +1805,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Vervangen van een Onderhoudsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsverzoek
parameters:
@@ -1840,7 +1840,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsverzoek
@@ -1877,7 +1877,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Retourneert een Onderhoudsverzoek met de gegeven identifier
+ summary: Retourneert een Onderhoudsverzoek met de gegeven identifier
operationId: readOnderhoudsverzoekById
parameters:
- name: id
@@ -1914,7 +1914,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: Vervangen van een Onderhoudsverzoek
+ summary: Vervangen van een Onderhoudsverzoek
operationId: replaceOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -1952,7 +1952,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: Wijzigen van een Onderhoudsverzoek
+ summary: Wijzigen van een Onderhoudsverzoek
operationId: updateOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -1991,7 +1991,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Ophalen van Onderhoudsverzoekverrekeningen
+ summary: Ophalen van Onderhoudsverzoekverrekeningen
operationId: listOnderhoudsverzoekverrekeningen
parameters:
- name: params
@@ -2041,7 +2041,7 @@ paths:
post:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Voegt een nieuw(e) Onderhoudsverzoekverrekening toe.
+ summary: Voegt een nieuw(e) Onderhoudsverzoekverrekening toe.
operationId: createOnderhoudsverzoekverrekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2081,7 +2081,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: |
+ summary: |
Vervangen van een Onderhoudsverzoekverrekening op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsverzoekverrekening
parameters:
@@ -2116,7 +2116,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsverzoekverrekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsverzoekverrekening
@@ -2153,7 +2153,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Retourneert een Onderhoudsverzoekverrekening met de gegeven identifier
+ summary: Retourneert een Onderhoudsverzoekverrekening met de gegeven identifier
operationId: readOnderhoudsverzoekverrekeningById
parameters:
- name: id
@@ -2190,7 +2190,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Vervangen van een Onderhoudsverzoekverrekening
+ summary: Vervangen van een Onderhoudsverzoekverrekening
operationId: replaceOnderhoudsverzoekverrekeningById
parameters:
- name: 'id'
@@ -2228,7 +2228,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Wijzigen van een Onderhoudsverzoekverrekening
+ summary: Wijzigen van een Onderhoudsverzoekverrekening
operationId: updateOnderhoudsverzoekverrekeningById
parameters:
- name: 'id'
@@ -2267,7 +2267,7 @@ paths:
get:
tags:
- 'Standaardprijzen'
- description: Ophalen van Standaardprijzen
+ summary: Ophalen van Standaardprijzen
operationId: listStandaardprijzen
parameters:
- name: params
@@ -2317,7 +2317,7 @@ paths:
post:
tags:
- 'Standaardprijzen'
- description: Voegt een nieuw(e) Standaardprijs toe.
+ summary: Voegt een nieuw(e) Standaardprijs toe.
operationId: createStandaardprijs
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2357,7 +2357,7 @@ paths:
put:
tags:
- 'Standaardprijzen'
- description: |
+ summary: |
Vervangen van een Standaardprijs op basis van overeenkomstige sleutelvelden.
operationId: replaceStandaardprijs
parameters:
@@ -2392,7 +2392,7 @@ paths:
patch:
tags:
- 'Standaardprijzen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Standaardprijs. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateStandaardprijs
@@ -2429,7 +2429,7 @@ paths:
get:
tags:
- 'Standaardprijzen'
- description: Retourneert een Standaardprijs met de gegeven identifier
+ summary: Retourneert een Standaardprijs met de gegeven identifier
operationId: readStandaardprijsById
parameters:
- name: id
@@ -2466,7 +2466,7 @@ paths:
put:
tags:
- 'Standaardprijzen'
- description: Vervangen van een Standaardprijs
+ summary: Vervangen van een Standaardprijs
operationId: replaceStandaardprijsById
parameters:
- name: 'id'
@@ -2504,7 +2504,7 @@ paths:
patch:
tags:
- 'Standaardprijzen'
- description: Wijzigen van een Standaardprijs
+ summary: Wijzigen van een Standaardprijs
operationId: updateStandaardprijsById
parameters:
- name: 'id'
@@ -2576,10 +2576,34 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Onderhoud.All.Read: alleen lezen van alle resources
+ Onderhoud.All.ReadWrite: lezen en schrijven van alle resources
+ Onderhoud.Defecten.Read: alleen lezen van Defecten
+ Onderhoud.Defecten.ReadWrite: lezen en schrijven van Defecten
+ Onderhoud.Inspectierapporten.Read: alleen lezen van Inspectierapporten
+ Onderhoud.Inspectierapporten.ReadWrite: lezen en schrijven van Inspectierapporten
+ Onderhoud.Onderhoudsbestedingen.Read: alleen lezen van Onderhoudsbestedingen
+ Onderhoud.Onderhoudsbestedingen.ReadWrite: lezen en schrijven van Onderhoudsbestedingen
+ Onderhoud.Onderhoudsorders.Read: alleen lezen van Onderhoudsorders
+ Onderhoud.Onderhoudsorders.ReadWrite: lezen en schrijven van Onderhoudsorders
+ Onderhoud.Onderhoudstaken.Read: alleen lezen van Onderhoudstaken
+ Onderhoud.Onderhoudstaken.ReadWrite: lezen en schrijven van Onderhoudstaken
+ Onderhoud.Onderhoudstaakvoorcalculaties.Read: alleen lezen van Onderhoudstaakvoorcalculaties
+ Onderhoud.Onderhoudstaakvoorcalculaties.ReadWrite: lezen en schrijven van Onderhoudstaakvoorcalculaties
+ Onderhoud.Onderhoudsverzoeken.Read: alleen lezen van Onderhoudsverzoeken
+ Onderhoud.Onderhoudsverzoeken.ReadWrite: lezen en schrijven van Onderhoudsverzoeken
+ Onderhoud.Onderhoudsverzoekverrekeningen.Read: alleen lezen van Onderhoudsverzoekverrekeningen
+ Onderhoud.Onderhoudsverzoekverrekeningen.ReadWrite: lezen en schrijven van Onderhoudsverzoekverrekeningen
+ Onderhoud.Standaardprijzen.Read: alleen lezen van Standaardprijzen
+ Onderhoud.Standaardprijzen.ReadWrite: lezen en schrijven van Standaardprijzen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Onderhoud.All.Read: alleen lezen van alle resources
Onderhoud.All.ReadWrite: lezen en schrijven van alle resources
@@ -2655,22 +2679,22 @@ components:
bouwkundigElement:
type: string
format: uri
- description: Referentie naar BouwkundigElement in informatiedomein Vastgoed
+ description: Referentie naar BouwkundigElement-sleutels in informatiedomein Vastgoed
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObject:
type: string
format: uri
- description: Referentie naar CollectiefObject in informatiedomein Vastgoed
+ description: Referentie naar CollectiefObject-sleutels in informatiedomein Vastgoed
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
inspectierapport:
allOf:
- - $ref: '#/components/schemas/Inspectierapport'
+ - $ref: '#/components/schemas/Inspectierapport-sleutels'
description: Het inspectierapport waarmee het defect is gemeld.
locatie:
allOf:
@@ -2680,7 +2704,7 @@ components:
description: De onderhoudsverzoeken waarmee het defect is gemeld.
type: array
items:
- $ref: '#/components/schemas/Onderhoudsverzoek'
+ $ref: '#/components/schemas/Onderhoudsverzoek-sleutels'
oorzaak:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2690,7 +2714,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2717,7 +2741,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -2729,7 +2753,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -2765,6 +2789,44 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ Inspectierapport-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsverzoek-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Inspectierapportbericht:
allOf:
- $ref: '#/components/schemas/Inspectierapport'
@@ -2807,19 +2869,19 @@ components:
$ref: '#/components/schemas/Defect-sleutels'
inspectieOrder:
allOf:
- - $ref: '#/components/schemas/Onderhoudsorder'
+ - $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: De inspectieorder waardoor de inspectie heeft plaatsgevonden.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
voorgesteldeOnderhoudstaken:
description: In de situatie dat de inspecteur ook uit te voeren onderhoudstaken vaststelt tijdens de inspectie kunnen deze als voorgestelde onderhoudstaken opgenomen worden bij het inspectierapport
type: array
items:
- $ref: '#/components/schemas/Onderhoudstaak'
+ $ref: '#/components/schemas/Onderhoudstaak-sleutels'
Defect-sleutels:
type: object
properties:
@@ -2839,6 +2901,112 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsorder-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudstaak-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsbestedingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Onderhoudsbesteding'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Onderhoudsbesteding:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort besteding voor de onderhoudstaak. Afhankelijk van de afrekenwijze kunnen hier verschillende bestedingsoorten gebruikt worden zoals vaste taakprijs bij nacalculatie eenheidsprijzen en werktijd bij nacalculatie Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: De korte omschrijving van de onderhoudsbesteding.
+ uitvoerdatum:
+ type: string
+ format: date-time
+ description: De datum waarop de onderhoudsbesteding is uitgevoerd.
+ uitvoerBegintijd:
+ type: string
+ format: date-time
+ description: De aanvangstijd van de uitvoering
+ uitvoerEindtijd:
+ type: string
+ format: date-time
+ description: De eindtijd van de uitvoering.
+ aantal:
+ type: number
+ format: float
+ description: Het aantal bestede middelen of tijd (uitgedrukt in de meeteenheid van de besteding).
+ bedrag:
+ type: number
+ format: float
+ description: De totale kosten van de bestedingsregel op basis van het aantal, de meeteenheid en het eventueel gebruikte artikel
+ grootboekmutatie:
+ type: string
+ format: uri
+ description: Referentie naar Grootboekmutatie-sleutels in informatiedomein Financien
+ meeteenheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De meeteenheid waarin de besteding wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
+ onderhoudstaak:
+ allOf:
+ - $ref: '#/components/schemas/Onderhoudstaak-sleutels'
+ description: Verwijzing naar de onderhoudstaak
+ reistijd:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: De reistijd
Onderhoudsorderbericht:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder'
@@ -2911,22 +3079,22 @@ components:
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
btwVerlegd:
type: boolean
description: Uiteindelijke beslissing of de btw is verlegd ja/nee. Mag afwijken van de instelling op de crediteur.
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObject:
type: string
format: uri
- description: Referentie naar CollectiefObject in informatiedomein Vastgoed
+ description: Referentie naar CollectiefObject-sleutels in informatiedomein Vastgoed
debiteur:
type: string
format: uri
- description: Referentie naar Debiteur in informatiedomein Financien
+ description: Referentie naar Debiteur-sleutels in informatiedomein Financien
defecten:
description: De defecten die via het verzoek of het inspectierapport zijn gemeld.
type: array
@@ -2935,7 +3103,7 @@ components:
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
financieelGereeddatum:
type: string
format: date-time
@@ -2945,27 +3113,27 @@ components:
items:
type: string
format: uri
- description: Referenties naar Offerte in informatiedomein Financien
+ description: Referenties naar Offerte-sleutels in informatiedomein Financien
onderhoudstaken:
description: De onderhoudstaken behorend bij de onderhoudsorder.
type: array
items:
- $ref: '#/components/schemas/Onderhoudstaak'
+ $ref: '#/components/schemas/Onderhoudstaak-sleutels'
onderhoudsverzoeken:
description: Het onderhoudsverzoek of de onderhoudsverzoeken die hebben geleid tot de onderhoudsorder.
type: array
items:
- $ref: '#/components/schemas/Onderhoudsverzoek'
+ $ref: '#/components/schemas/Onderhoudsverzoek-sleutels'
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
technischGereeddatum:
type: string
format: date-time
@@ -2974,25 +3142,6 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'De waarde die het soort uitvoerende aangeeft die de taak uitvoert. Bijvoorbeeld: vakgroep/leverancier of intern/extern. Referentiedatasoort UITVOERENDESOORT.'
- Onderhoudsorder-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Onderhoudstaakbericht:
allOf:
- $ref: '#/components/schemas/Onderhoudstaak'
@@ -3033,7 +3182,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
defecten:
description: De geconstateerde defecten die met de onderhoudstaak worden verholpen
type: array
@@ -3043,21 +3192,21 @@ components:
description: De onderhoudsbestedingen behorend bij de onderhoudstaak.
type: array
items:
- $ref: '#/components/schemas/Onderhoudsbesteding'
+ $ref: '#/components/schemas/Onderhoudsbesteding-sleutels'
onderhoudsorder:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: De onderhoudsorder behorend bij de onderhoudstaak.
onderhoudsverzoek:
allOf:
- - $ref: '#/components/schemas/Onderhoudsverzoek'
+ - $ref: '#/components/schemas/Onderhoudsverzoek-sleutels'
description: Het onderhoudsverzoek behorend bij de onderhoudstaak. Ook als er (nog) geen onderhoudsorder is bij de onderhoudstaak, kan op deze manier het bijbehorende onderhoudsverzoek worden gevonden.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
specialisme:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -3066,12 +3215,50 @@ components:
description: De onderhoudstaakvoorcalculaties behorende bij de onderhoudstaak.
type: array
items:
- $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie'
- Onderhoudsbestedingbericht:
+ $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie-sleutels'
+ Onderhoudsbesteding-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudstaakvoorcalculatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudstaakvoorcalculatiebericht:
allOf:
- - $ref: '#/components/schemas/Onderhoudsbesteding'
+ - $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie'
- $ref: '#/components/schemas/Bericht-basis'
- Onderhoudsbesteding:
+ Onderhoudstaakvoorcalculatie:
type: object
properties:
id:
@@ -3090,52 +3277,35 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
+ bestedingsoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort besteding voor de onderhoudstaak. Afhankelijk van de afrekenwijze kunnen hier verschillende bestedingsoorten gebruikt worden zoals vaste taakprijs bij nacalculatie eenheidsprijzen en werktijd bij nacalculatie Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
+ description: Het soort besteding voor de voorcalculatie. Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
omschrijving:
type: string
format: any
- description: De korte omschrijving van de onderhoudsbesteding.
- uitvoerdatum:
- type: string
- format: date-time
- description: De datum waarop de onderhoudsbesteding is uitgevoerd.
- uitvoerBegintijd:
- type: string
- format: date-time
- description: De aanvangstijd van de uitvoering
- uitvoerEindtijd:
- type: string
- format: date-time
- description: De eindtijd van de uitvoering.
+ description: De omschrijving van de voorcalculatie.
aantal:
type: number
format: float
- description: Het aantal bestede middelen of tijd (uitgedrukt in de meeteenheid van de besteding).
+ description: Het verwachte aantal te besteden middelen of tijd (uitgedrukt in de meeteenheid van de voorcalculatie).
bedrag:
type: number
format: float
- description: De totale kosten van de bestedingsregel op basis van het aantal, de meeteenheid en het eventueel gebruikte artikel
- grootboekmutatie:
- type: string
- format: uri
- description: Referentie naar Grootboekmutatie in informatiedomein Financien
+ description: Een indicatie van de kosten van de verwachte bestedingen.
meeteenheid:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De meeteenheid waarin de besteding wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
+ description: De meeteenheid waarin de voorcalculatie wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
onderhoudstaak:
allOf:
- $ref: '#/components/schemas/Onderhoudstaak-sleutels'
- description: Verwijzing naar de onderhoudstaak
- reistijd:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: De reistijd
- Onderhoudstaak-sleutels:
+ description: De onderhoudstaak behorende bij de voorcalculatie.
+ standaardprijs:
+ allOf:
+ - $ref: '#/components/schemas/Standaardprijs-sleutels'
+ description: Verwijzing naar een standaard (eenheids- of taak-) prijs die past bij de bestedingssoort, of die geldt voor de onderhoudstaak als geheel.
+ Standaardprijs-sleutels:
type: object
properties:
id:
@@ -3202,7 +3372,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
defecten:
description: De defecten die via zijn gemeld en gekoppeld aan het onderhoudsverzoek.
type: array
@@ -3228,19 +3398,19 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
verrekeningen:
description: De verrekeningen van het onderhoudsverzoek met de melder
type: array
items:
- $ref: '#/components/schemas/Onderhoudsverzoekverrekening'
+ $ref: '#/components/schemas/Onderhoudsverzoekverrekening-sleutels'
voorkeurAfspraken:
type: array
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
- Onderhoudsverzoek-sleutels:
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
+ Onderhoudsverzoekverrekening-sleutels:
type: object
properties:
id:
@@ -3294,57 +3464,6 @@ components:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: Verwijzing naar de eventuele onderhoudsorder waarvoor de (deel)verrekening.
- Onderhoudstaakvoorcalculatiebericht:
- allOf:
- - $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Onderhoudstaakvoorcalculatie:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bestedingsoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort besteding voor de voorcalculatie. Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
- omschrijving:
- type: string
- format: any
- description: De omschrijving van de voorcalculatie.
- aantal:
- type: number
- format: float
- description: Het verwachte aantal te besteden middelen of tijd (uitgedrukt in de meeteenheid van de voorcalculatie).
- bedrag:
- type: number
- format: float
- description: Een indicatie van de kosten van de verwachte bestedingen.
- meeteenheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De meeteenheid waarin de voorcalculatie wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
- onderhoudstaak:
- allOf:
- - $ref: '#/components/schemas/Onderhoudstaak-sleutels'
- description: De onderhoudstaak behorende bij de voorcalculatie.
- standaardprijs:
- allOf:
- - $ref: '#/components/schemas/Standaardprijs'
- description: Verwijzing naar een standaard (eenheids- of taak-) prijs die past bij de bestedingssoort, of die geldt voor de onderhoudstaak als geheel.
Standaardprijsbericht:
allOf:
- $ref: '#/components/schemas/Standaardprijs'
@@ -3389,25 +3508,6 @@ components:
type: array
items:
$ref: '#/components/schemas/Onderhoudstaakvoorcalculatie-sleutels'
- Onderhoudstaakvoorcalculatie-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Organisatie.yaml b/Informatiedomeinen/Organisatie.yaml
index d6c3534..0fbd58f 100644
--- a/Informatiedomeinen/Organisatie.yaml
+++ b/Informatiedomeinen/Organisatie.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://organisatie.vera.io:{port}/{basePath}
description: Productieserver
@@ -35,7 +35,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -51,7 +51,7 @@ paths:
get:
tags:
- 'Medewerkers'
- description: Ophalen van Medewerkers
+ summary: Ophalen van Medewerkers
operationId: listMedewerkers
parameters:
- name: params
@@ -101,7 +101,7 @@ paths:
post:
tags:
- 'Medewerkers'
- description: Voegt een nieuw(e) Medewerker toe.
+ summary: Voegt een nieuw(e) Medewerker toe.
operationId: createMedewerker
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -141,7 +141,7 @@ paths:
put:
tags:
- 'Medewerkers'
- description: |
+ summary: |
Vervangen van een Medewerker op basis van overeenkomstige sleutelvelden.
operationId: replaceMedewerker
parameters:
@@ -176,7 +176,7 @@ paths:
patch:
tags:
- 'Medewerkers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Medewerker. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateMedewerker
@@ -213,7 +213,7 @@ paths:
get:
tags:
- 'Medewerkers'
- description: Retourneert een Medewerker met de gegeven identifier
+ summary: Retourneert een Medewerker met de gegeven identifier
operationId: readMedewerkerById
parameters:
- name: id
@@ -250,7 +250,7 @@ paths:
put:
tags:
- 'Medewerkers'
- description: Vervangen van een Medewerker
+ summary: Vervangen van een Medewerker
operationId: replaceMedewerkerById
parameters:
- name: 'id'
@@ -288,7 +288,7 @@ paths:
patch:
tags:
- 'Medewerkers'
- description: Wijzigen van een Medewerker
+ summary: Wijzigen van een Medewerker
operationId: updateMedewerkerById
parameters:
- name: 'id'
@@ -327,7 +327,7 @@ paths:
get:
tags:
- 'Medewerkerrollen'
- description: Ophalen van Medewerkerrollen
+ summary: Ophalen van Medewerkerrollen
operationId: listMedewerkerrollen
parameters:
- name: params
@@ -377,7 +377,7 @@ paths:
post:
tags:
- 'Medewerkerrollen'
- description: Voegt een nieuw(e) Medewerkerrol toe.
+ summary: Voegt een nieuw(e) Medewerkerrol toe.
operationId: createMedewerkerrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -417,7 +417,7 @@ paths:
put:
tags:
- 'Medewerkerrollen'
- description: |
+ summary: |
Vervangen van een Medewerkerrol op basis van overeenkomstige sleutelvelden.
operationId: replaceMedewerkerrol
parameters:
@@ -452,7 +452,7 @@ paths:
patch:
tags:
- 'Medewerkerrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Medewerkerrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateMedewerkerrol
@@ -489,7 +489,7 @@ paths:
get:
tags:
- 'Medewerkerrollen'
- description: Retourneert een Medewerkerrol met de gegeven identifier
+ summary: Retourneert een Medewerkerrol met de gegeven identifier
operationId: readMedewerkerrolById
parameters:
- name: id
@@ -526,7 +526,7 @@ paths:
put:
tags:
- 'Medewerkerrollen'
- description: Vervangen van een Medewerkerrol
+ summary: Vervangen van een Medewerkerrol
operationId: replaceMedewerkerrolById
parameters:
- name: 'id'
@@ -564,7 +564,7 @@ paths:
patch:
tags:
- 'Medewerkerrollen'
- description: Wijzigen van een Medewerkerrol
+ summary: Wijzigen van een Medewerkerrol
operationId: updateMedewerkerrolById
parameters:
- name: 'id'
@@ -603,7 +603,7 @@ paths:
get:
tags:
- 'Organisaties'
- description: Ophalen van Organisaties
+ summary: Ophalen van Organisaties
operationId: listOrganisaties
parameters:
- name: params
@@ -653,7 +653,7 @@ paths:
post:
tags:
- 'Organisaties'
- description: Voegt een nieuw(e) Organisatie toe.
+ summary: Voegt een nieuw(e) Organisatie toe.
operationId: createOrganisatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -693,7 +693,7 @@ paths:
put:
tags:
- 'Organisaties'
- description: |
+ summary: |
Vervangen van een Organisatie op basis van overeenkomstige sleutelvelden.
operationId: replaceOrganisatie
parameters:
@@ -728,7 +728,7 @@ paths:
patch:
tags:
- 'Organisaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Organisatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOrganisatie
@@ -765,7 +765,7 @@ paths:
get:
tags:
- 'Organisaties'
- description: Retourneert een Organisatie met de gegeven identifier
+ summary: Retourneert een Organisatie met de gegeven identifier
operationId: readOrganisatieById
parameters:
- name: id
@@ -802,7 +802,7 @@ paths:
put:
tags:
- 'Organisaties'
- description: Vervangen van een Organisatie
+ summary: Vervangen van een Organisatie
operationId: replaceOrganisatieById
parameters:
- name: 'id'
@@ -840,7 +840,7 @@ paths:
patch:
tags:
- 'Organisaties'
- description: Wijzigen van een Organisatie
+ summary: Wijzigen van een Organisatie
operationId: updateOrganisatieById
parameters:
- name: 'id'
@@ -879,7 +879,7 @@ paths:
get:
tags:
- 'OrganisatorischeEenheden'
- description: Ophalen van OrganisatorischeEenheden
+ summary: Ophalen van OrganisatorischeEenheden
operationId: listOrganisatorischeEenheden
parameters:
- name: params
@@ -929,7 +929,7 @@ paths:
post:
tags:
- 'OrganisatorischeEenheden'
- description: Voegt een nieuw(e) OrganisatorischeEenheid toe.
+ summary: Voegt een nieuw(e) OrganisatorischeEenheid toe.
operationId: createOrganisatorischeEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -969,7 +969,7 @@ paths:
put:
tags:
- 'OrganisatorischeEenheden'
- description: |
+ summary: |
Vervangen van een OrganisatorischeEenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceOrganisatorischeEenheid
parameters:
@@ -1004,7 +1004,7 @@ paths:
patch:
tags:
- 'OrganisatorischeEenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een OrganisatorischeEenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOrganisatorischeEenheid
@@ -1041,7 +1041,7 @@ paths:
get:
tags:
- 'OrganisatorischeEenheden'
- description: Retourneert een OrganisatorischeEenheid met de gegeven identifier
+ summary: Retourneert een OrganisatorischeEenheid met de gegeven identifier
operationId: readOrganisatorischeEenheidById
parameters:
- name: id
@@ -1078,7 +1078,7 @@ paths:
put:
tags:
- 'OrganisatorischeEenheden'
- description: Vervangen van een OrganisatorischeEenheid
+ summary: Vervangen van een OrganisatorischeEenheid
operationId: replaceOrganisatorischeEenheidById
parameters:
- name: 'id'
@@ -1116,7 +1116,7 @@ paths:
patch:
tags:
- 'OrganisatorischeEenheden'
- description: Wijzigen van een OrganisatorischeEenheid
+ summary: Wijzigen van een OrganisatorischeEenheid
operationId: updateOrganisatorischeEenheidById
parameters:
- name: 'id'
@@ -1155,7 +1155,7 @@ paths:
get:
tags:
- 'PersoneleFuncties'
- description: Ophalen van PersoneleFuncties
+ summary: Ophalen van PersoneleFuncties
operationId: listPersoneleFuncties
parameters:
- name: params
@@ -1205,7 +1205,7 @@ paths:
post:
tags:
- 'PersoneleFuncties'
- description: Voegt een nieuw(e) PersoneleFunctie toe.
+ summary: Voegt een nieuw(e) PersoneleFunctie toe.
operationId: createPersoneleFunctie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1245,7 +1245,7 @@ paths:
put:
tags:
- 'PersoneleFuncties'
- description: |
+ summary: |
Vervangen van een PersoneleFunctie op basis van overeenkomstige sleutelvelden.
operationId: replacePersoneleFunctie
parameters:
@@ -1280,7 +1280,7 @@ paths:
patch:
tags:
- 'PersoneleFuncties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een PersoneleFunctie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePersoneleFunctie
@@ -1317,7 +1317,7 @@ paths:
get:
tags:
- 'PersoneleFuncties'
- description: Retourneert een PersoneleFunctie met de gegeven identifier
+ summary: Retourneert een PersoneleFunctie met de gegeven identifier
operationId: readPersoneleFunctieById
parameters:
- name: id
@@ -1354,7 +1354,7 @@ paths:
put:
tags:
- 'PersoneleFuncties'
- description: Vervangen van een PersoneleFunctie
+ summary: Vervangen van een PersoneleFunctie
operationId: replacePersoneleFunctieById
parameters:
- name: 'id'
@@ -1392,7 +1392,7 @@ paths:
patch:
tags:
- 'PersoneleFuncties'
- description: Wijzigen van een PersoneleFunctie
+ summary: Wijzigen van een PersoneleFunctie
operationId: updatePersoneleFunctieById
parameters:
- name: 'id'
@@ -1464,10 +1464,26 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Organisatie.All.Read: alleen lezen van alle resources
+ Organisatie.All.ReadWrite: lezen en schrijven van alle resources
+ Organisatie.Medewerkers.Read: alleen lezen van Medewerkers
+ Organisatie.Medewerkers.ReadWrite: lezen en schrijven van Medewerkers
+ Organisatie.Medewerkerrollen.Read: alleen lezen van Medewerkerrollen
+ Organisatie.Medewerkerrollen.ReadWrite: lezen en schrijven van Medewerkerrollen
+ Organisatie.Organisaties.Read: alleen lezen van Organisaties
+ Organisatie.Organisaties.ReadWrite: lezen en schrijven van Organisaties
+ Organisatie.OrganisatorischeEenheden.Read: alleen lezen van OrganisatorischeEenheden
+ Organisatie.OrganisatorischeEenheden.ReadWrite: lezen en schrijven van OrganisatorischeEenheden
+ Organisatie.PersoneleFuncties.Read: alleen lezen van PersoneleFuncties
+ Organisatie.PersoneleFuncties.ReadWrite: lezen en schrijven van PersoneleFuncties
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Organisatie.All.Read: alleen lezen van alle resources
Organisatie.All.ReadWrite: lezen en schrijven van alle resources
@@ -1532,25 +1548,25 @@ components:
description: De rollen van de medewerker.
type: array
items:
- $ref: '#/components/schemas/PersoneleFunctie'
+ $ref: '#/components/schemas/PersoneleFunctie-sleutels'
organisatie:
allOf:
- - $ref: '#/components/schemas/Organisatie'
+ - $ref: '#/components/schemas/Organisatie-sleutels'
description: De organisatie waarvoor de medewerker werkt.
organisatorischeEenheden:
description: De organisatorische eenheid waarvoor de medewerker werzaamheden uitvoert.
type: array
items:
- $ref: '#/components/schemas/OrganisatorischeEenheid'
+ $ref: '#/components/schemas/OrganisatorischeEenheid-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
rollen:
description: De rollen van de medewerker.
type: array
items:
- $ref: '#/components/schemas/Medewerkerrol'
+ $ref: '#/components/schemas/Medewerkerrol-sleutels'
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -1577,7 +1593,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -1589,7 +1605,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -1625,11 +1641,7 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- PersoneleFunctiebericht:
- allOf:
- - $ref: '#/components/schemas/PersoneleFunctie'
- - $ref: '#/components/schemas/Bericht-basis'
- PersoneleFunctie:
+ PersoneleFunctie-sleutels:
type: object
properties:
id:
@@ -1648,43 +1660,106 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- naam:
+ Organisatie-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De naam van de functie.
- omschrijving:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: De beschrijving van de functie zoals in een FUBE is vastgelegd.
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ OrganisatorischeEenheid-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Medewerkerrol-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Medewerkerrolbericht:
+ allOf:
+ - $ref: '#/components/schemas/Medewerkerrol'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Medewerkerrol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort medewerker rol. Bijv. BHV-er, Vertrouwenspersoon, Scrummaster etc. Referentiedatasoort MEDEWERKERROLSOORT.
begindatum:
type: string
format: date
- description: De begindatum van de functie.
+ description: De begindatum van de rol.
einddatum:
type: string
format: date
- description: De einddatum van de functie.
- medewerkers:
- description: sleutels
- type: array
- items:
- $ref: '#/components/schemas/Medewerker-sleutels'
- organisatie:
+ description: De einddatum van de rol.
+ medewerker:
allOf:
- - $ref: '#/components/schemas/Organisatie'
- description: De organisatie waarbinnen de functie wordt uitgevoerd.
- salarisschaalBegin:
- type: number
- format: float
- description: het start salaris van de schaal bij aanvang contract.
- salarisschaalEind:
- type: number
- format: float
- description: het maximale salaris van de schaal bij aanvang contract.
- schaal:
- type: string
- format: any
- description: De salarisschaal waar de functie bij aanvang is ingeschaald.
+ - $ref: '#/components/schemas/Medewerker-sleutels'
+ description: De medewerker met deze rol.
Medewerker-sleutels:
type: object
properties:
@@ -1706,8 +1781,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort medewerker. Bijv. oproepkracht, inhuur, stagair etc.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort medewerker. Bijv. oproepkracht, inhuur, stagair etc. Referentiedatasoort MEDEWERKERSOORT.
Organisatiebericht:
allOf:
- $ref: '#/components/schemas/Organisatie'
@@ -1747,11 +1822,11 @@ components:
description: De organisatorische eenhedenvan de organisatie.
type: array
items:
- $ref: '#/components/schemas/OrganisatorischeEenheid'
+ $ref: '#/components/schemas/OrganisatorischeEenheid-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
OrganisatorischeEenheidbericht:
allOf:
- $ref: '#/components/schemas/OrganisatorischeEenheid'
@@ -1779,7 +1854,7 @@ components:
type: string
format: any
description: De naam van de organisatorische eenheid.
- bovenliggendeOrganisatorischeEenheid:
+ bovenliggendeOrganisatorischeEenheid-sleutels:
allOf:
- $ref: '#/components/schemas/OrganisatorischeEenheid-sleutels'
description: De organisatorische eenheid waarvan de organisatorische eenheid deel uitmaakt.
@@ -1800,26 +1875,11 @@ components:
allOf:
- $ref: '#/components/schemas/Organisatie-sleutels'
description: De organisatie waarvan de organisatorische eenheid deel uitmaakt.
- OrganisatorischeEenheid-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Organisatie-sleutels:
+ PersoneleFunctiebericht:
+ allOf:
+ - $ref: '#/components/schemas/PersoneleFunctie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ PersoneleFunctie:
type: object
properties:
id:
@@ -1838,49 +1898,43 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
- Medewerkerrolbericht:
- allOf:
- - $ref: '#/components/schemas/Medewerkerrol'
- - $ref: '#/components/schemas/Bericht-basis'
- Medewerkerrol:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ naam:
type: string
format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ description: De naam van de functie.
+ omschrijving:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort medewerker rol. Bijv. BHV-er, Vertrouwenspersoon, Scrummaster etc. Referentiedatasoort MEDEWERKERROLSOORT.
+ description: De beschrijving van de functie zoals in een FUBE is vastgelegd.
begindatum:
type: string
format: date
- description: De begindatum van de rol.
+ description: De begindatum van de functie.
einddatum:
type: string
format: date
- description: De einddatum van de rol.
- medewerker:
+ description: De einddatum van de functie.
+ medewerkers:
+ description: De medewerkers met deze functie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Medewerker-sleutels'
+ organisatie:
allOf:
- - $ref: '#/components/schemas/Medewerker-sleutels'
- description: De medewerker met deze rol.
+ - $ref: '#/components/schemas/Organisatie-sleutels'
+ description: De organisatie waarbinnen de functie wordt uitgevoerd.
+ salarisschaalBegin:
+ type: number
+ format: float
+ description: het start salaris van de schaal bij aanvang contract.
+ salarisschaalEind:
+ type: number
+ format: float
+ description: het maximale salaris van de schaal bij aanvang contract.
+ schaal:
+ type: string
+ format: any
+ description: De salarisschaal waar de functie bij aanvang is ingeschaald.
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Overeenkomsten.yaml b/Informatiedomeinen/Overeenkomsten.yaml
index a97af22..ecd4ca3 100644
--- a/Informatiedomeinen/Overeenkomsten.yaml
+++ b/Informatiedomeinen/Overeenkomsten.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://overeenkomsten.vera.io:{port}/{basePath}
description: Productieserver
@@ -55,7 +55,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -71,7 +71,7 @@ paths:
get:
tags:
- 'Arbeidsovereenkomsten'
- description: Ophalen van Arbeidsovereenkomsten
+ summary: Ophalen van Arbeidsovereenkomsten
operationId: listArbeidsovereenkomsten
parameters:
- name: params
@@ -121,7 +121,7 @@ paths:
post:
tags:
- 'Arbeidsovereenkomsten'
- description: Voegt een nieuw(e) Arbeidsovereenkomst toe.
+ summary: Voegt een nieuw(e) Arbeidsovereenkomst toe.
operationId: createArbeidsovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -161,7 +161,7 @@ paths:
put:
tags:
- 'Arbeidsovereenkomsten'
- description: |
+ summary: |
Vervangen van een Arbeidsovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceArbeidsovereenkomst
parameters:
@@ -196,7 +196,7 @@ paths:
patch:
tags:
- 'Arbeidsovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Arbeidsovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateArbeidsovereenkomst
@@ -233,7 +233,7 @@ paths:
get:
tags:
- 'Arbeidsovereenkomsten'
- description: Retourneert een Arbeidsovereenkomst met de gegeven identifier
+ summary: Retourneert een Arbeidsovereenkomst met de gegeven identifier
operationId: readArbeidsovereenkomstById
parameters:
- name: id
@@ -270,7 +270,7 @@ paths:
put:
tags:
- 'Arbeidsovereenkomsten'
- description: Vervangen van een Arbeidsovereenkomst
+ summary: Vervangen van een Arbeidsovereenkomst
operationId: replaceArbeidsovereenkomstById
parameters:
- name: 'id'
@@ -308,7 +308,7 @@ paths:
patch:
tags:
- 'Arbeidsovereenkomsten'
- description: Wijzigen van een Arbeidsovereenkomst
+ summary: Wijzigen van een Arbeidsovereenkomst
operationId: updateArbeidsovereenkomstById
parameters:
- name: 'id'
@@ -347,7 +347,7 @@ paths:
get:
tags:
- 'Huurgeschillen'
- description: Ophalen van Huurgeschillen
+ summary: Ophalen van Huurgeschillen
operationId: listHuurgeschillen
parameters:
- name: params
@@ -397,7 +397,7 @@ paths:
post:
tags:
- 'Huurgeschillen'
- description: Voegt een nieuw(e) Huurgeschil toe.
+ summary: Voegt een nieuw(e) Huurgeschil toe.
operationId: createHuurgeschil
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -437,7 +437,7 @@ paths:
put:
tags:
- 'Huurgeschillen'
- description: |
+ summary: |
Vervangen van een Huurgeschil op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurgeschil
parameters:
@@ -472,7 +472,7 @@ paths:
patch:
tags:
- 'Huurgeschillen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huurgeschil. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurgeschil
@@ -509,7 +509,7 @@ paths:
get:
tags:
- 'Huurgeschillen'
- description: Retourneert een Huurgeschil met de gegeven identifier
+ summary: Retourneert een Huurgeschil met de gegeven identifier
operationId: readHuurgeschilById
parameters:
- name: id
@@ -546,7 +546,7 @@ paths:
put:
tags:
- 'Huurgeschillen'
- description: Vervangen van een Huurgeschil
+ summary: Vervangen van een Huurgeschil
operationId: replaceHuurgeschilById
parameters:
- name: 'id'
@@ -584,7 +584,7 @@ paths:
patch:
tags:
- 'Huurgeschillen'
- description: Wijzigen van een Huurgeschil
+ summary: Wijzigen van een Huurgeschil
operationId: updateHuurgeschilById
parameters:
- name: 'id'
@@ -623,7 +623,7 @@ paths:
get:
tags:
- 'HuurgeschilActies'
- description: Ophalen van HuurgeschilActies
+ summary: Ophalen van HuurgeschilActies
operationId: listHuurgeschilActies
parameters:
- name: params
@@ -673,7 +673,7 @@ paths:
post:
tags:
- 'HuurgeschilActies'
- description: Voegt een nieuw(e) HuurgeschilActie toe.
+ summary: Voegt een nieuw(e) HuurgeschilActie toe.
operationId: createHuurgeschilActie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -713,7 +713,7 @@ paths:
put:
tags:
- 'HuurgeschilActies'
- description: |
+ summary: |
Vervangen van een HuurgeschilActie op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurgeschilActie
parameters:
@@ -748,7 +748,7 @@ paths:
patch:
tags:
- 'HuurgeschilActies'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een HuurgeschilActie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurgeschilActie
@@ -785,7 +785,7 @@ paths:
get:
tags:
- 'HuurgeschilActies'
- description: Retourneert een HuurgeschilActie met de gegeven identifier
+ summary: Retourneert een HuurgeschilActie met de gegeven identifier
operationId: readHuurgeschilActieById
parameters:
- name: id
@@ -822,7 +822,7 @@ paths:
put:
tags:
- 'HuurgeschilActies'
- description: Vervangen van een HuurgeschilActie
+ summary: Vervangen van een HuurgeschilActie
operationId: replaceHuurgeschilActieById
parameters:
- name: 'id'
@@ -860,7 +860,7 @@ paths:
patch:
tags:
- 'HuurgeschilActies'
- description: Wijzigen van een HuurgeschilActie
+ summary: Wijzigen van een HuurgeschilActie
operationId: updateHuurgeschilActieById
parameters:
- name: 'id'
@@ -899,7 +899,7 @@ paths:
get:
tags:
- 'HuurgeschilUitspraken'
- description: Ophalen van HuurgeschilUitspraken
+ summary: Ophalen van HuurgeschilUitspraken
operationId: listHuurgeschilUitspraken
parameters:
- name: params
@@ -949,7 +949,7 @@ paths:
post:
tags:
- 'HuurgeschilUitspraken'
- description: Voegt een nieuw(e) HuurgeschilUitspraak toe.
+ summary: Voegt een nieuw(e) HuurgeschilUitspraak toe.
operationId: createHuurgeschilUitspraak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -989,7 +989,7 @@ paths:
put:
tags:
- 'HuurgeschilUitspraken'
- description: |
+ summary: |
Vervangen van een HuurgeschilUitspraak op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurgeschilUitspraak
parameters:
@@ -1024,7 +1024,7 @@ paths:
patch:
tags:
- 'HuurgeschilUitspraken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een HuurgeschilUitspraak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurgeschilUitspraak
@@ -1061,7 +1061,7 @@ paths:
get:
tags:
- 'HuurgeschilUitspraken'
- description: Retourneert een HuurgeschilUitspraak met de gegeven identifier
+ summary: Retourneert een HuurgeschilUitspraak met de gegeven identifier
operationId: readHuurgeschilUitspraakById
parameters:
- name: id
@@ -1098,7 +1098,7 @@ paths:
put:
tags:
- 'HuurgeschilUitspraken'
- description: Vervangen van een HuurgeschilUitspraak
+ summary: Vervangen van een HuurgeschilUitspraak
operationId: replaceHuurgeschilUitspraakById
parameters:
- name: 'id'
@@ -1136,7 +1136,7 @@ paths:
patch:
tags:
- 'HuurgeschilUitspraken'
- description: Wijzigen van een HuurgeschilUitspraak
+ summary: Wijzigen van een HuurgeschilUitspraak
operationId: updateHuurgeschilUitspraakById
parameters:
- name: 'id'
@@ -1175,7 +1175,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Ophalen van Huuropzeggingen
+ summary: Ophalen van Huuropzeggingen
operationId: listHuuropzeggingen
parameters:
- name: params
@@ -1225,7 +1225,7 @@ paths:
post:
tags:
- 'Huuropzeggingen'
- description: Voegt een nieuw(e) Huuropzegging toe.
+ summary: Voegt een nieuw(e) Huuropzegging toe.
operationId: createHuuropzegging
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1265,7 +1265,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Vervangen van een Huuropzegging op basis van overeenkomstige sleutelvelden.
operationId: replaceHuuropzegging
parameters:
@@ -1300,7 +1300,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huuropzegging. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuuropzegging
@@ -1337,7 +1337,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Retourneert een Huuropzegging met de gegeven identifier
+ summary: Retourneert een Huuropzegging met de gegeven identifier
operationId: readHuuropzeggingById
parameters:
- name: id
@@ -1374,7 +1374,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: Vervangen van een Huuropzegging
+ summary: Vervangen van een Huuropzegging
operationId: replaceHuuropzeggingById
parameters:
- name: 'id'
@@ -1412,7 +1412,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: Wijzigen van een Huuropzegging
+ summary: Wijzigen van een Huuropzegging
operationId: updateHuuropzeggingById
parameters:
- name: 'id'
@@ -1451,7 +1451,7 @@ paths:
get:
tags:
- 'Huurovereenkomsten'
- description: Ophalen van Huurovereenkomsten
+ summary: Ophalen van Huurovereenkomsten
operationId: listHuurovereenkomsten
parameters:
- name: params
@@ -1501,7 +1501,7 @@ paths:
post:
tags:
- 'Huurovereenkomsten'
- description: Voegt een nieuw(e) Huurovereenkomst toe.
+ summary: Voegt een nieuw(e) Huurovereenkomst toe.
operationId: createHuurovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1541,7 +1541,7 @@ paths:
put:
tags:
- 'Huurovereenkomsten'
- description: |
+ summary: |
Vervangen van een Huurovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurovereenkomst
parameters:
@@ -1576,7 +1576,7 @@ paths:
patch:
tags:
- 'Huurovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huurovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurovereenkomst
@@ -1613,7 +1613,7 @@ paths:
get:
tags:
- 'Huurovereenkomsten'
- description: Retourneert een Huurovereenkomst met de gegeven identifier
+ summary: Retourneert een Huurovereenkomst met de gegeven identifier
operationId: readHuurovereenkomstById
parameters:
- name: id
@@ -1650,7 +1650,7 @@ paths:
put:
tags:
- 'Huurovereenkomsten'
- description: Vervangen van een Huurovereenkomst
+ summary: Vervangen van een Huurovereenkomst
operationId: replaceHuurovereenkomstById
parameters:
- name: 'id'
@@ -1688,7 +1688,7 @@ paths:
patch:
tags:
- 'Huurovereenkomsten'
- description: Wijzigen van een Huurovereenkomst
+ summary: Wijzigen van een Huurovereenkomst
operationId: updateHuurovereenkomstById
parameters:
- name: 'id'
@@ -1727,7 +1727,7 @@ paths:
get:
tags:
- 'Huurtoeslagen'
- description: Ophalen van Huurtoeslagen
+ summary: Ophalen van Huurtoeslagen
operationId: listHuurtoeslagen
parameters:
- name: params
@@ -1777,7 +1777,7 @@ paths:
post:
tags:
- 'Huurtoeslagen'
- description: Voegt een nieuw(e) Huurtoeslag toe.
+ summary: Voegt een nieuw(e) Huurtoeslag toe.
operationId: createHuurtoeslag
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1817,7 +1817,7 @@ paths:
put:
tags:
- 'Huurtoeslagen'
- description: |
+ summary: |
Vervangen van een Huurtoeslag op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurtoeslag
parameters:
@@ -1852,7 +1852,7 @@ paths:
patch:
tags:
- 'Huurtoeslagen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huurtoeslag. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurtoeslag
@@ -1889,7 +1889,7 @@ paths:
get:
tags:
- 'Huurtoeslagen'
- description: Retourneert een Huurtoeslag met de gegeven identifier
+ summary: Retourneert een Huurtoeslag met de gegeven identifier
operationId: readHuurtoeslagById
parameters:
- name: id
@@ -1926,7 +1926,7 @@ paths:
put:
tags:
- 'Huurtoeslagen'
- description: Vervangen van een Huurtoeslag
+ summary: Vervangen van een Huurtoeslag
operationId: replaceHuurtoeslagById
parameters:
- name: 'id'
@@ -1964,7 +1964,7 @@ paths:
patch:
tags:
- 'Huurtoeslagen'
- description: Wijzigen van een Huurtoeslag
+ summary: Wijzigen van een Huurtoeslag
operationId: updateHuurtoeslagById
parameters:
- name: 'id'
@@ -2003,7 +2003,7 @@ paths:
get:
tags:
- 'Inschrijvingen'
- description: Ophalen van Inschrijvingen
+ summary: Ophalen van Inschrijvingen
operationId: listInschrijvingen
parameters:
- name: params
@@ -2053,7 +2053,7 @@ paths:
post:
tags:
- 'Inschrijvingen'
- description: Voegt een nieuw(e) Inschrijving toe.
+ summary: Voegt een nieuw(e) Inschrijving toe.
operationId: createInschrijving
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2093,7 +2093,7 @@ paths:
put:
tags:
- 'Inschrijvingen'
- description: |
+ summary: |
Vervangen van een Inschrijving op basis van overeenkomstige sleutelvelden.
operationId: replaceInschrijving
parameters:
@@ -2128,7 +2128,7 @@ paths:
patch:
tags:
- 'Inschrijvingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inschrijving. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInschrijving
@@ -2165,7 +2165,7 @@ paths:
get:
tags:
- 'Inschrijvingen'
- description: Retourneert een Inschrijving met de gegeven identifier
+ summary: Retourneert een Inschrijving met de gegeven identifier
operationId: readInschrijvingById
parameters:
- name: id
@@ -2202,7 +2202,7 @@ paths:
put:
tags:
- 'Inschrijvingen'
- description: Vervangen van een Inschrijving
+ summary: Vervangen van een Inschrijving
operationId: replaceInschrijvingById
parameters:
- name: 'id'
@@ -2240,7 +2240,7 @@ paths:
patch:
tags:
- 'Inschrijvingen'
- description: Wijzigen van een Inschrijving
+ summary: Wijzigen van een Inschrijving
operationId: updateInschrijvingById
parameters:
- name: 'id'
@@ -2279,7 +2279,7 @@ paths:
get:
tags:
- 'Inspecties'
- description: Ophalen van Inspecties
+ summary: Ophalen van Inspecties
operationId: listInspecties
parameters:
- name: params
@@ -2329,7 +2329,7 @@ paths:
post:
tags:
- 'Inspecties'
- description: Voegt een nieuw(e) Inspectie toe.
+ summary: Voegt een nieuw(e) Inspectie toe.
operationId: createInspectie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2369,7 +2369,7 @@ paths:
put:
tags:
- 'Inspecties'
- description: |
+ summary: |
Vervangen van een Inspectie op basis van overeenkomstige sleutelvelden.
operationId: replaceInspectie
parameters:
@@ -2404,7 +2404,7 @@ paths:
patch:
tags:
- 'Inspecties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inspectie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInspectie
@@ -2441,7 +2441,7 @@ paths:
get:
tags:
- 'Inspecties'
- description: Retourneert een Inspectie met de gegeven identifier
+ summary: Retourneert een Inspectie met de gegeven identifier
operationId: readInspectieById
parameters:
- name: id
@@ -2478,7 +2478,7 @@ paths:
put:
tags:
- 'Inspecties'
- description: Vervangen van een Inspectie
+ summary: Vervangen van een Inspectie
operationId: replaceInspectieById
parameters:
- name: 'id'
@@ -2516,7 +2516,7 @@ paths:
patch:
tags:
- 'Inspecties'
- description: Wijzigen van een Inspectie
+ summary: Wijzigen van een Inspectie
operationId: updateInspectieById
parameters:
- name: 'id'
@@ -2555,7 +2555,7 @@ paths:
get:
tags:
- 'Koopovereenkomsten'
- description: Ophalen van Koopovereenkomsten
+ summary: Ophalen van Koopovereenkomsten
operationId: listKoopovereenkomsten
parameters:
- name: params
@@ -2605,7 +2605,7 @@ paths:
post:
tags:
- 'Koopovereenkomsten'
- description: Voegt een nieuw(e) Koopovereenkomst toe.
+ summary: Voegt een nieuw(e) Koopovereenkomst toe.
operationId: createKoopovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2645,7 +2645,7 @@ paths:
put:
tags:
- 'Koopovereenkomsten'
- description: |
+ summary: |
Vervangen van een Koopovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceKoopovereenkomst
parameters:
@@ -2680,7 +2680,7 @@ paths:
patch:
tags:
- 'Koopovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Koopovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKoopovereenkomst
@@ -2717,7 +2717,7 @@ paths:
get:
tags:
- 'Koopovereenkomsten'
- description: Retourneert een Koopovereenkomst met de gegeven identifier
+ summary: Retourneert een Koopovereenkomst met de gegeven identifier
operationId: readKoopovereenkomstById
parameters:
- name: id
@@ -2754,7 +2754,7 @@ paths:
put:
tags:
- 'Koopovereenkomsten'
- description: Vervangen van een Koopovereenkomst
+ summary: Vervangen van een Koopovereenkomst
operationId: replaceKoopovereenkomstById
parameters:
- name: 'id'
@@ -2792,7 +2792,7 @@ paths:
patch:
tags:
- 'Koopovereenkomsten'
- description: Wijzigen van een Koopovereenkomst
+ summary: Wijzigen van een Koopovereenkomst
operationId: updateKoopovereenkomstById
parameters:
- name: 'id'
@@ -2831,7 +2831,7 @@ paths:
get:
tags:
- 'Onderhoudsovereenkomsten'
- description: Ophalen van Onderhoudsovereenkomsten
+ summary: Ophalen van Onderhoudsovereenkomsten
operationId: listOnderhoudsovereenkomsten
parameters:
- name: params
@@ -2881,7 +2881,7 @@ paths:
post:
tags:
- 'Onderhoudsovereenkomsten'
- description: Voegt een nieuw(e) Onderhoudsovereenkomst toe.
+ summary: Voegt een nieuw(e) Onderhoudsovereenkomst toe.
operationId: createOnderhoudsovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2921,7 +2921,7 @@ paths:
put:
tags:
- 'Onderhoudsovereenkomsten'
- description: |
+ summary: |
Vervangen van een Onderhoudsovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsovereenkomst
parameters:
@@ -2956,7 +2956,7 @@ paths:
patch:
tags:
- 'Onderhoudsovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsovereenkomst
@@ -2993,7 +2993,7 @@ paths:
get:
tags:
- 'Onderhoudsovereenkomsten'
- description: Retourneert een Onderhoudsovereenkomst met de gegeven identifier
+ summary: Retourneert een Onderhoudsovereenkomst met de gegeven identifier
operationId: readOnderhoudsovereenkomstById
parameters:
- name: id
@@ -3030,7 +3030,7 @@ paths:
put:
tags:
- 'Onderhoudsovereenkomsten'
- description: Vervangen van een Onderhoudsovereenkomst
+ summary: Vervangen van een Onderhoudsovereenkomst
operationId: replaceOnderhoudsovereenkomstById
parameters:
- name: 'id'
@@ -3068,7 +3068,7 @@ paths:
patch:
tags:
- 'Onderhoudsovereenkomsten'
- description: Wijzigen van een Onderhoudsovereenkomst
+ summary: Wijzigen van een Onderhoudsovereenkomst
operationId: updateOnderhoudsovereenkomstById
parameters:
- name: 'id'
@@ -3107,7 +3107,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Ophalen van Overeenkomsten
+ summary: Ophalen van Overeenkomsten
operationId: listOvereenkomsten
parameters:
- name: params
@@ -3157,7 +3157,7 @@ paths:
post:
tags:
- 'Overeenkomsten'
- description: Voegt een nieuw(e) Overeenkomst toe.
+ summary: Voegt een nieuw(e) Overeenkomst toe.
operationId: createOvereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3197,7 +3197,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Vervangen van een Overeenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomst
parameters:
@@ -3232,7 +3232,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomst
@@ -3269,7 +3269,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Retourneert een Overeenkomst met de gegeven identifier
+ summary: Retourneert een Overeenkomst met de gegeven identifier
operationId: readOvereenkomstById
parameters:
- name: id
@@ -3306,7 +3306,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: Vervangen van een Overeenkomst
+ summary: Vervangen van een Overeenkomst
operationId: replaceOvereenkomstById
parameters:
- name: 'id'
@@ -3344,7 +3344,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: Wijzigen van een Overeenkomst
+ summary: Wijzigen van een Overeenkomst
operationId: updateOvereenkomstById
parameters:
- name: 'id'
@@ -3383,7 +3383,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Ophalen van Overeenkomstkoppelingen
+ summary: Ophalen van Overeenkomstkoppelingen
operationId: listOvereenkomstkoppelingen
parameters:
- name: params
@@ -3433,7 +3433,7 @@ paths:
post:
tags:
- 'Overeenkomstkoppelingen'
- description: Voegt een nieuw(e) Overeenkomstkoppeling toe.
+ summary: Voegt een nieuw(e) Overeenkomstkoppeling toe.
operationId: createOvereenkomstkoppeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3473,7 +3473,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Vervangen van een Overeenkomstkoppeling op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomstkoppeling
parameters:
@@ -3508,7 +3508,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomstkoppeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomstkoppeling
@@ -3545,7 +3545,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Retourneert een Overeenkomstkoppeling met de gegeven identifier
+ summary: Retourneert een Overeenkomstkoppeling met de gegeven identifier
operationId: readOvereenkomstkoppelingById
parameters:
- name: id
@@ -3582,7 +3582,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: Vervangen van een Overeenkomstkoppeling
+ summary: Vervangen van een Overeenkomstkoppeling
operationId: replaceOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -3620,7 +3620,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: Wijzigen van een Overeenkomstkoppeling
+ summary: Wijzigen van een Overeenkomstkoppeling
operationId: updateOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -3659,7 +3659,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Ophalen van Prijscomponenten
+ summary: Ophalen van Prijscomponenten
operationId: listPrijscomponenten
parameters:
- name: params
@@ -3709,7 +3709,7 @@ paths:
post:
tags:
- 'Prijscomponenten'
- description: Voegt een nieuw(e) Prijscomponent toe.
+ summary: Voegt een nieuw(e) Prijscomponent toe.
operationId: createPrijscomponent
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3749,7 +3749,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Vervangen van een Prijscomponent op basis van overeenkomstige sleutelvelden.
operationId: replacePrijscomponent
parameters:
@@ -3784,7 +3784,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Prijscomponent. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePrijscomponent
@@ -3821,7 +3821,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Retourneert een Prijscomponent met de gegeven identifier
+ summary: Retourneert een Prijscomponent met de gegeven identifier
operationId: readPrijscomponentById
parameters:
- name: id
@@ -3858,7 +3858,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: Vervangen van een Prijscomponent
+ summary: Vervangen van een Prijscomponent
operationId: replacePrijscomponentById
parameters:
- name: 'id'
@@ -3896,7 +3896,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: Wijzigen van een Prijscomponent
+ summary: Wijzigen van een Prijscomponent
operationId: updatePrijscomponentById
parameters:
- name: 'id'
@@ -3935,7 +3935,7 @@ paths:
get:
tags:
- 'Serviceovereenkomsten'
- description: Ophalen van Serviceovereenkomsten
+ summary: Ophalen van Serviceovereenkomsten
operationId: listServiceovereenkomsten
parameters:
- name: params
@@ -3985,7 +3985,7 @@ paths:
post:
tags:
- 'Serviceovereenkomsten'
- description: Voegt een nieuw(e) Serviceovereenkomst toe.
+ summary: Voegt een nieuw(e) Serviceovereenkomst toe.
operationId: createServiceovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4025,7 +4025,7 @@ paths:
put:
tags:
- 'Serviceovereenkomsten'
- description: |
+ summary: |
Vervangen van een Serviceovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceServiceovereenkomst
parameters:
@@ -4060,7 +4060,7 @@ paths:
patch:
tags:
- 'Serviceovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Serviceovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateServiceovereenkomst
@@ -4097,7 +4097,7 @@ paths:
get:
tags:
- 'Serviceovereenkomsten'
- description: Retourneert een Serviceovereenkomst met de gegeven identifier
+ summary: Retourneert een Serviceovereenkomst met de gegeven identifier
operationId: readServiceovereenkomstById
parameters:
- name: id
@@ -4134,7 +4134,7 @@ paths:
put:
tags:
- 'Serviceovereenkomsten'
- description: Vervangen van een Serviceovereenkomst
+ summary: Vervangen van een Serviceovereenkomst
operationId: replaceServiceovereenkomstById
parameters:
- name: 'id'
@@ -4172,7 +4172,7 @@ paths:
patch:
tags:
- 'Serviceovereenkomsten'
- description: Wijzigen van een Serviceovereenkomst
+ summary: Wijzigen van een Serviceovereenkomst
operationId: updateServiceovereenkomstById
parameters:
- name: 'id'
@@ -4244,10 +4244,46 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Overeenkomsten.All.Read: alleen lezen van alle resources
+ Overeenkomsten.All.ReadWrite: lezen en schrijven van alle resources
+ Overeenkomsten.Arbeidsovereenkomsten.Read: alleen lezen van Arbeidsovereenkomsten
+ Overeenkomsten.Arbeidsovereenkomsten.ReadWrite: lezen en schrijven van Arbeidsovereenkomsten
+ Overeenkomsten.Huurgeschillen.Read: alleen lezen van Huurgeschillen
+ Overeenkomsten.Huurgeschillen.ReadWrite: lezen en schrijven van Huurgeschillen
+ Overeenkomsten.HuurgeschilActies.Read: alleen lezen van HuurgeschilActies
+ Overeenkomsten.HuurgeschilActies.ReadWrite: lezen en schrijven van HuurgeschilActies
+ Overeenkomsten.HuurgeschilUitspraken.Read: alleen lezen van HuurgeschilUitspraken
+ Overeenkomsten.HuurgeschilUitspraken.ReadWrite: lezen en schrijven van HuurgeschilUitspraken
+ Overeenkomsten.Huuropzeggingen.Read: alleen lezen van Huuropzeggingen
+ Overeenkomsten.Huuropzeggingen.ReadWrite: lezen en schrijven van Huuropzeggingen
+ Overeenkomsten.Huurovereenkomsten.Read: alleen lezen van Huurovereenkomsten
+ Overeenkomsten.Huurovereenkomsten.ReadWrite: lezen en schrijven van Huurovereenkomsten
+ Overeenkomsten.Huurtoeslagen.Read: alleen lezen van Huurtoeslagen
+ Overeenkomsten.Huurtoeslagen.ReadWrite: lezen en schrijven van Huurtoeslagen
+ Overeenkomsten.Inschrijvingen.Read: alleen lezen van Inschrijvingen
+ Overeenkomsten.Inschrijvingen.ReadWrite: lezen en schrijven van Inschrijvingen
+ Overeenkomsten.Inspecties.Read: alleen lezen van Inspecties
+ Overeenkomsten.Inspecties.ReadWrite: lezen en schrijven van Inspecties
+ Overeenkomsten.Koopovereenkomsten.Read: alleen lezen van Koopovereenkomsten
+ Overeenkomsten.Koopovereenkomsten.ReadWrite: lezen en schrijven van Koopovereenkomsten
+ Overeenkomsten.Onderhoudsovereenkomsten.Read: alleen lezen van Onderhoudsovereenkomsten
+ Overeenkomsten.Onderhoudsovereenkomsten.ReadWrite: lezen en schrijven van Onderhoudsovereenkomsten
+ Overeenkomsten.Overeenkomsten.Read: alleen lezen van Overeenkomsten
+ Overeenkomsten.Overeenkomsten.ReadWrite: lezen en schrijven van Overeenkomsten
+ Overeenkomsten.Overeenkomstkoppelingen.Read: alleen lezen van Overeenkomstkoppelingen
+ Overeenkomsten.Overeenkomstkoppelingen.ReadWrite: lezen en schrijven van Overeenkomstkoppelingen
+ Overeenkomsten.Prijscomponenten.Read: alleen lezen van Prijscomponenten
+ Overeenkomsten.Prijscomponenten.ReadWrite: lezen en schrijven van Prijscomponenten
+ Overeenkomsten.Serviceovereenkomsten.Read: alleen lezen van Serviceovereenkomsten
+ Overeenkomsten.Serviceovereenkomsten.ReadWrite: lezen en schrijven van Serviceovereenkomsten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Overeenkomsten.All.Read: alleen lezen van alle resources
Overeenkomsten.All.ReadWrite: lezen en schrijven van alle resources
@@ -4309,15 +4345,15 @@ components:
functie:
type: string
format: uri
- description: Referentie naar PersoneleFunctie in informatiedomein Organisatie
+ description: Referentie naar PersoneleFunctie-sleutels in informatiedomein Organisatie
medewerker:
type: string
format: uri
- description: Referentie naar Medewerker in informatiedomein Organisatie
+ description: Referentie naar Medewerker-sleutels in informatiedomein Organisatie
organisatorischeEenheid:
type: string
format: uri
- description: Referentie naar OrganisatorischeEenheid in informatiedomein Organisatie
+ description: Referentie naar OrganisatorischeEenheid-sleutels in informatiedomein Organisatie
parttimePercentage:
type: number
format: float
@@ -4377,7 +4413,7 @@ components:
description: De huurgeschil acties uitgevoerd door de medewerker behorende bij het huurgeschil.
type: array
items:
- $ref: '#/components/schemas/HuurgeschilActie'
+ $ref: '#/components/schemas/HuurgeschilActie-sleutels'
bedrag:
type: number
format: float
@@ -4387,7 +4423,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
hoorzittingdatum:
type: string
format: date
@@ -4398,7 +4434,7 @@ components:
description: Het nummer van het dossier van het huurgeschil dat naar de huurcommissie is gegaan.
huurovereenkomst:
allOf:
- - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
description: De huurovereenkomst waardoor het geschil is ontstaan.
matigen:
type: boolean
@@ -4412,7 +4448,7 @@ components:
description: De uitspraken die zijn gedaan door de huurcommissie.
type: array
items:
- $ref: '#/components/schemas/HuurgeschilUitspraak'
+ $ref: '#/components/schemas/HuurgeschilUitspraak-sleutels'
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4439,7 +4475,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -4451,7 +4487,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -4487,6 +4523,67 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ HuurgeschilActie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Overeenkomst-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
+ HuurgeschilUitspraak-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
HuurgeschilActiebericht:
allOf:
- $ref: '#/components/schemas/HuurgeschilActie'
@@ -4525,7 +4622,7 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Huurgeschil-sleutels:
type: object
properties:
@@ -4545,7 +4642,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Overeenkomst-basis:
+ HuurgeschilUitspraakbericht:
+ allOf:
+ - $ref: '#/components/schemas/HuurgeschilUitspraak'
+ - $ref: '#/components/schemas/Bericht-basis'
+ HuurgeschilUitspraak:
type: object
properties:
id:
@@ -4567,69 +4668,58 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het detail soort overeenkomst. Bijvoorbeeld BOG (Bedrijfs Onroerend Goed). Referentiedatasoort OVEREENKOMSTDETAILSOORT.
- bovenliggendeOvereenkomst:
+ description: Het soort uitspraak die is gedaan door de huurcommissie. Referentiedatasoort HUURGESCHILUITSPRAAKSOORT.
+ datum:
+ type: string
+ format: date
+ description: De datum waarop de uitspraak heeft plaats gevonden.
+ bedrag:
+ type: number
+ format: float
+ description: Het huurbedrag in euro's dat is overeengekomen bij de uitspraak.
+ huurgeschil:
allOf:
- - $ref: '#/components/schemas/Overeenkomst-sleutels'
- description: De gerelateerde overeenkomst, bijvoorbeeld indien dit een betaalovereenkomst betreft voor een bovenliggende huurovereenkomst.
+ - $ref: '#/components/schemas/Huurgeschil-sleutels'
+ description: Verwijzing naar het huurgeschil waarvoor de uitspraak is gedaan.
+ Huuropzeggingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Huuropzegging'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Huuropzegging:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De status van een huurovereenkomst. Dit kan een waarde bevatten zoals: overeenkomst beëindigd en huurder is vertrokken, of overeenkomst is momenteel in gebruik. Referentiedatasoort OVEREENKOMSTSTATUS.'
+ description: De status van de huuropzegging. Bijv. Aangemaakt, Goedgekeurd, Geannuleerd, Afgewezen, In behandeling, Afgehandeld. Referentiedatasoort HUUROPZEGGINGSTATUS.
begindatum:
type: string
format: date
- description: De begindatum van de overeenkomst.
+ description: De datum waarop de Opzegging is gedaan.
einddatum:
type: string
format: date
- description: De einddatum van de overeenkomst.
- conceptVersturingsdatum:
- type: string
- format: date-time
- description: De datum waarop een concept overeenkomst is verstuurd.
- verstuurdatum:
- type: string
- format: date-time
- description: De datum waarop de overeenkomst is verstuurd.
- versturenStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van het versturen van de overeenkomst. Referentiedatasoort OVEREENKOMSTVERSTURENSTATUS.
- bewakingsstatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De bewakingsstatus bij de overeenkomst die wordt gebruikt in verband met incasso en prolongatie. Deze status is van toepassing als een debiteur niet aan zijn betalingsverplichtingen kan voldoen. Referentiedatasoort BEWAKINGSSTATUS.
- betaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- betaalwijze:
+ description: De begindatum waarop de opzegging is afgerond
+ opzegdatum:
type: string
- format: uri
- description: Referentie naar Betaalwijze in informatiedomein Financien
- betaalwijzen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Betaalwijze in informatiedomein Financien
- contactmomenten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- eenheden:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ format: date
+ description: De datum per wanneer de opzegging in gaat.
eindeDetailReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4638,284 +4728,37 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEREDEN.
- garanties:
+ huurovereenkomst:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
+ description: De opgezegde huurovereenkomst.
+ inspectieafspraken:
type: array
items:
type: string
format: uri
- description: Referenties naar Garantie in informatiedomein Vastgoed
- incassomoment:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het moment waarop de incasso wordt gedaan. OBSOLETE. Referentiedatasoort INCASSOMOMENT.
- deprecated: true
- incassowijze:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De wijze van incasso waarop de huurovereenkomst wordt betaald. OBSOLETE. Referentiedatasoort INCASSOWIJZE.
- deprecated: true
- onderhoudsverzoeken:
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
+ nieuweAdressen:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
- prijscomponenten:
- description: De prijscomponenten behorende bij de huurprijs, koopprijs of maandelijkse lasten van de overeenkomst.
- type: array
- items:
- $ref: '#/components/schemas/Prijscomponent'
- redenOntbinding:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENONTBINDING.
- deprecated: true
+ description: Referenties naar RelatieAdres-sleutels in informatiedomein Relaties
+ onderhoudsverzoek:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
redenOpzegging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENOPZEGGING.
- deprecated: true
- redenVernietiging:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden van de vernietiging van de overeenkomst. OBSOLETE. Referentiedatasoort REDENVERNIETIGING.
+ description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE Referentiedatasoort REDENOPZEGGING.
deprecated: true
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- versturen:
- type: boolean
- description: De aanduiding of een afschrift van de overeenkomst moet worden gestuurd naar de relatie
- volgnummer:
- type: string
- format: any
- description: Het volgnummer van de overeenkomst.
- Overeenkomst-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Overeenkomstbericht:
- allOf:
- - $ref: '#/components/schemas/Overeenkomst'
- - $ref: '#/components/schemas/Bericht-basis'
- Overeenkomst:
- oneOf:
- - $ref: '#/components/schemas/Arbeidsovereenkomst'
- - $ref: '#/components/schemas/Huurovereenkomst'
- - $ref: '#/components/schemas/Inschrijving'
- - $ref: '#/components/schemas/Koopovereenkomst'
- - $ref: '#/components/schemas/Onderhoudsovereenkomst'
- - $ref: '#/components/schemas/Serviceovereenkomst'
- Prijscomponentbericht:
- allOf:
- - $ref: '#/components/schemas/Prijscomponent'
- - $ref: '#/components/schemas/Bericht-basis'
- Prijscomponent:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De bedrijfsspecifieke naam van het prijscomponent
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan om welk soort prijscomponent het betreft. Bijvoorbeeld een component voor een eenheid, of een component voor een overeenkomst. Referentiedatasoort PRIJSCOMPONENTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan om welk detail soort prijscomponent het betreft. Bijvoorbeeld of het om service kosten gaat. Referentiedatasoort PRIJSCOMPONENTDETAILSOORT.
- subsidieSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan of het prijscomponent onderdeel kan zijn van een subsidieregeling. Vooralsnog alleen van toepassing op de wet op de huurtoeslag. Referentiedatasoort PRIJSCOMPONENTSUBSIDIESOORT.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van het prijscomponent. Dit is de datum waarop het prijscomponent van toepassing is.
- einddatum:
- type: string
- format: date-time
- description: De datum die aangeeft dat het prijscomponent niet meer van toepassing is. Er is dan een nieuwer prijscomponent van toepassing.
- bedrag:
- type: number
- format: float
- description: Het bedrag in euro's van het prijscomponent exclusief BTW.
- bedragInclusiefBtw:
- type: number
- format: float
- description: Het bedrag in euro's van het prijscomponent inclusief BTW.
- btw:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De BTW van het prijscomponent. Referentiedatasoort BTW.
- eenheid:
- type: string
- format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
- overeenkomst:
- allOf:
- - $ref: '#/components/schemas/Overeenkomst-sleutels'
- description: De overeenkomst waaraan het prijscomponent.
- wijzigingsreden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan wat de reden was voor het aanpassen van het prijscomponent. Referentiedatasoort PRIJSCOMPONENTWIJZIGINGSREDEN.
- HuurgeschilUitspraakbericht:
- allOf:
- - $ref: '#/components/schemas/HuurgeschilUitspraak'
- - $ref: '#/components/schemas/Bericht-basis'
- HuurgeschilUitspraak:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort uitspraak die is gedaan door de huurcommissie. Referentiedatasoort HUURGESCHILUITSPRAAKSOORT.
- datum:
- type: string
- format: date
- description: De datum waarop de uitspraak heeft plaats gevonden.
- bedrag:
- type: number
- format: float
- description: Het huurbedrag in euro's dat is overeengekomen bij de uitspraak.
- huurgeschil:
- allOf:
- - $ref: '#/components/schemas/Huurgeschil-sleutels'
- description: Verwijzing naar het huurgeschil waarvoor de uitspraak is gedaan.
- Huuropzeggingbericht:
- allOf:
- - $ref: '#/components/schemas/Huuropzegging'
- - $ref: '#/components/schemas/Bericht-basis'
- Huuropzegging:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de huuropzegging. Bijv. Aangemaakt, Goedgekeurd, Geannuleerd, Afgewezen, In behandeling, Afgehandeld. Referentiedatasoort HUUROPZEGGINGSTATUS.
- begindatum:
- type: string
- format: date
- description: De datum waarop de Opzegging is gedaan.
- einddatum:
- type: string
- format: date
- description: De begindatum waarop de opzegging is afgerond
- opzegdatum:
- type: string
- format: date
- description: De datum per wanneer de opzegging in gaat.
- eindeDetailReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEDETAILREDEN.
- eindeReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEREDEN.
- huurovereenkomst:
- allOf:
- - $ref: '#/components/schemas/Overeenkomst'
- description: De opgezegde huurovereenkomst.
- inspectieafspraken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
- nieuweAdressen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar RelatieAdres in informatiedomein Relaties
- onderhoudsverzoek:
- type: string
- format: uri
- description: Referentie naar Onderhoudsverzoek in informatiedomein Onderhoud
- redenOpzegging:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE Referentiedatasoort REDENOPZEGGING.
- deprecated: true
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Huurovereenkomstbericht:
allOf:
- $ref: '#/components/schemas/Huurovereenkomst'
@@ -4945,7 +4788,7 @@ components:
afwijkendeBetaler:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
afwijkendeBetalerIncassowijze:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4965,12 +4808,12 @@ components:
description: Verwijzing naar eventuele huurgeschillen van toepassing op de huurovereenkomst.
type: array
items:
- $ref: '#/components/schemas/Huurgeschil'
+ $ref: '#/components/schemas/Huurgeschil-sleutels'
huurtoeslagen:
description: De huurtoeslagen behorende bij de huurovereenkomst.
type: array
items:
- $ref: '#/components/schemas/Huurtoeslag'
+ $ref: '#/components/schemas/Huurtoeslag-sleutels'
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5008,6 +4851,25 @@ components:
type: number
format: float
description: De rente van de waarborgsom op de overeenkomst. Deze waarde wordt in Euro's aangegeven en is cumulatief over de volledige looptijd van de huurovereenkomst.
+ Huurtoeslag-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Huurtoeslagbericht:
allOf:
- $ref: '#/components/schemas/Huurtoeslag'
@@ -5033,7 +4895,7 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
huurovereenkomst:
allOf:
- - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
description: Het huurovereenkomst behorende bij de huurtoeslag.
maand:
type: integer
@@ -5109,17 +4971,17 @@ components:
afspraak:
type: string
format: uri
- description: Referentie naar Afspraak in informatiedomein Relaties
+ description: Referentie naar Afspraak-sleutels in informatiedomein Relaties
overeenkomst:
allOf:
- - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
description: De overeenkomst die geïnspecteerd wordt.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Koopovereenkomstbericht:
allOf:
- $ref: '#/components/schemas/Koopovereenkomst'
@@ -5172,26 +5034,205 @@ components:
bouwkundigElement:
type: string
format: uri
- description: Referentie naar BouwkundigElement in informatiedomein Vastgoed
+ description: Referentie naar BouwkundigElement-sleutels in informatiedomein Vastgoed
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObject:
type: string
format: uri
- description: Referentie naar CollectiefObject in informatiedomein Vastgoed
+ description: Referentie naar CollectiefObject-sleutels in informatiedomein Vastgoed
orders:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsorder in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsorder-sleutels in informatiedomein Onderhoud
specialismen:
description: Het specialismen die de opdrachtnemer kan uitvoeren. Voorbeelden zijn Timmerman, Loodgieter, etc. Referentiedatasoort ONDERHOUDSPECIALISME.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ Overeenkomst-basis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het detail soort overeenkomst. Bijvoorbeeld BOG (Bedrijfs Onroerend Goed). Referentiedatasoort OVEREENKOMSTDETAILSOORT.
+ bovenliggendeOvereenkomst:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
+ description: De gerelateerde overeenkomst, bijvoorbeeld indien dit een betaalovereenkomst betreft voor een bovenliggende huurovereenkomst.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De status van een huurovereenkomst. Dit kan een waarde bevatten zoals: overeenkomst beëindigd en huurder is vertrokken, of overeenkomst is momenteel in gebruik. Referentiedatasoort OVEREENKOMSTSTATUS.'
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de overeenkomst.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de overeenkomst.
+ conceptVersturingsdatum:
+ type: string
+ format: date-time
+ description: De datum waarop een concept overeenkomst is verstuurd.
+ verstuurdatum:
+ type: string
+ format: date-time
+ description: De datum waarop de overeenkomst is verstuurd.
+ versturenStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het versturen van de overeenkomst. Referentiedatasoort OVEREENKOMSTVERSTURENSTATUS.
+ bewakingsstatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De bewakingsstatus bij de overeenkomst die wordt gebruikt in verband met incasso en prolongatie. Deze status is van toepassing als een debiteur niet aan zijn betalingsverplichtingen kan voldoen. Referentiedatasoort BEWAKINGSSTATUS.
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ betaalwijze:
+ type: string
+ format: uri
+ description: Referentie naar Betaalwijze-sleutels in informatiedomein Financien
+ betaalwijzen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Betaalwijze-sleutels in informatiedomein Financien
+ contactmomenten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ eenheden:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ eindeDetailReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEDETAILREDEN.
+ eindeReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEREDEN.
+ garanties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Garantie-sleutels in informatiedomein Vastgoed
+ incassomoment:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het moment waarop de incasso wordt gedaan. OBSOLETE. Referentiedatasoort INCASSOMOMENT.
+ deprecated: true
+ incassowijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De wijze van incasso waarop de huurovereenkomst wordt betaald. OBSOLETE. Referentiedatasoort INCASSOWIJZE.
+ deprecated: true
+ onderhoudsverzoeken:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ prijscomponenten:
+ description: De prijscomponenten behorende bij de huurprijs, koopprijs of maandelijkse lasten van de overeenkomst.
+ type: array
+ items:
+ $ref: '#/components/schemas/Prijscomponent-sleutels'
+ redenOntbinding:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENONTBINDING.
+ deprecated: true
+ redenOpzegging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENOPZEGGING.
+ deprecated: true
+ redenVernietiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden van de vernietiging van de overeenkomst. OBSOLETE. Referentiedatasoort REDENVERNIETIGING.
+ deprecated: true
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ versturen:
+ type: boolean
+ description: De aanduiding of een afschrift van de overeenkomst moet worden gestuurd naar de relatie
+ volgnummer:
+ type: string
+ format: any
+ description: Het volgnummer van de overeenkomst.
+ Prijscomponent-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Overeenkomstbericht:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Overeenkomst:
+ oneOf:
+ - $ref: '#/components/schemas/Arbeidsovereenkomst'
+ - $ref: '#/components/schemas/Huurovereenkomst'
+ - $ref: '#/components/schemas/Inschrijving'
+ - $ref: '#/components/schemas/Koopovereenkomst'
+ - $ref: '#/components/schemas/Onderhoudsovereenkomst'
+ - $ref: '#/components/schemas/Serviceovereenkomst'
Overeenkomstkoppelingbericht:
allOf:
- $ref: '#/components/schemas/Overeenkomstkoppeling'
@@ -5228,10 +5269,81 @@ components:
format: date
description: De einddatum van de overeenkomst.
overeenkomsten:
- description: sleutels
+ description: De overeenkomsten die gekoppeld worden.
type: array
items:
- $ref: '#/components/schemas/Overeenkomst'
+ $ref: '#/components/schemas/Overeenkomst-sleutels'
+ Prijscomponentbericht:
+ allOf:
+ - $ref: '#/components/schemas/Prijscomponent'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Prijscomponent:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De bedrijfsspecifieke naam van het prijscomponent
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan om welk soort prijscomponent het betreft. Bijvoorbeeld een component voor een eenheid, of een component voor een overeenkomst. Referentiedatasoort PRIJSCOMPONENTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan om welk detail soort prijscomponent het betreft. Bijvoorbeeld of het om service kosten gaat. Referentiedatasoort PRIJSCOMPONENTDETAILSOORT.
+ subsidieSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan of het prijscomponent onderdeel kan zijn van een subsidieregeling. Vooralsnog alleen van toepassing op de wet op de huurtoeslag. Referentiedatasoort PRIJSCOMPONENTSUBSIDIESOORT.
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum van het prijscomponent. Dit is de datum waarop het prijscomponent van toepassing is.
+ einddatum:
+ type: string
+ format: date-time
+ description: De datum die aangeeft dat het prijscomponent niet meer van toepassing is. Er is dan een nieuwer prijscomponent van toepassing.
+ bedrag:
+ type: number
+ format: float
+ description: Het bedrag in euro's van het prijscomponent exclusief BTW.
+ bedragInclusiefBtw:
+ type: number
+ format: float
+ description: Het bedrag in euro's van het prijscomponent inclusief BTW.
+ btw:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De BTW van het prijscomponent. Referentiedatasoort BTW.
+ eenheid:
+ type: string
+ format: uri
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
+ overeenkomst:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
+ description: De overeenkomst waaraan het prijscomponent.
+ wijzigingsreden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan wat de reden was voor het aanpassen van het prijscomponent. Referentiedatasoort PRIJSCOMPONENTWIJZIGINGSREDEN.
Serviceovereenkomstbericht:
allOf:
- $ref: '#/components/schemas/Serviceovereenkomst'
diff --git a/Informatiedomeinen/Projectontwikkeling.yaml b/Informatiedomeinen/Projectontwikkeling.yaml
index 59e1e76..6218461 100644
--- a/Informatiedomeinen/Projectontwikkeling.yaml
+++ b/Informatiedomeinen/Projectontwikkeling.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://projectontwikkeling.vera.io:{port}/{basePath}
description: Productieserver
@@ -43,7 +43,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -59,7 +59,7 @@ paths:
get:
tags:
- 'Projecten'
- description: Ophalen van Projecten
+ summary: Ophalen van Projecten
operationId: listProjecten
parameters:
- name: params
@@ -109,7 +109,7 @@ paths:
post:
tags:
- 'Projecten'
- description: Voegt een nieuw(e) Project toe.
+ summary: Voegt een nieuw(e) Project toe.
operationId: createProject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -149,7 +149,7 @@ paths:
put:
tags:
- 'Projecten'
- description: |
+ summary: |
Vervangen van een Project op basis van overeenkomstige sleutelvelden.
operationId: replaceProject
parameters:
@@ -184,7 +184,7 @@ paths:
patch:
tags:
- 'Projecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Project. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProject
@@ -221,7 +221,7 @@ paths:
get:
tags:
- 'Projecten'
- description: Retourneert een Project met de gegeven identifier
+ summary: Retourneert een Project met de gegeven identifier
operationId: readProjectById
parameters:
- name: id
@@ -258,7 +258,7 @@ paths:
put:
tags:
- 'Projecten'
- description: Vervangen van een Project
+ summary: Vervangen van een Project
operationId: replaceProjectById
parameters:
- name: 'id'
@@ -296,7 +296,7 @@ paths:
patch:
tags:
- 'Projecten'
- description: Wijzigen van een Project
+ summary: Wijzigen van een Project
operationId: updateProjectById
parameters:
- name: 'id'
@@ -335,7 +335,7 @@ paths:
get:
tags:
- 'Projectbestedingen'
- description: Ophalen van Projectbestedingen
+ summary: Ophalen van Projectbestedingen
operationId: listProjectbestedingen
parameters:
- name: params
@@ -385,7 +385,7 @@ paths:
post:
tags:
- 'Projectbestedingen'
- description: Voegt een nieuw(e) Projectbesteding toe.
+ summary: Voegt een nieuw(e) Projectbesteding toe.
operationId: createProjectbesteding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -425,7 +425,7 @@ paths:
put:
tags:
- 'Projectbestedingen'
- description: |
+ summary: |
Vervangen van een Projectbesteding op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectbesteding
parameters:
@@ -460,7 +460,7 @@ paths:
patch:
tags:
- 'Projectbestedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectbesteding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectbesteding
@@ -497,7 +497,7 @@ paths:
get:
tags:
- 'Projectbestedingen'
- description: Retourneert een Projectbesteding met de gegeven identifier
+ summary: Retourneert een Projectbesteding met de gegeven identifier
operationId: readProjectbestedingById
parameters:
- name: id
@@ -534,7 +534,7 @@ paths:
put:
tags:
- 'Projectbestedingen'
- description: Vervangen van een Projectbesteding
+ summary: Vervangen van een Projectbesteding
operationId: replaceProjectbestedingById
parameters:
- name: 'id'
@@ -572,7 +572,7 @@ paths:
patch:
tags:
- 'Projectbestedingen'
- description: Wijzigen van een Projectbesteding
+ summary: Wijzigen van een Projectbesteding
operationId: updateProjectbestedingById
parameters:
- name: 'id'
@@ -611,7 +611,7 @@ paths:
get:
tags:
- 'Projectbudgetregels'
- description: Ophalen van Projectbudgetregels
+ summary: Ophalen van Projectbudgetregels
operationId: listProjectbudgetregels
parameters:
- name: params
@@ -661,7 +661,7 @@ paths:
post:
tags:
- 'Projectbudgetregels'
- description: Voegt een nieuw(e) Projectbudgetregel toe.
+ summary: Voegt een nieuw(e) Projectbudgetregel toe.
operationId: createProjectbudgetregel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -701,7 +701,7 @@ paths:
put:
tags:
- 'Projectbudgetregels'
- description: |
+ summary: |
Vervangen van een Projectbudgetregel op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectbudgetregel
parameters:
@@ -736,7 +736,7 @@ paths:
patch:
tags:
- 'Projectbudgetregels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectbudgetregel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectbudgetregel
@@ -773,7 +773,7 @@ paths:
get:
tags:
- 'Projectbudgetregels'
- description: Retourneert een Projectbudgetregel met de gegeven identifier
+ summary: Retourneert een Projectbudgetregel met de gegeven identifier
operationId: readProjectbudgetregelById
parameters:
- name: id
@@ -810,7 +810,7 @@ paths:
put:
tags:
- 'Projectbudgetregels'
- description: Vervangen van een Projectbudgetregel
+ summary: Vervangen van een Projectbudgetregel
operationId: replaceProjectbudgetregelById
parameters:
- name: 'id'
@@ -848,7 +848,7 @@ paths:
patch:
tags:
- 'Projectbudgetregels'
- description: Wijzigen van een Projectbudgetregel
+ summary: Wijzigen van een Projectbudgetregel
operationId: updateProjectbudgetregelById
parameters:
- name: 'id'
@@ -887,7 +887,7 @@ paths:
get:
tags:
- 'Projectdoelstellingen'
- description: Ophalen van Projectdoelstellingen
+ summary: Ophalen van Projectdoelstellingen
operationId: listProjectdoelstellingen
parameters:
- name: params
@@ -937,7 +937,7 @@ paths:
post:
tags:
- 'Projectdoelstellingen'
- description: Voegt een nieuw(e) Projectdoelstelling toe.
+ summary: Voegt een nieuw(e) Projectdoelstelling toe.
operationId: createProjectdoelstelling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -977,7 +977,7 @@ paths:
put:
tags:
- 'Projectdoelstellingen'
- description: |
+ summary: |
Vervangen van een Projectdoelstelling op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectdoelstelling
parameters:
@@ -1012,7 +1012,7 @@ paths:
patch:
tags:
- 'Projectdoelstellingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectdoelstelling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectdoelstelling
@@ -1049,7 +1049,7 @@ paths:
get:
tags:
- 'Projectdoelstellingen'
- description: Retourneert een Projectdoelstelling met de gegeven identifier
+ summary: Retourneert een Projectdoelstelling met de gegeven identifier
operationId: readProjectdoelstellingById
parameters:
- name: id
@@ -1086,7 +1086,7 @@ paths:
put:
tags:
- 'Projectdoelstellingen'
- description: Vervangen van een Projectdoelstelling
+ summary: Vervangen van een Projectdoelstelling
operationId: replaceProjectdoelstellingById
parameters:
- name: 'id'
@@ -1124,7 +1124,7 @@ paths:
patch:
tags:
- 'Projectdoelstellingen'
- description: Wijzigen van een Projectdoelstelling
+ summary: Wijzigen van een Projectdoelstelling
operationId: updateProjectdoelstellingById
parameters:
- name: 'id'
@@ -1163,7 +1163,7 @@ paths:
get:
tags:
- 'Projectfasen'
- description: Ophalen van Projectfasen
+ summary: Ophalen van Projectfasen
operationId: listProjectfasen
parameters:
- name: params
@@ -1213,7 +1213,7 @@ paths:
post:
tags:
- 'Projectfasen'
- description: Voegt een nieuw(e) Projectfase toe.
+ summary: Voegt een nieuw(e) Projectfase toe.
operationId: createProjectfase
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1253,7 +1253,7 @@ paths:
put:
tags:
- 'Projectfasen'
- description: |
+ summary: |
Vervangen van een Projectfase op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectfase
parameters:
@@ -1288,7 +1288,7 @@ paths:
patch:
tags:
- 'Projectfasen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectfase. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectfase
@@ -1325,7 +1325,7 @@ paths:
get:
tags:
- 'Projectfasen'
- description: Retourneert een Projectfase met de gegeven identifier
+ summary: Retourneert een Projectfase met de gegeven identifier
operationId: readProjectfaseById
parameters:
- name: id
@@ -1362,7 +1362,7 @@ paths:
put:
tags:
- 'Projectfasen'
- description: Vervangen van een Projectfase
+ summary: Vervangen van een Projectfase
operationId: replaceProjectfaseById
parameters:
- name: 'id'
@@ -1400,7 +1400,7 @@ paths:
patch:
tags:
- 'Projectfasen'
- description: Wijzigen van een Projectfase
+ summary: Wijzigen van een Projectfase
operationId: updateProjectfaseById
parameters:
- name: 'id'
@@ -1439,7 +1439,7 @@ paths:
get:
tags:
- 'Projectfasebesluiten'
- description: Ophalen van Projectfasebesluiten
+ summary: Ophalen van Projectfasebesluiten
operationId: listProjectfasebesluiten
parameters:
- name: params
@@ -1489,7 +1489,7 @@ paths:
post:
tags:
- 'Projectfasebesluiten'
- description: Voegt een nieuw(e) Projectfasebesluit toe.
+ summary: Voegt een nieuw(e) Projectfasebesluit toe.
operationId: createProjectfasebesluit
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1529,7 +1529,7 @@ paths:
put:
tags:
- 'Projectfasebesluiten'
- description: |
+ summary: |
Vervangen van een Projectfasebesluit op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectfasebesluit
parameters:
@@ -1564,7 +1564,7 @@ paths:
patch:
tags:
- 'Projectfasebesluiten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectfasebesluit. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectfasebesluit
@@ -1601,7 +1601,7 @@ paths:
get:
tags:
- 'Projectfasebesluiten'
- description: Retourneert een Projectfasebesluit met de gegeven identifier
+ summary: Retourneert een Projectfasebesluit met de gegeven identifier
operationId: readProjectfasebesluitById
parameters:
- name: id
@@ -1638,7 +1638,7 @@ paths:
put:
tags:
- 'Projectfasebesluiten'
- description: Vervangen van een Projectfasebesluit
+ summary: Vervangen van een Projectfasebesluit
operationId: replaceProjectfasebesluitById
parameters:
- name: 'id'
@@ -1676,7 +1676,7 @@ paths:
patch:
tags:
- 'Projectfasebesluiten'
- description: Wijzigen van een Projectfasebesluit
+ summary: Wijzigen van een Projectfasebesluit
operationId: updateProjectfasebesluitById
parameters:
- name: 'id'
@@ -1715,7 +1715,7 @@ paths:
get:
tags:
- 'Projectorders'
- description: Ophalen van Projectorders
+ summary: Ophalen van Projectorders
operationId: listProjectorders
parameters:
- name: params
@@ -1765,7 +1765,7 @@ paths:
post:
tags:
- 'Projectorders'
- description: Voegt een nieuw(e) Projectorder toe.
+ summary: Voegt een nieuw(e) Projectorder toe.
operationId: createProjectorder
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1805,7 +1805,7 @@ paths:
put:
tags:
- 'Projectorders'
- description: |
+ summary: |
Vervangen van een Projectorder op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectorder
parameters:
@@ -1840,7 +1840,7 @@ paths:
patch:
tags:
- 'Projectorders'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectorder. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectorder
@@ -1877,7 +1877,7 @@ paths:
get:
tags:
- 'Projectorders'
- description: Retourneert een Projectorder met de gegeven identifier
+ summary: Retourneert een Projectorder met de gegeven identifier
operationId: readProjectorderById
parameters:
- name: id
@@ -1914,7 +1914,7 @@ paths:
put:
tags:
- 'Projectorders'
- description: Vervangen van een Projectorder
+ summary: Vervangen van een Projectorder
operationId: replaceProjectorderById
parameters:
- name: 'id'
@@ -1952,7 +1952,7 @@ paths:
patch:
tags:
- 'Projectorders'
- description: Wijzigen van een Projectorder
+ summary: Wijzigen van een Projectorder
operationId: updateProjectorderById
parameters:
- name: 'id'
@@ -1991,7 +1991,7 @@ paths:
get:
tags:
- 'Projectrollen'
- description: Ophalen van Projectrollen
+ summary: Ophalen van Projectrollen
operationId: listProjectrollen
parameters:
- name: params
@@ -2041,7 +2041,7 @@ paths:
post:
tags:
- 'Projectrollen'
- description: Voegt een nieuw(e) Projectrol toe.
+ summary: Voegt een nieuw(e) Projectrol toe.
operationId: createProjectrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2081,7 +2081,7 @@ paths:
put:
tags:
- 'Projectrollen'
- description: |
+ summary: |
Vervangen van een Projectrol op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectrol
parameters:
@@ -2116,7 +2116,7 @@ paths:
patch:
tags:
- 'Projectrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectrol
@@ -2153,7 +2153,7 @@ paths:
get:
tags:
- 'Projectrollen'
- description: Retourneert een Projectrol met de gegeven identifier
+ summary: Retourneert een Projectrol met de gegeven identifier
operationId: readProjectrolById
parameters:
- name: id
@@ -2190,7 +2190,7 @@ paths:
put:
tags:
- 'Projectrollen'
- description: Vervangen van een Projectrol
+ summary: Vervangen van een Projectrol
operationId: replaceProjectrolById
parameters:
- name: 'id'
@@ -2228,7 +2228,7 @@ paths:
patch:
tags:
- 'Projectrollen'
- description: Wijzigen van een Projectrol
+ summary: Wijzigen van een Projectrol
operationId: updateProjectrolById
parameters:
- name: 'id'
@@ -2267,7 +2267,7 @@ paths:
get:
tags:
- 'Projecttaken'
- description: Ophalen van Projecttaken
+ summary: Ophalen van Projecttaken
operationId: listProjecttaken
parameters:
- name: params
@@ -2317,7 +2317,7 @@ paths:
post:
tags:
- 'Projecttaken'
- description: Voegt een nieuw(e) Projecttaak toe.
+ summary: Voegt een nieuw(e) Projecttaak toe.
operationId: createProjecttaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2357,7 +2357,7 @@ paths:
put:
tags:
- 'Projecttaken'
- description: |
+ summary: |
Vervangen van een Projecttaak op basis van overeenkomstige sleutelvelden.
operationId: replaceProjecttaak
parameters:
@@ -2392,7 +2392,7 @@ paths:
patch:
tags:
- 'Projecttaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projecttaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjecttaak
@@ -2429,7 +2429,7 @@ paths:
get:
tags:
- 'Projecttaken'
- description: Retourneert een Projecttaak met de gegeven identifier
+ summary: Retourneert een Projecttaak met de gegeven identifier
operationId: readProjecttaakById
parameters:
- name: id
@@ -2466,7 +2466,7 @@ paths:
put:
tags:
- 'Projecttaken'
- description: Vervangen van een Projecttaak
+ summary: Vervangen van een Projecttaak
operationId: replaceProjecttaakById
parameters:
- name: 'id'
@@ -2504,7 +2504,7 @@ paths:
patch:
tags:
- 'Projecttaken'
- description: Wijzigen van een Projecttaak
+ summary: Wijzigen van een Projecttaak
operationId: updateProjecttaakById
parameters:
- name: 'id'
@@ -2576,10 +2576,34 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Projectontwikkeling.All.Read: alleen lezen van alle resources
+ Projectontwikkeling.All.ReadWrite: lezen en schrijven van alle resources
+ Projectontwikkeling.Projecten.Read: alleen lezen van Projecten
+ Projectontwikkeling.Projecten.ReadWrite: lezen en schrijven van Projecten
+ Projectontwikkeling.Projectbestedingen.Read: alleen lezen van Projectbestedingen
+ Projectontwikkeling.Projectbestedingen.ReadWrite: lezen en schrijven van Projectbestedingen
+ Projectontwikkeling.Projectbudgetregels.Read: alleen lezen van Projectbudgetregels
+ Projectontwikkeling.Projectbudgetregels.ReadWrite: lezen en schrijven van Projectbudgetregels
+ Projectontwikkeling.Projectdoelstellingen.Read: alleen lezen van Projectdoelstellingen
+ Projectontwikkeling.Projectdoelstellingen.ReadWrite: lezen en schrijven van Projectdoelstellingen
+ Projectontwikkeling.Projectfasen.Read: alleen lezen van Projectfasen
+ Projectontwikkeling.Projectfasen.ReadWrite: lezen en schrijven van Projectfasen
+ Projectontwikkeling.Projectfasebesluiten.Read: alleen lezen van Projectfasebesluiten
+ Projectontwikkeling.Projectfasebesluiten.ReadWrite: lezen en schrijven van Projectfasebesluiten
+ Projectontwikkeling.Projectorders.Read: alleen lezen van Projectorders
+ Projectontwikkeling.Projectorders.ReadWrite: lezen en schrijven van Projectorders
+ Projectontwikkeling.Projectrollen.Read: alleen lezen van Projectrollen
+ Projectontwikkeling.Projectrollen.ReadWrite: lezen en schrijven van Projectrollen
+ Projectontwikkeling.Projecttaken.Read: alleen lezen van Projecttaken
+ Projectontwikkeling.Projecttaken.ReadWrite: lezen en schrijven van Projecttaken
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Projectontwikkeling.All.Read: alleen lezen van alle resources
Projectontwikkeling.All.ReadWrite: lezen en schrijven van alle resources
@@ -2665,38 +2689,38 @@ components:
items:
type: string
format: uri
- description: Referenties naar Aanbesteding in informatiedomein Financien
+ description: Referenties naar Aanbesteding-sleutels in informatiedomein Financien
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
doelstelling:
allOf:
- - $ref: '#/components/schemas/Projectdoelstelling'
+ - $ref: '#/components/schemas/Projectdoelstelling-sleutels'
description: De set criteria die samen de doelstelling van het project en de kaders waarbinnen het project gerealiseerd moet worden, representeert.
dossier:
type: string
format: uri
- description: Referentie naar Dossier in informatiedomein Dossier
+ description: Referentie naar Dossier-sleutels in informatiedomein Dossier
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
fasen:
description: De fasen die het project doorloopt of heeft doorlopen. Omdat iedere fase een begin- en een einddatum heeft, kan op ieder moment worden bepaald in welke fase het project bevindt. Een project bevindt zich bijvoorbeeld in de Initiatieffase of in de Realisatiefase.
type: array
items:
- $ref: '#/components/schemas/Projectfase'
+ $ref: '#/components/schemas/Projectfase-sleutels'
percelen:
type: array
items:
type: string
format: uri
- description: Referenties naar KadasterPerceel in informatiedomein Vastgoed
+ description: Referenties naar KadasterPerceel-sleutels in informatiedomein Vastgoed
regiesoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2705,7 +2729,7 @@ components:
description: De rol die een aan een project verbonden relatie (een natuurlijk persoon of rechtspersoon) heeft binnen de context van het project.
type: array
items:
- $ref: '#/components/schemas/Projectrol'
+ $ref: '#/components/schemas/Projectrol-sleutels'
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2732,7 +2756,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -2744,7 +2768,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -2799,11 +2823,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projectdoelstellingbericht:
- allOf:
- - $ref: '#/components/schemas/Projectdoelstelling'
- - $ref: '#/components/schemas/Bericht-basis'
- Projectdoelstelling:
+ Projectdoelstelling-sleutels:
type: object
properties:
id:
@@ -2822,96 +2842,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- gewensteBegindatum:
- type: string
- format: date-time
- description: De tot doel gestelde begindatum van het project.
- gewensteEinddatum:
- type: string
- format: date-time
- description: De tot doel gestelde einddatum van het project.
- aantalGetransformeerdeEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal eenheden na transformatie.
- aantalTeBouwenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal nieuw te bouwen eenheden.
- aantalTeRenoverenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal te renoveren eenheden.
- aantalTeSlopenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal te slopen eenheden.
- aantalTeTransformerenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal te transformeren eenheden.
- beleidswaarde:
- type: string
- format: uri
- description: Referentie naar Beleidswaarde in informatiedomein Vastgoed
- brutoAanvangsrendement:
- type: number
- format: float
- description: De (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst gedeeld door de totale investeringskosten. Meestal afgekort tot BAR.
- gemBVOPerEenheid:
- type: integer
- format: int32
- description: De gemiddelde bruto vloeroppervlakte per eenheid van het op te leveren vastgoed.
- gemGBOPerEenheid:
- type: integer
- format: int32
- description: De gemiddelde gebruiksoppervlakte per eenheid van het op te leveren vastgoed.
- gemiddeldeEnergieindex:
- type: integer
- format: int32
- description: De gemiddelde energie index per eenheid van het op te leveren vastgoed.
- gemiddeldeHuurprijs:
- type: number
- format: float
- description: De gemiddelde netto huurprijs per eenheid van het op te leveren vastgoed.
- gemiddeldeWoningwaarderingsPunten:
- type: number
- format: float
- description: Het gemiddeld aantal WWS-punten per eenheid van het op te leveren vastgoed.
- gemVVOPerEenheid:
- type: integer
- format: int32
- description: De gemiddelde verhuurbare vloeroppervlakte per eenheid van het op te leveren vastgoed.
- initieleBudgetregels:
- description: Het voor het project benodigde budget en eventueel de beoogde opbrengsten, opgesplitst in een of meerdere projectbudgetregels.
- type: array
- items:
- $ref: '#/components/schemas/Projectbudgetregel'
- internalRateOfReturn:
- type: number
- format: float
- description: De rentevoet waarbij de som van de contante waarden van de verwachte toekomstige opbrengsten gelijk is aan de investering. Meestal afgekort tot IRR.
- maatschappelijkLabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort het project tot de DAEB-tak of tot de niet-DAEB-tak. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
- marktwaarde:
- type: string
- format: uri
- description: Referentie naar Marktwaarde in informatiedomein Vastgoed
- nettoAanvangsrendement:
- type: number
- format: float
- description: De verwachte (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst minus de exploitatiekosten gedeeld door de totale investeringskosten. Meestal afgekort tot NAR.
- project:
- allOf:
- - $ref: '#/components/schemas/Project-sleutels'
- description: Het project waar de doelstelling betrekking op heeft.
- Projectbudgetregelbericht:
- allOf:
- - $ref: '#/components/schemas/Projectbudgetregel'
- - $ref: '#/components/schemas/Bericht-basis'
- Projectbudgetregel:
+ Projectfase-sleutels:
type: object
properties:
id:
@@ -2929,77 +2860,8 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Via Projectbudgetregelsoort wordt het onderscheid gemaakt tussen Prognose-bedragen en Budget-bedragen, die daardoor naast elkaar gepresenteerd kunnen worden. Referentiedatasoort PROJECTBUDGETREGELSOORT.
- regelsoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: In combinatie met bovenliggendeBudgetregel kan met behulp van het attribuut projectbudgetregelregelsoort een hiërarchische structuur binnen budgetregels worden weergegeven. Hierbij worden detail-, en subtotaalregels onderscheiden. Ook wordt via de regelsoort het onderscheid tussen kosten en opbrengsten aangegeven. Referentiedatasoort PROJECTBUDGETREGELREGELSOORT.
- omschrijving:
- type: string
- format: any
- description: De omschrijving of naam van de projectbudgetregel.
- bovenliggendeBudgetregel:
- allOf:
- - $ref: '#/components/schemas/Projectbudgetregel-sleutels'
- description: De budgetregel die hiërarchisch boven de budgetregel ligt.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de budgetregel, bijvoorbeeld aangevraagd, bijgesteld, vrijgegeven, goedgekeurd. Door de attributen status en soort te combineren, en met begin- en einddatums, kan de gehele cyclus van een budgetregel in de tijd worden gevolgd (van goedgekeurde prognose via bijgestelde prognose en aangevraagd budget naar vrijgegeven budget). Referentiedatasoort PROJECTBUDGETREGELSTATUS.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van de projectbudgetregel.
- einddatum:
- type: string
- format: date-time
- description: De einddatum van de projectbudgetregel.
- datumAanvraag:
- type: string
- format: date-time
- description: De datum waarop een aanvraag wordt gedaan voor goedkeuring van een budgetregel, bijvoorbeeld voor een bijgestelde prognose of voor aanvullend budget.
- datumGoedkeuring:
- type: string
- format: date-time
- description: De datum waarom goedkeuring is verkregen voor een aanvraag, van bijvoorbeeld een bijgestelde prognose of aanvullend budget.
- bedrag:
- type: number
- format: float
- description: Bedrag exclusief BTW. van de budgetregel.
- bestedingen:
- description: sleutels
- type: array
- items:
- $ref: '#/components/schemas/Projectbesteding'
- btwTarief:
- type: string
- format: uri
- description: Referentie naar BtwTarief in informatiedomein Financien
- doelstelling:
- allOf:
- - $ref: '#/components/schemas/Projectdoelstelling-sleutels'
- description: De (financiële) kaders waarbinnen het project gerealiseerd moet worden. Afhankelijk van het soort project kan dit op hoog aggregatieniveau (een of enkele budgetregels met totalen) of in meer details (uitgesplitst in meer detailregels in een hiërarchische structuur).
- fase:
- allOf:
- - $ref: '#/components/schemas/Projectfase'
- description: De projectfase waarvoor de budgetregel geldig is.
- fasebesluit:
- allOf:
- - $ref: '#/components/schemas/Projectfasebesluit'
- description: Het fasebesluit waarin de budgetregel ter goedkeuring is voorgelegd aan de opdrachtgever.
- grootboekrekening:
- type: string
- format: uri
- description: Referentie naar Grootboekrekening in informatiedomein Financien
- order:
- allOf:
- - $ref: '#/components/schemas/Projectorder'
- description: De inkooporder die is verstrekt met een verwijzing naar de projectbudgetregel. De kosten van de order zullen, met andere woorden, ten laste komen van de budgetregel.
- Projectbudgetregel-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Projectrol-sleutels:
type: object
properties:
id:
@@ -3079,7 +2941,7 @@ components:
description: De meeteenheid waarin de besteding wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
order:
allOf:
- - $ref: '#/components/schemas/Projectorder'
+ - $ref: '#/components/schemas/Projectorder-sleutels'
description: De projectorder die ten grondslag ligt aan de besteding, indien werkzaamheden door een externe partij zijn uitvoerd.
reistijd:
type: string
@@ -3088,13 +2950,9 @@ components:
description: De reistijd.
taak:
allOf:
- - $ref: '#/components/schemas/Projecttaak'
+ - $ref: '#/components/schemas/Projecttaak-sleutels'
description: De taak die de werkzaamheden omschrijft waarvoor de besteding is geregistreerd.
- Projectorderbericht:
- allOf:
- - $ref: '#/components/schemas/Projectorder'
- - $ref: '#/components/schemas/Bericht-basis'
- Projectorder:
+ Projectbudgetregel-sleutels:
type: object
properties:
id:
@@ -3113,33 +2971,26 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- afrekenwijze:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De wijze waarop de projectorder wordt afgerekend (of niet). Bijvoorbeeld: Nacalculatie regie, Nacalculatie eenheidsprijzen, Vaste prijs, Afkoop, Garantie Referentiedatasoort AFREKENWIJZESOORT.'
- bestedingen:
- description: De besteding(en) die via de order zijn geregistreerd.
- type: array
- items:
- $ref: '#/components/schemas/Projectbesteding-sleutels'
- budgetregels:
- description: De projectbudgetregel(s) waarmee dekking is verkregen voor de projectorder.
- type: array
- items:
- $ref: '#/components/schemas/Projectbudgetregel-sleutels'
- inkoopopdracht:
+ Projectorder-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: uri
- description: Referentie naar Inkoopopdracht in informatiedomein Financien
- overeenkomst:
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- taak:
- allOf:
- - $ref: '#/components/schemas/Projecttaak'
- description: De taak die de werkzaamheden omschrijft waarvoor de projectorder is verstrekt.
- Projectbesteding-sleutels:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Projecttaak-sleutels:
type: object
properties:
id:
@@ -3158,11 +3009,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projecttaakbericht:
+ Projectbudgetregelbericht:
allOf:
- - $ref: '#/components/schemas/Projecttaak'
+ - $ref: '#/components/schemas/Projectbudgetregel'
- $ref: '#/components/schemas/Bericht-basis'
- Projecttaak:
+ Projectbudgetregel:
type: object
properties:
id:
@@ -3184,74 +3035,218 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Om een ordening te kunnen maken in de vele mogelijke taken die binnen een projectfase uitgevoerd worden, kan een taak een projecttaaksoort krijgen. Bijvoorbeeld: Controlerende taken, Uitvoerende taken, Administratieve taken. Referentiedatasoort PROJECTTAAKSOORT.'
- detailSoort:
- allOf:
+ description: Via Projectbudgetregelsoort wordt het onderscheid gemaakt tussen Prognose-bedragen en Budget-bedragen, die daardoor naast elkaar gepresenteerd kunnen worden. Referentiedatasoort PROJECTBUDGETREGELSOORT.
+ regelsoort:
+ allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Nadere aanduiding van een projecttaaksoort. Bijvoorbeeld: Maken communicatieplan, Opleveren DO, Inrichten modelwoning, Uitvoeren draagvlakmeting, Toezicht op de bouw, Actualiseren MJOP, Informeren bewoners, Verlenen decharge projectteam, Uitvoeren bewonersenquête Referentiedatasoort PROJECTTAAKDETAILSOORT.'
+ description: In combinatie met bovenliggendeBudgetregel kan met behulp van het attribuut projectbudgetregelregelsoort een hiërarchische structuur binnen budgetregels worden weergegeven. Hierbij worden detail-, en subtotaalregels onderscheiden. Ook wordt via de regelsoort het onderscheid tussen kosten en opbrengsten aangegeven. Referentiedatasoort PROJECTBUDGETREGELREGELSOORT.
omschrijving:
type: string
format: any
- description: De omschrijving of naam van de taak.
+ description: De omschrijving of naam van de projectbudgetregel.
+ bovenliggendeBudgetregel:
+ allOf:
+ - $ref: '#/components/schemas/Projectbudgetregel-sleutels'
+ description: De budgetregel die hiërarchisch boven de budgetregel ligt.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de budgetregel, bijvoorbeeld aangevraagd, bijgesteld, vrijgegeven, goedgekeurd. Door de attributen status en soort te combineren, en met begin- en einddatums, kan de gehele cyclus van een budgetregel in de tijd worden gevolgd (van goedgekeurde prognose via bijgestelde prognose en aangevraagd budget naar vrijgegeven budget). Referentiedatasoort PROJECTBUDGETREGELSTATUS.
begindatum:
type: string
format: date-time
- description: De werkelijke begindatum van uitvoering van de taak.
+ description: De begindatum van de projectbudgetregel.
einddatum:
type: string
format: date-time
- description: De werkelijke einddatum van uitvoering van de taak.
- gewensteBegindatum:
+ description: De einddatum van de projectbudgetregel.
+ datumAanvraag:
type: string
format: date-time
- description: De gewenste begindatum van uitvoering van de taak.
- gewensteEinddatum:
+ description: De datum waarop een aanvraag wordt gedaan voor goedkeuring van een budgetregel, bijvoorbeeld voor een bijgestelde prognose of voor aanvullend budget.
+ datumGoedkeuring:
type: string
format: date-time
- description: De gewenste einddatum van uitvoering van de taak.
+ description: De datum waarom goedkeuring is verkregen voor een aanvraag, van bijvoorbeeld een bijgestelde prognose of aanvullend budget.
+ bedrag:
+ type: number
+ format: float
+ description: Bedrag exclusief BTW. van de budgetregel.
bestedingen:
- description: De besteding(en) die tijdens of als gevolg van het uitvoeren van de taak zijn geregistreerd.
+ description: De projectbesteding(en) die zijn gedaan met een verwijzing naar de projectbudgetregel. De kosten van de bestedingen zullen, met andere woorden, ten laste komen van de budgetregel.
type: array
items:
$ref: '#/components/schemas/Projectbesteding-sleutels'
- clusters:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
- eenheden:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ btwTarief:
+ type: string
+ format: uri
+ description: Referentie naar BtwTarief-sleutels in informatiedomein Financien
+ doelstelling:
+ allOf:
+ - $ref: '#/components/schemas/Projectdoelstelling-sleutels'
+ description: De (financiële) kaders waarbinnen het project gerealiseerd moet worden. Afhankelijk van het soort project kan dit op hoog aggregatieniveau (een of enkele budgetregels met totalen) of in meer details (uitgesplitst in meer detailregels in een hiërarchische structuur).
fase:
allOf:
- - $ref: '#/components/schemas/Projectfase'
- description: De fase waarbinnen de taak wordt uitgevoerd.
- kwaliteitsmetingen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Kwaliteitsmetingsverzoek in informatiedomein Kwaliteit
- orders:
- description: De order(s) die is of zijn verstrekt tijdens of als gevolg van het uitvoeren van de taak.
- type: array
- items:
- $ref: '#/components/schemas/Projectorder-sleutels'
- percelen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar KadasterPerceel in informatiedomein Vastgoed
- rollen:
- description: De projectrol (i.c. een relatie die in de context van de taak een bepaalde rol vervult) die bij uitvoering van de taak een functie heeft.
+ - $ref: '#/components/schemas/Projectfase-sleutels'
+ description: De projectfase waarvoor de budgetregel geldig is.
+ fasebesluit:
+ allOf:
+ - $ref: '#/components/schemas/Projectfasebesluit-sleutels'
+ description: Het fasebesluit waarin de budgetregel ter goedkeuring is voorgelegd aan de opdrachtgever.
+ grootboekrekening:
+ type: string
+ format: uri
+ description: Referentie naar Grootboekrekening-sleutels in informatiedomein Financien
+ order:
+ allOf:
+ - $ref: '#/components/schemas/Projectorder-sleutels'
+ description: De inkooporder die is verstrekt met een verwijzing naar de projectbudgetregel. De kosten van de order zullen, met andere woorden, ten laste komen van de budgetregel.
+ Projectbesteding-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Projectfasebesluit-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Projectdoelstellingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Projectdoelstelling'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Projectdoelstelling:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ gewensteBegindatum:
+ type: string
+ format: date-time
+ description: De tot doel gestelde begindatum van het project.
+ gewensteEinddatum:
+ type: string
+ format: date-time
+ description: De tot doel gestelde einddatum van het project.
+ aantalGetransformeerdeEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal eenheden na transformatie.
+ aantalTeBouwenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal nieuw te bouwen eenheden.
+ aantalTeRenoverenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal te renoveren eenheden.
+ aantalTeSlopenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal te slopen eenheden.
+ aantalTeTransformerenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal te transformeren eenheden.
+ beleidswaarde:
+ type: string
+ format: uri
+ description: Referentie naar Beleidswaarde-sleutels in informatiedomein Vastgoed
+ brutoAanvangsrendement:
+ type: number
+ format: float
+ description: De (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst gedeeld door de totale investeringskosten. Meestal afgekort tot BAR.
+ gemBVOPerEenheid:
+ type: integer
+ format: int32
+ description: De gemiddelde bruto vloeroppervlakte per eenheid van het op te leveren vastgoed.
+ gemGBOPerEenheid:
+ type: integer
+ format: int32
+ description: De gemiddelde gebruiksoppervlakte per eenheid van het op te leveren vastgoed.
+ gemiddeldeEnergieindex:
+ type: integer
+ format: int32
+ description: De gemiddelde energie index per eenheid van het op te leveren vastgoed.
+ gemiddeldeHuurprijs:
+ type: number
+ format: float
+ description: De gemiddelde netto huurprijs per eenheid van het op te leveren vastgoed.
+ gemiddeldeWoningwaarderingsPunten:
+ type: number
+ format: float
+ description: Het gemiddeld aantal WWS-punten per eenheid van het op te leveren vastgoed.
+ gemVVOPerEenheid:
+ type: integer
+ format: int32
+ description: De gemiddelde verhuurbare vloeroppervlakte per eenheid van het op te leveren vastgoed.
+ initieleBudgetregels:
+ description: Het voor het project benodigde budget en eventueel de beoogde opbrengsten, opgesplitst in een of meerdere projectbudgetregels.
type: array
items:
- $ref: '#/components/schemas/Projectrol'
+ $ref: '#/components/schemas/Projectbudgetregel-sleutels'
+ internalRateOfReturn:
+ type: number
+ format: float
+ description: De rentevoet waarbij de som van de contante waarden van de verwachte toekomstige opbrengsten gelijk is aan de investering. Meestal afgekort tot IRR.
+ maatschappelijkLabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort het project tot de DAEB-tak of tot de niet-DAEB-tak. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
+ marktwaarde:
+ type: string
+ format: uri
+ description: Referentie naar Marktwaarde-sleutels in informatiedomein Vastgoed
+ nettoAanvangsrendement:
+ type: number
+ format: float
+ description: De verwachte (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst minus de exploitatiekosten gedeeld door de totale investeringskosten. Meestal afgekort tot NAR.
+ project:
+ allOf:
+ - $ref: '#/components/schemas/Project-sleutels'
+ description: Het project waar de doelstelling betrekking op heeft.
Projectfasebericht:
allOf:
- $ref: '#/components/schemas/Projectfase'
@@ -3297,7 +3292,7 @@ components:
description: De gewenste, of beoogde, einddatum van de projectfase.
besluit:
allOf:
- - $ref: '#/components/schemas/Projectfasebesluit'
+ - $ref: '#/components/schemas/Projectfasebesluit-sleutels'
description: Het Projectfasebesluit-document waarmee het einde van een projectfase wordt gemarkeerd.
budgetregels:
description: De budgetregels die bij de projectfase horen. Iedere fase wordt afgesloten met een fasebesluit waarin alle budgetregels binnen de fase worden beëindigd. Een nieuwe verzameling budgetregels wordt gekoppeld aan de volgende fase. Zo heeft iedere projectfase een eigen verzameling budgetregels.
@@ -3312,7 +3307,7 @@ components:
description: De rol(len) van de aan de projectfase verbonden relatie(s) heeft. Zo kan dezelfde relatie binnen een project verschillende rollen vervullen afhankelijk van de projectfase.
type: array
items:
- $ref: '#/components/schemas/Projectrol'
+ $ref: '#/components/schemas/Projectrol-sleutels'
taken:
description: De projecttaken die horen bij de fase.
type: array
@@ -3366,7 +3361,11 @@ components:
allOf:
- $ref: '#/components/schemas/Projectfase-sleutels'
description: De fase waarop het fasebesluit betrekking heeft.
- Projectfase-sleutels:
+ Projectorderbericht:
+ allOf:
+ - $ref: '#/components/schemas/Projectorder'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Projectorder:
type: object
properties:
id:
@@ -3384,7 +3383,33 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ afrekenwijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De wijze waarop de projectorder wordt afgerekend (of niet). Bijvoorbeeld: Nacalculatie regie, Nacalculatie eenheidsprijzen, Vaste prijs, Afkoop, Garantie Referentiedatasoort AFREKENWIJZESOORT.'
+ bestedingen:
+ description: De besteding(en) die via de order zijn geregistreerd.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectbesteding-sleutels'
+ budgetregels:
+ description: De projectbudgetregel(s) waarmee dekking is verkregen voor de projectorder.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectbudgetregel-sleutels'
+ inkoopopdracht:
+ type: string
+ format: uri
+ description: Referentie naar Inkoopopdracht-sleutels in informatiedomein Financien
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ taak:
+ allOf:
+ - $ref: '#/components/schemas/Projecttaak-sleutels'
+ description: De taak die de werkzaamheden omschrijft waarvoor de projectorder is verstrekt.
Projectrolbericht:
allOf:
- $ref: '#/components/schemas/Projectrol'
@@ -3436,13 +3461,17 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
taken:
description: De taak of taken waarbij de projectrol (i.c. een relatie die in de context van de taak een bepaalde rol vervult) een functie heeft.
type: array
items:
$ref: '#/components/schemas/Projecttaak-sleutels'
- Projecttaak-sleutels:
+ Projecttaakbericht:
+ allOf:
+ - $ref: '#/components/schemas/Projecttaak'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Projecttaak:
type: object
properties:
id:
@@ -3461,44 +3490,77 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projectorder-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Om een ordening te kunnen maken in de vele mogelijke taken die binnen een projectfase uitgevoerd worden, kan een taak een projecttaaksoort krijgen. Bijvoorbeeld: Controlerende taken, Uitvoerende taken, Administratieve taken. Referentiedatasoort PROJECTTAAKSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Nadere aanduiding van een projecttaaksoort. Bijvoorbeeld: Maken communicatieplan, Opleveren DO, Inrichten modelwoning, Uitvoeren draagvlakmeting, Toezicht op de bouw, Actualiseren MJOP, Informeren bewoners, Verlenen decharge projectteam, Uitvoeren bewonersenquête Referentiedatasoort PROJECTTAAKDETAILSOORT.'
+ omschrijving:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projectdoelstelling-sleutels:
- type: object
- properties:
- id:
+ description: De omschrijving of naam van de taak.
+ begindatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
+ format: date-time
+ description: De werkelijke begindatum van uitvoering van de taak.
+ einddatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ format: date-time
+ description: De werkelijke einddatum van uitvoering van de taak.
+ gewensteBegindatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ format: date-time
+ description: De gewenste begindatum van uitvoering van de taak.
+ gewensteEinddatum:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ format: date-time
+ description: De gewenste einddatum van uitvoering van de taak.
+ bestedingen:
+ description: De besteding(en) die tijdens of als gevolg van het uitvoeren van de taak zijn geregistreerd.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectbesteding-sleutels'
+ clusters:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
+ eenheden:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ fase:
+ allOf:
+ - $ref: '#/components/schemas/Projectfase-sleutels'
+ description: De fase waarbinnen de taak wordt uitgevoerd.
+ kwaliteitsmetingen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Kwaliteitsmetingsverzoek-sleutels in informatiedomein Kwaliteit
+ orders:
+ description: De order(s) die is of zijn verstrekt tijdens of als gevolg van het uitvoeren van de taak.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectorder-sleutels'
+ percelen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar KadasterPerceel-sleutels in informatiedomein Vastgoed
+ rollen:
+ description: De projectrol (i.c. een relatie die in de context van de taak een bepaalde rol vervult) die bij uitvoering van de taak een functie heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectrol-sleutels'
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Relaties.yaml b/Informatiedomeinen/Relaties.yaml
index ee22106..8329cf7 100644
--- a/Informatiedomeinen/Relaties.yaml
+++ b/Informatiedomeinen/Relaties.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://relaties.vera.io:{port}/{basePath}
description: Productieserver
@@ -63,7 +63,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -79,7 +79,7 @@ paths:
get:
tags:
- 'Accounts'
- description: Ophalen van Accounts
+ summary: Ophalen van Accounts
operationId: listAccounts
parameters:
- name: params
@@ -129,7 +129,7 @@ paths:
post:
tags:
- 'Accounts'
- description: Voegt een nieuw(e) Account toe.
+ summary: Voegt een nieuw(e) Account toe.
operationId: createAccount
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -169,7 +169,7 @@ paths:
put:
tags:
- 'Accounts'
- description: |
+ summary: |
Vervangen van een Account op basis van overeenkomstige sleutelvelden.
operationId: replaceAccount
parameters:
@@ -204,7 +204,7 @@ paths:
patch:
tags:
- 'Accounts'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Account. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAccount
@@ -241,7 +241,7 @@ paths:
get:
tags:
- 'Accounts'
- description: Retourneert een Account met de gegeven identifier
+ summary: Retourneert een Account met de gegeven identifier
operationId: readAccountById
parameters:
- name: id
@@ -278,7 +278,7 @@ paths:
put:
tags:
- 'Accounts'
- description: Vervangen van een Account
+ summary: Vervangen van een Account
operationId: replaceAccountById
parameters:
- name: 'id'
@@ -316,7 +316,7 @@ paths:
patch:
tags:
- 'Accounts'
- description: Wijzigen van een Account
+ summary: Wijzigen van een Account
operationId: updateAccountById
parameters:
- name: 'id'
@@ -355,7 +355,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Ophalen van Afspraken
+ summary: Ophalen van Afspraken
operationId: listAfspraken
parameters:
- name: params
@@ -405,7 +405,7 @@ paths:
post:
tags:
- 'Afspraken'
- description: Voegt een nieuw(e) Afspraak toe.
+ summary: Voegt een nieuw(e) Afspraak toe.
operationId: createAfspraak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -445,7 +445,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: |
+ summary: |
Vervangen van een Afspraak op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraak
parameters:
@@ -480,7 +480,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Afspraak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraak
@@ -517,7 +517,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Retourneert een Afspraak met de gegeven identifier
+ summary: Retourneert een Afspraak met de gegeven identifier
operationId: readAfspraakById
parameters:
- name: id
@@ -554,7 +554,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: Vervangen van een Afspraak
+ summary: Vervangen van een Afspraak
operationId: replaceAfspraakById
parameters:
- name: 'id'
@@ -592,7 +592,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: Wijzigen van een Afspraak
+ summary: Wijzigen van een Afspraak
operationId: updateAfspraakById
parameters:
- name: 'id'
@@ -631,7 +631,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Ophalen van AfspraakOpties
+ summary: Ophalen van AfspraakOpties
operationId: listAfspraakOpties
parameters:
- name: params
@@ -681,7 +681,7 @@ paths:
post:
tags:
- 'AfspraakOpties'
- description: Voegt een nieuw(e) AfspraakOptie toe.
+ summary: Voegt een nieuw(e) AfspraakOptie toe.
operationId: createAfspraakOptie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -721,7 +721,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Vervangen van een AfspraakOptie op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraakOptie
parameters:
@@ -756,7 +756,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een AfspraakOptie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraakOptie
@@ -793,7 +793,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Retourneert een AfspraakOptie met de gegeven identifier
+ summary: Retourneert een AfspraakOptie met de gegeven identifier
operationId: readAfspraakOptieById
parameters:
- name: id
@@ -830,7 +830,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: Vervangen van een AfspraakOptie
+ summary: Vervangen van een AfspraakOptie
operationId: replaceAfspraakOptieById
parameters:
- name: 'id'
@@ -868,7 +868,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: Wijzigen van een AfspraakOptie
+ summary: Wijzigen van een AfspraakOptie
operationId: updateAfspraakOptieById
parameters:
- name: 'id'
@@ -907,7 +907,7 @@ paths:
get:
tags:
- 'Afspraakverzoeken'
- description: Ophalen van Afspraakverzoeken
+ summary: Ophalen van Afspraakverzoeken
operationId: listAfspraakverzoeken
parameters:
- name: params
@@ -957,7 +957,7 @@ paths:
post:
tags:
- 'Afspraakverzoeken'
- description: Voegt een nieuw(e) Afspraakverzoek toe.
+ summary: Voegt een nieuw(e) Afspraakverzoek toe.
operationId: createAfspraakverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -997,7 +997,7 @@ paths:
put:
tags:
- 'Afspraakverzoeken'
- description: |
+ summary: |
Vervangen van een Afspraakverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraakverzoek
parameters:
@@ -1032,7 +1032,7 @@ paths:
patch:
tags:
- 'Afspraakverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Afspraakverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraakverzoek
@@ -1069,7 +1069,7 @@ paths:
get:
tags:
- 'Afspraakverzoeken'
- description: Retourneert een Afspraakverzoek met de gegeven identifier
+ summary: Retourneert een Afspraakverzoek met de gegeven identifier
operationId: readAfspraakverzoekById
parameters:
- name: id
@@ -1106,7 +1106,7 @@ paths:
put:
tags:
- 'Afspraakverzoeken'
- description: Vervangen van een Afspraakverzoek
+ summary: Vervangen van een Afspraakverzoek
operationId: replaceAfspraakverzoekById
parameters:
- name: 'id'
@@ -1144,7 +1144,7 @@ paths:
patch:
tags:
- 'Afspraakverzoeken'
- description: Wijzigen van een Afspraakverzoek
+ summary: Wijzigen van een Afspraakverzoek
operationId: updateAfspraakverzoekById
parameters:
- name: 'id'
@@ -1183,7 +1183,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Ophalen van Betaalgegevens
+ summary: Ophalen van Betaalgegevens
operationId: listBetaalgegevens
parameters:
- name: params
@@ -1233,7 +1233,7 @@ paths:
post:
tags:
- 'Betaalgegevens'
- description: Voegt een nieuw(e) Betaalgegeven toe.
+ summary: Voegt een nieuw(e) Betaalgegeven toe.
operationId: createBetaalgegeven
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1273,7 +1273,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Vervangen van een Betaalgegeven op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalgegeven
parameters:
@@ -1308,7 +1308,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalgegeven. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalgegeven
@@ -1345,7 +1345,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Retourneert een Betaalgegeven met de gegeven identifier
+ summary: Retourneert een Betaalgegeven met de gegeven identifier
operationId: readBetaalgegevenById
parameters:
- name: id
@@ -1382,7 +1382,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: Vervangen van een Betaalgegeven
+ summary: Vervangen van een Betaalgegeven
operationId: replaceBetaalgegevenById
parameters:
- name: 'id'
@@ -1420,7 +1420,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: Wijzigen van een Betaalgegeven
+ summary: Wijzigen van een Betaalgegeven
operationId: updateBetaalgegevenById
parameters:
- name: 'id'
@@ -1459,7 +1459,7 @@ paths:
get:
tags:
- 'Contactgegevens'
- description: Ophalen van Contactgegevens
+ summary: Ophalen van Contactgegevens
operationId: listContactgegevens
parameters:
- name: params
@@ -1509,7 +1509,7 @@ paths:
post:
tags:
- 'Contactgegevens'
- description: Voegt een nieuw(e) Contactgegeven toe.
+ summary: Voegt een nieuw(e) Contactgegeven toe.
operationId: createContactgegeven
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1549,7 +1549,7 @@ paths:
put:
tags:
- 'Contactgegevens'
- description: |
+ summary: |
Vervangen van een Contactgegeven op basis van overeenkomstige sleutelvelden.
operationId: replaceContactgegeven
parameters:
@@ -1584,7 +1584,7 @@ paths:
patch:
tags:
- 'Contactgegevens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Contactgegeven. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateContactgegeven
@@ -1621,7 +1621,7 @@ paths:
get:
tags:
- 'Contactgegevens'
- description: Retourneert een Contactgegeven met de gegeven identifier
+ summary: Retourneert een Contactgegeven met de gegeven identifier
operationId: readContactgegevenById
parameters:
- name: id
@@ -1658,7 +1658,7 @@ paths:
put:
tags:
- 'Contactgegevens'
- description: Vervangen van een Contactgegeven
+ summary: Vervangen van een Contactgegeven
operationId: replaceContactgegevenById
parameters:
- name: 'id'
@@ -1696,7 +1696,7 @@ paths:
patch:
tags:
- 'Contactgegevens'
- description: Wijzigen van een Contactgegeven
+ summary: Wijzigen van een Contactgegeven
operationId: updateContactgegevenById
parameters:
- name: 'id'
@@ -1735,7 +1735,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Ophalen van Contactmomenten
+ summary: Ophalen van Contactmomenten
operationId: listContactmomenten
parameters:
- name: params
@@ -1785,7 +1785,7 @@ paths:
post:
tags:
- 'Contactmomenten'
- description: Voegt een nieuw(e) Contactmoment toe.
+ summary: Voegt een nieuw(e) Contactmoment toe.
operationId: createContactmoment
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1825,7 +1825,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Vervangen van een Contactmoment op basis van overeenkomstige sleutelvelden.
operationId: replaceContactmoment
parameters:
@@ -1860,7 +1860,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Contactmoment. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateContactmoment
@@ -1897,7 +1897,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Retourneert een Contactmoment met de gegeven identifier
+ summary: Retourneert een Contactmoment met de gegeven identifier
operationId: readContactmomentById
parameters:
- name: id
@@ -1934,7 +1934,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: Vervangen van een Contactmoment
+ summary: Vervangen van een Contactmoment
operationId: replaceContactmomentById
parameters:
- name: 'id'
@@ -1972,7 +1972,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: Wijzigen van een Contactmoment
+ summary: Wijzigen van een Contactmoment
operationId: updateContactmomentById
parameters:
- name: 'id'
@@ -2011,7 +2011,7 @@ paths:
get:
tags:
- 'Inkomens'
- description: Ophalen van Inkomens
+ summary: Ophalen van Inkomens
operationId: listInkomens
parameters:
- name: params
@@ -2061,7 +2061,7 @@ paths:
post:
tags:
- 'Inkomens'
- description: Voegt een nieuw(e) Inkomen toe.
+ summary: Voegt een nieuw(e) Inkomen toe.
operationId: createInkomen
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2101,7 +2101,7 @@ paths:
put:
tags:
- 'Inkomens'
- description: |
+ summary: |
Vervangen van een Inkomen op basis van overeenkomstige sleutelvelden.
operationId: replaceInkomen
parameters:
@@ -2136,7 +2136,7 @@ paths:
patch:
tags:
- 'Inkomens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkomen. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkomen
@@ -2173,7 +2173,7 @@ paths:
get:
tags:
- 'Inkomens'
- description: Retourneert een Inkomen met de gegeven identifier
+ summary: Retourneert een Inkomen met de gegeven identifier
operationId: readInkomenById
parameters:
- name: id
@@ -2210,7 +2210,7 @@ paths:
put:
tags:
- 'Inkomens'
- description: Vervangen van een Inkomen
+ summary: Vervangen van een Inkomen
operationId: replaceInkomenById
parameters:
- name: 'id'
@@ -2248,7 +2248,7 @@ paths:
patch:
tags:
- 'Inkomens'
- description: Wijzigen van een Inkomen
+ summary: Wijzigen van een Inkomen
operationId: updateInkomenById
parameters:
- name: 'id'
@@ -2287,7 +2287,7 @@ paths:
get:
tags:
- 'NatuurlijkPersonen'
- description: Ophalen van NatuurlijkPersonen
+ summary: Ophalen van NatuurlijkPersonen
operationId: listNatuurlijkPersonen
parameters:
- name: params
@@ -2337,7 +2337,7 @@ paths:
post:
tags:
- 'NatuurlijkPersonen'
- description: Voegt een nieuw(e) NatuurlijkPersoon toe.
+ summary: Voegt een nieuw(e) NatuurlijkPersoon toe.
operationId: createNatuurlijkPersoon
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2377,7 +2377,7 @@ paths:
put:
tags:
- 'NatuurlijkPersonen'
- description: |
+ summary: |
Vervangen van een NatuurlijkPersoon op basis van overeenkomstige sleutelvelden.
operationId: replaceNatuurlijkPersoon
parameters:
@@ -2412,7 +2412,7 @@ paths:
patch:
tags:
- 'NatuurlijkPersonen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een NatuurlijkPersoon. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateNatuurlijkPersoon
@@ -2449,7 +2449,7 @@ paths:
get:
tags:
- 'NatuurlijkPersonen'
- description: Retourneert een NatuurlijkPersoon met de gegeven identifier
+ summary: Retourneert een NatuurlijkPersoon met de gegeven identifier
operationId: readNatuurlijkPersoonById
parameters:
- name: id
@@ -2486,7 +2486,7 @@ paths:
put:
tags:
- 'NatuurlijkPersonen'
- description: Vervangen van een NatuurlijkPersoon
+ summary: Vervangen van een NatuurlijkPersoon
operationId: replaceNatuurlijkPersoonById
parameters:
- name: 'id'
@@ -2524,7 +2524,7 @@ paths:
patch:
tags:
- 'NatuurlijkPersonen'
- description: Wijzigen van een NatuurlijkPersoon
+ summary: Wijzigen van een NatuurlijkPersoon
operationId: updateNatuurlijkPersoonById
parameters:
- name: 'id'
@@ -2563,7 +2563,7 @@ paths:
get:
tags:
- 'Onderhoudsleveranciers'
- description: Ophalen van Onderhoudsleveranciers
+ summary: Ophalen van Onderhoudsleveranciers
operationId: listOnderhoudsleveranciers
parameters:
- name: params
@@ -2613,7 +2613,7 @@ paths:
post:
tags:
- 'Onderhoudsleveranciers'
- description: Voegt een nieuw(e) Onderhoudsleverancier toe.
+ summary: Voegt een nieuw(e) Onderhoudsleverancier toe.
operationId: createOnderhoudsleverancier
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2653,7 +2653,7 @@ paths:
put:
tags:
- 'Onderhoudsleveranciers'
- description: |
+ summary: |
Vervangen van een Onderhoudsleverancier op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsleverancier
parameters:
@@ -2688,7 +2688,7 @@ paths:
patch:
tags:
- 'Onderhoudsleveranciers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsleverancier. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsleverancier
@@ -2725,7 +2725,7 @@ paths:
get:
tags:
- 'Onderhoudsleveranciers'
- description: Retourneert een Onderhoudsleverancier met de gegeven identifier
+ summary: Retourneert een Onderhoudsleverancier met de gegeven identifier
operationId: readOnderhoudsleverancierById
parameters:
- name: id
@@ -2762,7 +2762,7 @@ paths:
put:
tags:
- 'Onderhoudsleveranciers'
- description: Vervangen van een Onderhoudsleverancier
+ summary: Vervangen van een Onderhoudsleverancier
operationId: replaceOnderhoudsleverancierById
parameters:
- name: 'id'
@@ -2800,7 +2800,7 @@ paths:
patch:
tags:
- 'Onderhoudsleveranciers'
- description: Wijzigen van een Onderhoudsleverancier
+ summary: Wijzigen van een Onderhoudsleverancier
operationId: updateOnderhoudsleverancierById
parameters:
- name: 'id'
@@ -2839,7 +2839,7 @@ paths:
get:
tags:
- 'Opleidingen'
- description: Ophalen van Opleidingen
+ summary: Ophalen van Opleidingen
operationId: listOpleidingen
parameters:
- name: params
@@ -2889,7 +2889,7 @@ paths:
post:
tags:
- 'Opleidingen'
- description: Voegt een nieuw(e) Opleiding toe.
+ summary: Voegt een nieuw(e) Opleiding toe.
operationId: createOpleiding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2929,7 +2929,7 @@ paths:
put:
tags:
- 'Opleidingen'
- description: |
+ summary: |
Vervangen van een Opleiding op basis van overeenkomstige sleutelvelden.
operationId: replaceOpleiding
parameters:
@@ -2964,7 +2964,7 @@ paths:
patch:
tags:
- 'Opleidingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Opleiding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOpleiding
@@ -3001,7 +3001,7 @@ paths:
get:
tags:
- 'Opleidingen'
- description: Retourneert een Opleiding met de gegeven identifier
+ summary: Retourneert een Opleiding met de gegeven identifier
operationId: readOpleidingById
parameters:
- name: id
@@ -3038,7 +3038,7 @@ paths:
put:
tags:
- 'Opleidingen'
- description: Vervangen van een Opleiding
+ summary: Vervangen van een Opleiding
operationId: replaceOpleidingById
parameters:
- name: 'id'
@@ -3076,7 +3076,7 @@ paths:
patch:
tags:
- 'Opleidingen'
- description: Wijzigen van een Opleiding
+ summary: Wijzigen van een Opleiding
operationId: updateOpleidingById
parameters:
- name: 'id'
@@ -3115,7 +3115,7 @@ paths:
get:
tags:
- 'Rechtspersonen'
- description: Ophalen van Rechtspersonen
+ summary: Ophalen van Rechtspersonen
operationId: listRechtspersonen
parameters:
- name: params
@@ -3165,7 +3165,7 @@ paths:
post:
tags:
- 'Rechtspersonen'
- description: Voegt een nieuw(e) Rechtspersoon toe.
+ summary: Voegt een nieuw(e) Rechtspersoon toe.
operationId: createRechtspersoon
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3205,7 +3205,7 @@ paths:
put:
tags:
- 'Rechtspersonen'
- description: |
+ summary: |
Vervangen van een Rechtspersoon op basis van overeenkomstige sleutelvelden.
operationId: replaceRechtspersoon
parameters:
@@ -3240,7 +3240,7 @@ paths:
patch:
tags:
- 'Rechtspersonen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Rechtspersoon. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRechtspersoon
@@ -3277,7 +3277,7 @@ paths:
get:
tags:
- 'Rechtspersonen'
- description: Retourneert een Rechtspersoon met de gegeven identifier
+ summary: Retourneert een Rechtspersoon met de gegeven identifier
operationId: readRechtspersoonById
parameters:
- name: id
@@ -3314,7 +3314,7 @@ paths:
put:
tags:
- 'Rechtspersonen'
- description: Vervangen van een Rechtspersoon
+ summary: Vervangen van een Rechtspersoon
operationId: replaceRechtspersoonById
parameters:
- name: 'id'
@@ -3352,7 +3352,7 @@ paths:
patch:
tags:
- 'Rechtspersonen'
- description: Wijzigen van een Rechtspersoon
+ summary: Wijzigen van een Rechtspersoon
operationId: updateRechtspersoonById
parameters:
- name: 'id'
@@ -3391,7 +3391,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Ophalen van Relaties
+ summary: Ophalen van Relaties
operationId: listRelaties
parameters:
- name: params
@@ -3441,7 +3441,7 @@ paths:
post:
tags:
- 'Relaties'
- description: Voegt een nieuw(e) Relatie toe.
+ summary: Voegt een nieuw(e) Relatie toe.
operationId: createRelatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3481,7 +3481,7 @@ paths:
put:
tags:
- 'Relaties'
- description: |
+ summary: |
Vervangen van een Relatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatie
parameters:
@@ -3516,7 +3516,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatie
@@ -3553,7 +3553,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Retourneert een Relatie met de gegeven identifier
+ summary: Retourneert een Relatie met de gegeven identifier
operationId: readRelatieById
parameters:
- name: id
@@ -3590,7 +3590,7 @@ paths:
put:
tags:
- 'Relaties'
- description: Vervangen van een Relatie
+ summary: Vervangen van een Relatie
operationId: replaceRelatieById
parameters:
- name: 'id'
@@ -3628,7 +3628,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: Wijzigen van een Relatie
+ summary: Wijzigen van een Relatie
operationId: updateRelatieById
parameters:
- name: 'id'
@@ -3667,7 +3667,7 @@ paths:
get:
tags:
- 'RelatieAdressen'
- description: Ophalen van RelatieAdressen
+ summary: Ophalen van RelatieAdressen
operationId: listRelatieAdressen
parameters:
- name: params
@@ -3717,7 +3717,7 @@ paths:
post:
tags:
- 'RelatieAdressen'
- description: Voegt een nieuw(e) RelatieAdres toe.
+ summary: Voegt een nieuw(e) RelatieAdres toe.
operationId: createRelatieAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3757,7 +3757,7 @@ paths:
put:
tags:
- 'RelatieAdressen'
- description: |
+ summary: |
Vervangen van een RelatieAdres op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatieAdres
parameters:
@@ -3792,7 +3792,7 @@ paths:
patch:
tags:
- 'RelatieAdressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een RelatieAdres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatieAdres
@@ -3829,7 +3829,7 @@ paths:
get:
tags:
- 'RelatieAdressen'
- description: Retourneert een RelatieAdres met de gegeven identifier
+ summary: Retourneert een RelatieAdres met de gegeven identifier
operationId: readRelatieAdresById
parameters:
- name: id
@@ -3866,7 +3866,7 @@ paths:
put:
tags:
- 'RelatieAdressen'
- description: Vervangen van een RelatieAdres
+ summary: Vervangen van een RelatieAdres
operationId: replaceRelatieAdresById
parameters:
- name: 'id'
@@ -3904,7 +3904,7 @@ paths:
patch:
tags:
- 'RelatieAdressen'
- description: Wijzigen van een RelatieAdres
+ summary: Wijzigen van een RelatieAdres
operationId: updateRelatieAdresById
parameters:
- name: 'id'
@@ -3943,7 +3943,7 @@ paths:
get:
tags:
- 'Relatiegroepen'
- description: Ophalen van Relatiegroepen
+ summary: Ophalen van Relatiegroepen
operationId: listRelatiegroepen
parameters:
- name: params
@@ -3993,7 +3993,7 @@ paths:
post:
tags:
- 'Relatiegroepen'
- description: Voegt een nieuw(e) Relatiegroep toe.
+ summary: Voegt een nieuw(e) Relatiegroep toe.
operationId: createRelatiegroep
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4033,7 +4033,7 @@ paths:
put:
tags:
- 'Relatiegroepen'
- description: |
+ summary: |
Vervangen van een Relatiegroep op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatiegroep
parameters:
@@ -4068,7 +4068,7 @@ paths:
patch:
tags:
- 'Relatiegroepen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatiegroep. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatiegroep
@@ -4105,7 +4105,7 @@ paths:
get:
tags:
- 'Relatiegroepen'
- description: Retourneert een Relatiegroep met de gegeven identifier
+ summary: Retourneert een Relatiegroep met de gegeven identifier
operationId: readRelatiegroepById
parameters:
- name: id
@@ -4142,7 +4142,7 @@ paths:
put:
tags:
- 'Relatiegroepen'
- description: Vervangen van een Relatiegroep
+ summary: Vervangen van een Relatiegroep
operationId: replaceRelatiegroepById
parameters:
- name: 'id'
@@ -4180,7 +4180,7 @@ paths:
patch:
tags:
- 'Relatiegroepen'
- description: Wijzigen van een Relatiegroep
+ summary: Wijzigen van een Relatiegroep
operationId: updateRelatiegroepById
parameters:
- name: 'id'
@@ -4219,7 +4219,7 @@ paths:
get:
tags:
- 'Relatierollen'
- description: Ophalen van Relatierollen
+ summary: Ophalen van Relatierollen
operationId: listRelatierollen
parameters:
- name: params
@@ -4269,7 +4269,7 @@ paths:
post:
tags:
- 'Relatierollen'
- description: Voegt een nieuw(e) Relatierol toe.
+ summary: Voegt een nieuw(e) Relatierol toe.
operationId: createRelatierol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4309,7 +4309,7 @@ paths:
put:
tags:
- 'Relatierollen'
- description: |
+ summary: |
Vervangen van een Relatierol op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatierol
parameters:
@@ -4344,7 +4344,7 @@ paths:
patch:
tags:
- 'Relatierollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatierol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatierol
@@ -4381,7 +4381,7 @@ paths:
get:
tags:
- 'Relatierollen'
- description: Retourneert een Relatierol met de gegeven identifier
+ summary: Retourneert een Relatierol met de gegeven identifier
operationId: readRelatierolById
parameters:
- name: id
@@ -4418,7 +4418,7 @@ paths:
put:
tags:
- 'Relatierollen'
- description: Vervangen van een Relatierol
+ summary: Vervangen van een Relatierol
operationId: replaceRelatierolById
parameters:
- name: 'id'
@@ -4456,7 +4456,7 @@ paths:
patch:
tags:
- 'Relatierollen'
- description: Wijzigen van een Relatierol
+ summary: Wijzigen van een Relatierol
operationId: updateRelatierolById
parameters:
- name: 'id'
@@ -4495,7 +4495,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Ophalen van Signaleringen
+ summary: Ophalen van Signaleringen
operationId: listSignaleringen
parameters:
- name: params
@@ -4545,7 +4545,7 @@ paths:
post:
tags:
- 'Signaleringen'
- description: Voegt een nieuw(e) Signalering toe.
+ summary: Voegt een nieuw(e) Signalering toe.
operationId: createSignalering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4585,7 +4585,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Vervangen van een Signalering op basis van overeenkomstige sleutelvelden.
operationId: replaceSignalering
parameters:
@@ -4620,7 +4620,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Signalering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSignalering
@@ -4657,7 +4657,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Retourneert een Signalering met de gegeven identifier
+ summary: Retourneert een Signalering met de gegeven identifier
operationId: readSignaleringById
parameters:
- name: id
@@ -4694,7 +4694,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: Vervangen van een Signalering
+ summary: Vervangen van een Signalering
operationId: replaceSignaleringById
parameters:
- name: 'id'
@@ -4732,7 +4732,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: Wijzigen van een Signalering
+ summary: Wijzigen van een Signalering
operationId: updateSignaleringById
parameters:
- name: 'id'
@@ -4771,7 +4771,7 @@ paths:
get:
tags:
- 'Telefoonnummers'
- description: Ophalen van Telefoonnummers
+ summary: Ophalen van Telefoonnummers
operationId: listTelefoonnummers
parameters:
- name: params
@@ -4821,7 +4821,7 @@ paths:
post:
tags:
- 'Telefoonnummers'
- description: Voegt een nieuw(e) Telefoonnummer toe.
+ summary: Voegt een nieuw(e) Telefoonnummer toe.
operationId: createTelefoonnummer
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4861,7 +4861,7 @@ paths:
put:
tags:
- 'Telefoonnummers'
- description: |
+ summary: |
Vervangen van een Telefoonnummer op basis van overeenkomstige sleutelvelden.
operationId: replaceTelefoonnummer
parameters:
@@ -4896,7 +4896,7 @@ paths:
patch:
tags:
- 'Telefoonnummers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Telefoonnummer. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateTelefoonnummer
@@ -4933,7 +4933,7 @@ paths:
get:
tags:
- 'Telefoonnummers'
- description: Retourneert een Telefoonnummer met de gegeven identifier
+ summary: Retourneert een Telefoonnummer met de gegeven identifier
operationId: readTelefoonnummerById
parameters:
- name: id
@@ -4970,7 +4970,7 @@ paths:
put:
tags:
- 'Telefoonnummers'
- description: Vervangen van een Telefoonnummer
+ summary: Vervangen van een Telefoonnummer
operationId: replaceTelefoonnummerById
parameters:
- name: 'id'
@@ -5008,7 +5008,7 @@ paths:
patch:
tags:
- 'Telefoonnummers'
- description: Wijzigen van een Telefoonnummer
+ summary: Wijzigen van een Telefoonnummer
operationId: updateTelefoonnummerById
parameters:
- name: 'id'
@@ -5047,7 +5047,7 @@ paths:
get:
tags:
- 'Woonsituaties'
- description: Ophalen van Woonsituaties
+ summary: Ophalen van Woonsituaties
operationId: listWoonsituaties
parameters:
- name: params
@@ -5097,7 +5097,7 @@ paths:
post:
tags:
- 'Woonsituaties'
- description: Voegt een nieuw(e) Woonsituatie toe.
+ summary: Voegt een nieuw(e) Woonsituatie toe.
operationId: createWoonsituatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5137,7 +5137,7 @@ paths:
put:
tags:
- 'Woonsituaties'
- description: |
+ summary: |
Vervangen van een Woonsituatie op basis van overeenkomstige sleutelvelden.
operationId: replaceWoonsituatie
parameters:
@@ -5172,7 +5172,7 @@ paths:
patch:
tags:
- 'Woonsituaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Woonsituatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoonsituatie
@@ -5209,7 +5209,7 @@ paths:
get:
tags:
- 'Woonsituaties'
- description: Retourneert een Woonsituatie met de gegeven identifier
+ summary: Retourneert een Woonsituatie met de gegeven identifier
operationId: readWoonsituatieById
parameters:
- name: id
@@ -5246,7 +5246,7 @@ paths:
put:
tags:
- 'Woonsituaties'
- description: Vervangen van een Woonsituatie
+ summary: Vervangen van een Woonsituatie
operationId: replaceWoonsituatieById
parameters:
- name: 'id'
@@ -5284,7 +5284,7 @@ paths:
patch:
tags:
- 'Woonsituaties'
- description: Wijzigen van een Woonsituatie
+ summary: Wijzigen van een Woonsituatie
operationId: updateWoonsituatieById
parameters:
- name: 'id'
@@ -5356,10 +5356,54 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Relaties.All.Read: alleen lezen van alle resources
+ Relaties.All.ReadWrite: lezen en schrijven van alle resources
+ Relaties.Accounts.Read: alleen lezen van Accounts
+ Relaties.Accounts.ReadWrite: lezen en schrijven van Accounts
+ Relaties.Afspraken.Read: alleen lezen van Afspraken
+ Relaties.Afspraken.ReadWrite: lezen en schrijven van Afspraken
+ Relaties.AfspraakOpties.Read: alleen lezen van AfspraakOpties
+ Relaties.AfspraakOpties.ReadWrite: lezen en schrijven van AfspraakOpties
+ Relaties.Afspraakverzoeken.Read: alleen lezen van Afspraakverzoeken
+ Relaties.Afspraakverzoeken.ReadWrite: lezen en schrijven van Afspraakverzoeken
+ Relaties.Betaalgegevens.Read: alleen lezen van Betaalgegevens
+ Relaties.Betaalgegevens.ReadWrite: lezen en schrijven van Betaalgegevens
+ Relaties.Contactgegevens.Read: alleen lezen van Contactgegevens
+ Relaties.Contactgegevens.ReadWrite: lezen en schrijven van Contactgegevens
+ Relaties.Contactmomenten.Read: alleen lezen van Contactmomenten
+ Relaties.Contactmomenten.ReadWrite: lezen en schrijven van Contactmomenten
+ Relaties.Inkomens.Read: alleen lezen van Inkomens
+ Relaties.Inkomens.ReadWrite: lezen en schrijven van Inkomens
+ Relaties.NatuurlijkPersonen.Read: alleen lezen van NatuurlijkPersonen
+ Relaties.NatuurlijkPersonen.ReadWrite: lezen en schrijven van NatuurlijkPersonen
+ Relaties.Onderhoudsleveranciers.Read: alleen lezen van Onderhoudsleveranciers
+ Relaties.Onderhoudsleveranciers.ReadWrite: lezen en schrijven van Onderhoudsleveranciers
+ Relaties.Opleidingen.Read: alleen lezen van Opleidingen
+ Relaties.Opleidingen.ReadWrite: lezen en schrijven van Opleidingen
+ Relaties.Rechtspersonen.Read: alleen lezen van Rechtspersonen
+ Relaties.Rechtspersonen.ReadWrite: lezen en schrijven van Rechtspersonen
+ Relaties.Relaties.Read: alleen lezen van Relaties
+ Relaties.Relaties.ReadWrite: lezen en schrijven van Relaties
+ Relaties.RelatieAdressen.Read: alleen lezen van RelatieAdressen
+ Relaties.RelatieAdressen.ReadWrite: lezen en schrijven van RelatieAdressen
+ Relaties.Relatiegroepen.Read: alleen lezen van Relatiegroepen
+ Relaties.Relatiegroepen.ReadWrite: lezen en schrijven van Relatiegroepen
+ Relaties.Relatierollen.Read: alleen lezen van Relatierollen
+ Relaties.Relatierollen.ReadWrite: lezen en schrijven van Relatierollen
+ Relaties.Signaleringen.Read: alleen lezen van Signaleringen
+ Relaties.Signaleringen.ReadWrite: lezen en schrijven van Signaleringen
+ Relaties.Telefoonnummers.Read: alleen lezen van Telefoonnummers
+ Relaties.Telefoonnummers.ReadWrite: lezen en schrijven van Telefoonnummers
+ Relaties.Woonsituaties.Read: alleen lezen van Woonsituaties
+ Relaties.Woonsituaties.ReadWrite: lezen en schrijven van Woonsituaties
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Relaties.All.Read: alleen lezen van alle resources
Relaties.All.ReadWrite: lezen en schrijven van alle resources
@@ -5450,7 +5494,7 @@ components:
description: De gebruikersnaam van de registratie.
relatie:
allOf:
- - $ref: '#/components/schemas/Relatie'
+ - $ref: '#/components/schemas/Relatie-sleutels'
description: De relatie behorend bij de registratie.
wachtwoorddatum:
type: string
@@ -5482,7 +5526,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -5494,7 +5538,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -5530,7 +5574,7 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Relatie-basis:
+ Relatie-sleutels:
type: object
properties:
id:
@@ -5557,137 +5601,6 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de relatie, bijv. In het geval van een VVE kan deze de status slapend of actief hebben. Referentiedatasoort RELATIESTATUS.
- adressen:
- description: De adressen behorend bij de relatie.
- type: array
- items:
- $ref: '#/components/schemas/RelatieAdres'
- afspraken:
- description: De afspraken behorend bij de relatie.
- type: array
- items:
- $ref: '#/components/schemas/Afspraak'
- betaalgegevens:
- description: De betaalgegevens behorend bij de relatie. Bijvoorbeeld het rekeningnummer.
- type: array
- items:
- $ref: '#/components/schemas/Betaalgegeven'
- communicatievoorkeur:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het communicatiekanaal waarop de relatie bij voorkeur benaderd wil worden. Bijvoorbeeld: Telefoon, E-mail, Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
- contactgegevens:
- description: De contactgegevens van de relatie.
- type: array
- items:
- $ref: '#/components/schemas/Contactgegeven'
- contactmomenten:
- description: De contactmomenten behorend bij de relatie.
- type: array
- items:
- $ref: '#/components/schemas/Contactmoment'
- groepen:
- description: De relatiegroepen waar de relatie toe behoort.
- type: array
- items:
- $ref: '#/components/schemas/Relatiegroep'
- inspecties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Inspectie in informatiedomein Overeenkomsten
- onderhoudsverzoeken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- rollen:
- description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
- type: array
- items:
- $ref: '#/components/schemas/Relatierol'
- RelatieAdresbericht:
- allOf:
- - $ref: '#/components/schemas/RelatieAdres'
- - $ref: '#/components/schemas/Bericht-basis'
- RelatieAdres:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort adres van de relatie. Bijvoorbeeld: Woonadres, postadres, bezoekadres en factuuradres. Referentiedatasoort RELATIEADRESSOORT.'
- begindatum:
- type: string
- format: date
- description: De begindatum waarop de relatie bij het adres hoort.
- einddatum:
- type: string
- format: date
- description: De einddatum waarop de relatie niet meer bij het adres hoort.
- adres:
- type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie behorend bij het adres.
- Relatie-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -5712,15 +5625,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Relatiebericht:
- allOf:
- - $ref: '#/components/schemas/Relatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Relatie:
- oneOf:
- - $ref: '#/components/schemas/NatuurlijkPersoon'
- - $ref: '#/components/schemas/Rechtspersoon'
- - $ref: '#/components/schemas/Relatiegroep'
Afspraakbericht:
allOf:
- $ref: '#/components/schemas/Afspraak'
@@ -5774,18 +5678,18 @@ components:
description: Tekstveld waarin contactgegevens van een alternatieve contactpersoon opgenomen kunnen worden. Voorbeeld is het verzoek van een huurder (student) waarbij hij aangeeft contact op te nemen met zijn ouders voor de afhandeling van het verzoek.
contactgegeven:
allOf:
- - $ref: '#/components/schemas/Contactgegeven'
+ - $ref: '#/components/schemas/Contactgegeven-sleutels'
description: Het contactgegeven van de relatie welke van toepassing is voor de afspraak.
locatie:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
relaties:
description: De relatie waarmee de afspraak is gemaakt. Bijv. de huurder, medewerker etc.
type: array
items:
$ref: '#/components/schemas/Relatie-sleutels'
- Contactgegeven-basis:
+ Contactgegeven-sleutels:
type: object
properties:
id:
@@ -5808,43 +5712,15 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
- omschrijving:
- type: string
- format: any
- description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie behorend bij het contactgegeven.
- relatierol:
- allOf:
- - $ref: '#/components/schemas/Relatierol'
- description: De relatie rol van de relatie behorend bij het contactgegeven.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
- voorkeur:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
- waarde:
- type: string
- format: any
- description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
- Relatierolbericht:
+ AfspraakOptiebericht:
allOf:
- - $ref: '#/components/schemas/Relatierol'
+ - $ref: '#/components/schemas/AfspraakOptie'
- $ref: '#/components/schemas/Bericht-basis'
- Relatierol:
+ AfspraakOptie:
type: object
properties:
id:
@@ -5863,50 +5739,59 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort rol van de relatie. Bijvoorbeeld Klant, Prospect, Leverancier, Medewerker, Team etc. Referentiedatasoort RELATIEROLSOORT.
- naam:
- type: string
- format: any
- description: De naam van de relatie rol.
- omschrijving:
+ begindatum:
type: string
- format: any
- description: De omschrijving van de relatie rol.
- begindatum:
- type: string
- format: date
- description: begindatum van de rol
+ format: date-time
+ description: De datum en tijd waarop de afspraak plaatsvindt.
einddatum:
type: string
- format: date
- description: einddatum van de rol
- contactgegevens:
- description: De contactgegevens van een relatie in een bepaalde rol.
- type: array
- items:
- $ref: '#/components/schemas/Contactgegeven-sleutels'
- contactmomenten:
- description: De contactmomenten die de relatie vanuit een rol heeft.
- type: array
- items:
- $ref: '#/components/schemas/Contactmoment'
- relatie:
+ format: date-time
+ description: De datum en tijd tot wanneer de afspraak loopt.
+ bloktijdBegin:
+ type: string
+ format: date-time
+ description: De datum en tijd die het begin van een blok markeert waarbinnen de afspraak bij voorkeur start. Pas als de afspraak daadwerkelijk ingepland is, is er ook een afspraak begindatum bekend.
+ bloktijdEind:
+ type: string
+ format: date-time
+ description: De datum en tijd die het eind van een blok markeert waarbinnen de afspraak bij voorkeur start.
+ afspraak:
allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie waarvoor de rol van toepassing is.
- relatieAdressen:
- description: De adresssen van de relatie die voor de rol van toepassing zijn
+ - $ref: '#/components/schemas/Afspraak-sleutels'
+ duur:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: De verwachte duur van de afspraak die gemaakt moet worden.
+ locatie:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ onderhoudsorder:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudsorder-sleutels in informatiedomein Onderhoud
+ onderhoudstaak:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudstaak-sleutels in informatiedomein Onderhoud
+ onderhoudsverzoek:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ planningscore:
+ type: number
+ format: float
+ relaties:
+ description: De relaties waarvoor de afspraak optie van toepassing is.
type: array
items:
- $ref: '#/components/schemas/RelatieAdres'
- rolRelatie:
+ $ref: '#/components/schemas/Relatie-sleutels'
+ specialisme:
allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie die aangeeft waar de relatie en rol koppeling van toepassing is. Dit attribuut geeft aan dat de aangegeven relatie de rol binnen bijvoorbeeld een relatiegroep heeft. Het attribuut relatie is dan bijvoorbeeld een persoon uit een huishouden en de rolRelatie is dan bijvoorbeeld de relatiegroep die het huishouden voorstelt.
- Contactgegeven-sleutels:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Referentiedatasoort ONDERHOUDSPECIALISME.
+ Afspraak-sleutels:
type: object
properties:
id:
@@ -5925,27 +5810,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc.
- Contactgegevenbericht:
- allOf:
- - $ref: '#/components/schemas/Contactgegeven'
- - $ref: '#/components/schemas/Bericht-basis'
- Contactgegeven:
- oneOf:
- - $ref: '#/components/schemas/Telefoonnummer'
- - $ref: '#/components/schemas/Contactgegeven-basis'
- Contactmomentbericht:
+ Afspraakverzoekbericht:
allOf:
- - $ref: '#/components/schemas/Contactmoment'
+ - $ref: '#/components/schemas/Afspraakverzoek'
- $ref: '#/components/schemas/Bericht-basis'
- Contactmoment:
+ Afspraakverzoek:
type: object
properties:
id:
@@ -5963,44 +5832,58 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
- type: string
- format: any
- description: De omschrijving van het contactmoment
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort detail van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTDETAILSOORT.
- datum:
+ description: 'Soort van de afspraak: bijvoorbeeld voorinspectie. Referentiedatasoort AFSPRAAKVERZOEKSOORT.'
+ duur:
type: string
- format: date-time
- description: De datum en tijd waarop contact is geweest.
- dossier:
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: Duur van de afspraak.
+ termijn:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: Termijn waarbinnende afspraak moet plaatsvinden.
+ adres:
type: string
format: uri
- description: Referentie naar Dossier in informatiedomein Dossier
- kanaal:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het kanaal via welke het contact heeft gelopen. Bijvoorbeeld: Telefoon, email, balie, internet. Referentiedatasoort COMMUNICATIEKANAAL.'
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ opties:
+ description: De mogelijke momenten waarop de afspraak kan worden gemaakt.
+ type: array
+ items:
+ $ref: '#/components/schemas/AfspraakOptie-sleutels'
relaties:
- description: De relatie waarmee contact is geweest. Bijv. een huurder, medewerker etc.
+ description: De betrokken relaties voor de te maken afspraak. Bijv. de huurder, medewerker etc.
type: array
items:
$ref: '#/components/schemas/Relatie-sleutels'
- richting:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De communicatierichting behorend bij het contact. Bijvoorbeeld: Uitgaand of ingaand. Referentiedatasoort COMMUNICATIERICHTING.'
- zaak:
+ volgorde:
+ type: integer
+ format: int32
+ description: De volgorde waarin de specifieke afspraak dient te worden uitgevoerd ten opzichte van andere afspraakverzoeken.
+ AfspraakOptie-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: uri
- description: Referentie naar Zaak in informatiedomein Dossier
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Betaalgegevenbericht:
allOf:
- $ref: '#/components/schemas/Betaalgegeven'
@@ -6049,7 +5932,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Incassomachtiging in informatiedomein Financien
+ description: Referenties naar Incassomachtiging-sleutels in informatiedomein Financien
incassowijze:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -6058,7 +5941,7 @@ components:
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
primair:
type: boolean
description: De aanduiding dat het betaalgegeven het primaire betaalgegeven betreft.
@@ -6073,33 +5956,79 @@ components:
rekeningPlaats:
type: string
format: uri
- description: Referentie naar Woonplaats in informatiedomein Vastgoed
+ description: Referentie naar Woonplaats-sleutels in informatiedomein Vastgoed
relatie:
allOf:
- $ref: '#/components/schemas/Relatie-sleutels'
description: De relatie behorend bij het betaalgegeven.
- Relatiegroepbericht:
+ Contactgegeven-basis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij het contactgegeven.
+ relatierol:
+ allOf:
+ - $ref: '#/components/schemas/Relatierol-sleutels'
+ description: De relatie rol van de relatie behorend bij het contactgegeven.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
+ voorkeur:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
+ waarde:
+ type: string
+ format: any
+ description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
+ Contactgegevenbericht:
allOf:
- - $ref: '#/components/schemas/Relatiegroep'
+ - $ref: '#/components/schemas/Contactgegeven'
- $ref: '#/components/schemas/Bericht-basis'
- Relatiegroep:
- allOf:
- - $ref: '#/components/schemas/Relatie-basis'
- - type: object
- properties:
- naam:
- type: string
- format: any
- description: De naam van de relatiegroep.
- relaties:
- type: array
- items:
- $ref: '#/components/schemas/Relatie-sleutels'
- AfspraakOptiebericht:
+ Contactgegeven:
+ oneOf:
+ - $ref: '#/components/schemas/Telefoonnummer'
+ - $ref: '#/components/schemas/Contactgegeven-basis'
+ Contactmomentbericht:
allOf:
- - $ref: '#/components/schemas/AfspraakOptie'
+ - $ref: '#/components/schemas/Contactmoment'
- $ref: '#/components/schemas/Bericht-basis'
- AfspraakOptie:
+ Contactmoment:
type: object
properties:
id:
@@ -6118,113 +6047,43 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date-time
- description: De datum en tijd waarop de afspraak plaatsvindt.
- einddatum:
+ omschrijving:
type: string
- format: date-time
- description: De datum en tijd tot wanneer de afspraak loopt.
- bloktijdBegin:
+ format: any
+ description: De omschrijving van het contactmoment
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort detail van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTDETAILSOORT.
+ datum:
type: string
format: date-time
- description: De datum en tijd die het begin van een blok markeert waarbinnen de afspraak bij voorkeur start. Pas als de afspraak daadwerkelijk ingepland is, is er ook een afspraak begindatum bekend.
- bloktijdEind:
- type: string
- format: date-time
- description: De datum en tijd die het eind van een blok markeert waarbinnen de afspraak bij voorkeur start.
- afspraak:
- allOf:
- - $ref: '#/components/schemas/Afspraak'
- duur:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: De verwachte duur van de afspraak die gemaakt moet worden.
- locatie:
- type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- onderhoudsorder:
- type: string
- format: uri
- description: Referentie naar Onderhoudsorder in informatiedomein Onderhoud
- onderhoudstaak:
- type: string
- format: uri
- description: Referentie naar Onderhoudstaak in informatiedomein Onderhoud
- onderhoudsverzoek:
+ description: De datum en tijd waarop contact is geweest.
+ dossier:
type: string
format: uri
- description: Referentie naar Onderhoudsverzoek in informatiedomein Onderhoud
- planningscore:
- type: number
- format: float
+ description: Referentie naar Dossier-sleutels in informatiedomein Dossier
+ kanaal:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het kanaal via welke het contact heeft gelopen. Bijvoorbeeld: Telefoon, email, balie, internet. Referentiedatasoort COMMUNICATIEKANAAL.'
relaties:
- description: De relaties waarvoor de afspraak optie van toepassing is.
+ description: De relatie waarmee contact is geweest. Bijv. een huurder, medewerker etc.
type: array
items:
- $ref: '#/components/schemas/Relatie'
- specialisme:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Referentiedatasoort ONDERHOUDSPECIALISME.
- Afspraakverzoekbericht:
- allOf:
- - $ref: '#/components/schemas/Afspraakverzoek'
- - $ref: '#/components/schemas/Bericht-basis'
- Afspraakverzoek:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
+ $ref: '#/components/schemas/Relatie-sleutels'
+ richting:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Soort van de afspraak: bijvoorbeeld voorinspectie. Referentiedatasoort AFSPRAAKVERZOEKSOORT.'
- duur:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: Duur van de afspraak.
- termijn:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: Termijn waarbinnende afspraak moet plaatsvinden.
- adres:
+ description: 'De communicatierichting behorend bij het contact. Bijvoorbeeld: Uitgaand of ingaand. Referentiedatasoort COMMUNICATIERICHTING.'
+ zaak:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- opties:
- description: De mogelijke momenten waarop de afspraak kan worden gemaakt.
- type: array
- items:
- $ref: '#/components/schemas/AfspraakOptie'
- relaties:
- description: De betrokken relaties voor de te maken afspraak. Bijv. de huurder, medewerker etc.
- type: array
- items:
- $ref: '#/components/schemas/Relatie'
- volgorde:
- type: integer
- format: int32
- description: De volgorde waarin de specifieke afspraak dient te worden uitgevoerd ten opzichte van andere afspraakverzoeken.
+ description: Referentie naar Zaak-sleutels in informatiedomein Dossier
Inkomenbericht:
allOf:
- $ref: '#/components/schemas/Inkomen'
@@ -6248,10 +6107,22 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort inkomen. Bijv. netto of bruto maand of jaarinkomen. Referentiedatasoort INKOMENSSOORT.
controledatum:
type: string
format: date-time
description: De datum en tijd waarop de inkomensgegevens zijn gecontroleerd.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
+ bedrag:
+ type: number
+ format: float
+ description: Het bedrag van het inkomen.
bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -6259,28 +6130,36 @@ components:
brutoJaarinkomen:
type: number
format: float
- description: Het bruto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
brutoMaandinkomen:
type: number
format: float
- description: Het bruto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
inkomensverklaringsoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het soort inkomensverklaring waaruit het inkomen is overgenomen. Bijv. Jaaropgave, Inkomensverklaring belastingdienst etc. Referentiedatasoort INKOMENSVERKLARINGSOORT.
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor het inkomen geldig is.
nettoJaarinkomen:
type: number
format: float
- description: Het netto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het netto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
nettoMaandinkomen:
type: number
format: float
- description: Het netto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het netto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
relaties:
- description: sleutels
+ description: De relaties behorend bij het inkomen. Bijv. de woningzoekende, huurder, controleur etc.
type: array
items:
- $ref: '#/components/schemas/Relatie'
+ $ref: '#/components/schemas/Relatie-sleutels'
NatuurlijkPersoonbericht:
allOf:
- $ref: '#/components/schemas/NatuurlijkPersoon'
@@ -6307,7 +6186,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Aanbieding in informatiedomein Woonruimteverdeling
+ description: Referenties naar Aanbieding-sleutels in informatiedomein Woonruimteverdeling
aanhef:
type: string
format: any
@@ -6336,33 +6215,33 @@ components:
description: De inkomens van de natuurlijk persoon.
type: array
items:
- $ref: '#/components/schemas/Inkomen'
+ $ref: '#/components/schemas/Inkomen-sleutels'
nationaliteit:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: De nationaliteit van de natuurlijk persoon. Referentiedatasoort NATIONALITEIT.
opleiding:
allOf:
- - $ref: '#/components/schemas/Opleiding'
+ - $ref: '#/components/schemas/Opleiding-sleutels'
description: Het opleidingsgegeven van de natuurlijk persoon. OBSOLETE
deprecated: true
opleidingen:
description: De opleidingsgegevens van de natuurlijk persoon.
type: array
items:
- $ref: '#/components/schemas/Opleiding'
+ $ref: '#/components/schemas/Opleiding-sleutels'
reacties:
type: array
items:
type: string
format: uri
- description: Referenties naar Reactie in informatiedomein Woonruimteverdeling
+ description: Referenties naar Reactie-sleutels in informatiedomein Woonruimteverdeling
regelingen:
type: array
items:
type: string
format: uri
- description: Referenties naar Regeling in informatiedomein Woonruimteverdeling
+ description: Referenties naar Regeling-sleutels in informatiedomein Woonruimteverdeling
roepnaam:
type: string
format: any
@@ -6371,13 +6250,13 @@ components:
description: De signaleringen behorend bij de natuurlijk persoon.
type: array
items:
- $ref: '#/components/schemas/Signalering'
+ $ref: '#/components/schemas/Signalering-sleutels'
toewijzingen:
type: array
items:
type: string
format: uri
- description: Referenties naar Toewijzing in informatiedomein Woonruimteverdeling
+ description: Referenties naar Toewijzing-sleutels in informatiedomein Woonruimteverdeling
tussenvoegsels:
type: string
format: any
@@ -6399,16 +6278,12 @@ components:
items:
type: string
format: uri
- description: Referenties naar Voorrangsregeling in informatiedomein Woonruimteverdeling
+ description: Referenties naar Voorrangsregeling-sleutels in informatiedomein Woonruimteverdeling
woonsituatie:
allOf:
- - $ref: '#/components/schemas/Woonsituatie'
+ - $ref: '#/components/schemas/Woonsituatie-sleutels'
description: De huidige woonsituatie van de woningzoekende. Bevat of iemand starter of doorstromer is en informatie over de huidige huurovereenkomst en woning.
- Opleidingbericht:
- allOf:
- - $ref: '#/components/schemas/Opleiding'
- - $ref: '#/components/schemas/Bericht-basis'
- Opleiding:
+ Inkomen-sleutels:
type: object
properties:
id:
@@ -6427,39 +6302,30 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- studentnummer:
+ Opleiding-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Het studentnummer van de relatie
- begindatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De begindatum waarop de studie is begonnen.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: De einddatum waarop de studie is beëindigd.
- instelling:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De opleidingsinstelling die aangeeft waar de relatie de studie volgt. We hanteren hiervoor de BRIN. Referentiedatasoort OPLEIDINGSINSTELLING.
- niveau:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het hoogst genoten opleidingsniveau van de relatie. Bijvoorbeeld: HBO of Universitair. Referentiedatasoort OPLEIDINGSNIVEAU.'
- plaats:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
format: any
- description: De plaats waar de relatie de studie volgt.
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie'
- description: De relatie die de opleiding volgt.
- Signaleringbericht:
- allOf:
- - $ref: '#/components/schemas/Signalering'
- - $ref: '#/components/schemas/Bericht-basis'
- Signalering:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ studentnummer:
+ type: string
+ format: any
+ description: Het studentnummer van de relatie
+ Signalering-sleutels:
type: object
properties:
id:
@@ -6478,43 +6344,44 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort signaal. Bijvoorbeeld: Huurschuld, overlast of wietplantage. Referentiedatasoort SIGNALERINGSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het reden van het signaal. Referentiedatasoort SIGNALERINGDETAILSOORT.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De status van de signalering. Bijvoorbeeld: Actief, vervallen of passief. Referentiedatasoort SIGNALERINGSTATUS.'
- detailStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De detailstatus van de signalering. Bijvoorbeeld: Ontruiming, vertrokken. Referentiedatasoort SIGNALERINGDETAILSTATUS.'
- begindatum:
+ Woonsituatie-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: date-time
- description: De begindatum van de signalering.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date-time
- description: De einddatum van de signalering.
- adres:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie'
- description: De relatie behorend bij de signalering.
- Woonsituatiebericht:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsleverancierbericht:
allOf:
- - $ref: '#/components/schemas/Woonsituatie'
+ - $ref: '#/components/schemas/Onderhoudsleverancier'
- $ref: '#/components/schemas/Bericht-basis'
- Woonsituatie:
+ Onderhoudsleverancier:
+ allOf:
+ - $ref: '#/components/schemas/Rechtspersoon-basis'
+ - type: object
+ properties:
+ specialismen:
+ description: Het specialismen die de opdrachtnemer kan uitvoeren. Voorbeelden zijn Timmerman, Loodgieter, etc. Referentiedatasoort ONDERHOUDSPECIALISME.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ Opleidingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Opleiding'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Opleiding:
type: object
properties:
id:
@@ -6533,48 +6400,38 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort woonsituatie: Starter, Doorstromer. Referentiedatasoort WOONSITUATIESOORT.'
+ studentnummer:
+ type: string
+ format: any
+ description: Het studentnummer van de relatie
begindatum:
type: string
format: date
- description: De begindatum waarop de woonsituatie is begonnen. Bijvoorbeeld de ingangsdatum van het huidige huur- of koopcontract of de inschrijfdatum op het adres bij het BRP.
+ description: De begindatum waarop de studie is begonnen.
einddatum:
type: string
format: date
- description: De einddatum waarop de woonsituatie is beëindigd.
- eenheid:
- type: string
- format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
- overeenkomst:
+ description: De einddatum waarop de studie is beëindigd.
+ authentiekGegeven:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- relatie:
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
+ instelling:
allOf:
- - $ref: '#/components/schemas/Relatie'
- description: De hoofdaanvrager waartoe de woonsituatie behoort.
- vestiging:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De opleidingsinstelling die aangeeft waar de relatie de studie volgt. We hanteren hiervoor de BRIN. Referentiedatasoort OPLEIDINGSINSTELLING.
+ niveau:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De vestiging die de huidige woning exploiteerd. Referentiedatasoort VESTIGING.
- Onderhoudsleverancierbericht:
- allOf:
- - $ref: '#/components/schemas/Onderhoudsleverancier'
- - $ref: '#/components/schemas/Bericht-basis'
- Onderhoudsleverancier:
- allOf:
- - $ref: '#/components/schemas/Rechtspersoon-basis'
- - type: object
- properties:
- specialismen:
- description: Het specialismen die de opdrachtnemer kan uitvoeren. Voorbeelden zijn Timmerman, Loodgieter, etc. Referentiedatasoort ONDERHOUDSPECIALISME.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
+ description: 'Het hoogst genoten opleidingsniveau van de relatie. Bijvoorbeeld: HBO of Universitair. Referentiedatasoort OPLEIDINGSNIVEAU.'
+ plaats:
+ type: string
+ format: any
+ description: De plaats waar de relatie de studie volgt.
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie die de opleiding volgt.
Rechtspersoon-basis:
allOf:
- $ref: '#/components/schemas/Relatie-basis'
@@ -6604,7 +6461,7 @@ components:
description: De contactpersonen behorend bij de rechtspersoon.
type: array
items:
- $ref: '#/components/schemas/Relatie'
+ $ref: '#/components/schemas/Relatie-sleutels'
Rechtspersoonbericht:
allOf:
- $ref: '#/components/schemas/Rechtspersoon'
@@ -6613,10 +6470,393 @@ components:
allOf:
- $ref: '#/components/schemas/Rechtspersoon-basis'
- type: object
- Telefoonnummerbericht:
- allOf:
- - $ref: '#/components/schemas/Telefoonnummer'
- - $ref: '#/components/schemas/Bericht-basis'
+ Relatie-basis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de relatie, bijv. In het geval van een VVE kan deze de status slapend of actief hebben. Referentiedatasoort RELATIESTATUS.
+ adressen:
+ description: De adressen behorend bij de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/RelatieAdres-sleutels'
+ afspraken:
+ description: De afspraken behorend bij de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Afspraak-sleutels'
+ betaalgegevens:
+ description: De betaalgegevens behorend bij de relatie. Bijvoorbeeld het rekeningnummer.
+ type: array
+ items:
+ $ref: '#/components/schemas/Betaalgegeven-sleutels'
+ communicatievoorkeur:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het communicatiekanaal waarop de relatie bij voorkeur benaderd wil worden. Bijvoorbeeld: Telefoon, E-mail, Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
+ contactgegevens:
+ description: De contactgegevens van de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactgegeven-sleutels'
+ contactmomenten:
+ description: De contactmomenten behorend bij de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactmoment-sleutels'
+ groepen:
+ description: De relatiegroepen waar de relatie toe behoort.
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatiegroep-sleutels'
+ inspecties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Inspectie-sleutels in informatiedomein Overeenkomsten
+ onderhoudsverzoeken:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ RelatieAdres-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort adres van de relatie. Bijvoorbeeld: Woonadres, postadres, bezoekadres en factuuradres. Referentiedatasoort RELATIEADRESSOORT.'
+ Betaalgegeven-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ iban:
+ type: string
+ format: any
+ description: Het International Bank Account Number. Identificeert elke rekeninghouder, inclusief bank en vestigingsland.
+ rekeningnummer:
+ type: string
+ format: any
+ description: Het rekeningnummer.
+ Contactmoment-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
+ Relatiegroep-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ Relatiebericht:
+ allOf:
+ - $ref: '#/components/schemas/Relatie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Relatie:
+ oneOf:
+ - $ref: '#/components/schemas/NatuurlijkPersoon'
+ - $ref: '#/components/schemas/Rechtspersoon'
+ - $ref: '#/components/schemas/Relatiegroep'
+ RelatieAdresbericht:
+ allOf:
+ - $ref: '#/components/schemas/RelatieAdres'
+ - $ref: '#/components/schemas/Bericht-basis'
+ RelatieAdres:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort adres van de relatie. Bijvoorbeeld: Woonadres, postadres, bezoekadres en factuuradres. Referentiedatasoort RELATIEADRESSOORT.'
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum waarop de relatie bij het adres hoort.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum waarop de relatie niet meer bij het adres hoort.
+ adres:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij het adres.
+ Relatiegroepbericht:
+ allOf:
+ - $ref: '#/components/schemas/Relatiegroep'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Relatiegroep:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-basis'
+ - type: object
+ properties:
+ naam:
+ type: string
+ format: any
+ description: De naam van de relatiegroep.
+ relaties:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatie-sleutels'
+ Relatierolbericht:
+ allOf:
+ - $ref: '#/components/schemas/Relatierol'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Relatierol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort rol van de relatie. Bijvoorbeeld Klant, Prospect, Leverancier, Medewerker, Team etc. Referentiedatasoort RELATIEROLSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van de relatie rol.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de relatie rol.
+ begindatum:
+ type: string
+ format: date
+ description: begindatum van de rol
+ einddatum:
+ type: string
+ format: date
+ description: einddatum van de rol
+ contactgegevens:
+ description: De contactgegevens van een relatie in een bepaalde rol.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactgegeven-sleutels'
+ contactmomenten:
+ description: De contactmomenten die de relatie vanuit een rol heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactmoment-sleutels'
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie waarvoor de rol van toepassing is.
+ relatieAdressen:
+ description: De adresssen van de relatie die voor de rol van toepassing zijn
+ type: array
+ items:
+ $ref: '#/components/schemas/RelatieAdres-sleutels'
+ rolRelatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie die aangeeft waar de relatie en rol koppeling van toepassing is. Dit attribuut geeft aan dat de aangegeven relatie de rol binnen bijvoorbeeld een relatiegroep heeft. Het attribuut relatie is dan bijvoorbeeld een persoon uit een huishouden en de rolRelatie is dan bijvoorbeeld de relatiegroep die het huishouden voorstelt.
+ Signaleringbericht:
+ allOf:
+ - $ref: '#/components/schemas/Signalering'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Signalering:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort signaal. Bijvoorbeeld: Huurschuld, overlast of wietplantage. Referentiedatasoort SIGNALERINGSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het reden van het signaal. Referentiedatasoort SIGNALERINGDETAILSOORT.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De status van de signalering. Bijvoorbeeld: Actief, vervallen of passief. Referentiedatasoort SIGNALERINGSTATUS.'
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De detailstatus van de signalering. Bijvoorbeeld: Ontruiming, vertrokken. Referentiedatasoort SIGNALERINGDETAILSTATUS.'
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum van de signalering.
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum van de signalering.
+ adres:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij de signalering.
+ Telefoonnummerbericht:
+ allOf:
+ - $ref: '#/components/schemas/Telefoonnummer'
+ - $ref: '#/components/schemas/Bericht-basis'
Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Contactgegeven-basis'
@@ -6643,6 +6883,61 @@ components:
type: string
format: any
description: Het netnummer van het telefoonnummer.
+ Woonsituatiebericht:
+ allOf:
+ - $ref: '#/components/schemas/Woonsituatie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Woonsituatie:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort woonsituatie: Starter, Doorstromer. Referentiedatasoort WOONSITUATIESOORT.'
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum waarop de woonsituatie is begonnen. Bijvoorbeeld de ingangsdatum van het huidige huur- of koopcontract of de inschrijfdatum op het adres bij het BRP.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum waarop de woonsituatie is beëindigd.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
+ eenheid:
+ type: string
+ format: uri
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De hoofdaanvrager waartoe de woonsituatie behoort.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging die de huidige woning exploiteerd. Referentiedatasoort VESTIGING.
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Vastgoed.yaml b/Informatiedomeinen/Vastgoed.yaml
index bf5d744..f4f755d 100644
--- a/Informatiedomeinen/Vastgoed.yaml
+++ b/Informatiedomeinen/Vastgoed.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://vastgoed.vera.io:{port}/{basePath}
description: Productieserver
@@ -109,7 +109,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -125,7 +125,7 @@ paths:
get:
tags:
- 'Adressen'
- description: Ophalen van Adressen
+ summary: Ophalen van Adressen
operationId: listAdressen
parameters:
- name: params
@@ -175,7 +175,7 @@ paths:
post:
tags:
- 'Adressen'
- description: Voegt een nieuw(e) Adres toe.
+ summary: Voegt een nieuw(e) Adres toe.
operationId: createAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -215,7 +215,7 @@ paths:
put:
tags:
- 'Adressen'
- description: |
+ summary: |
Vervangen van een Adres op basis van overeenkomstige sleutelvelden.
operationId: replaceAdres
parameters:
@@ -250,7 +250,7 @@ paths:
patch:
tags:
- 'Adressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Adres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAdres
@@ -287,7 +287,7 @@ paths:
get:
tags:
- 'Adressen'
- description: Retourneert een Adres met de gegeven identifier
+ summary: Retourneert een Adres met de gegeven identifier
operationId: readAdresById
parameters:
- name: id
@@ -324,7 +324,7 @@ paths:
put:
tags:
- 'Adressen'
- description: Vervangen van een Adres
+ summary: Vervangen van een Adres
operationId: replaceAdresById
parameters:
- name: 'id'
@@ -362,7 +362,7 @@ paths:
patch:
tags:
- 'Adressen'
- description: Wijzigen van een Adres
+ summary: Wijzigen van een Adres
operationId: updateAdresById
parameters:
- name: 'id'
@@ -401,7 +401,7 @@ paths:
get:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Ophalen van AdresseerbareObjectenBasisregistratie
+ summary: Ophalen van AdresseerbareObjectenBasisregistratie
operationId: listAdresseerbareObjectenBasisregistratie
parameters:
- name: params
@@ -451,7 +451,7 @@ paths:
post:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Voegt een nieuw(e) AdresseerbaarObjectBasisregistratie toe.
+ summary: Voegt een nieuw(e) AdresseerbaarObjectBasisregistratie toe.
operationId: createAdresseerbaarObjectBasisregistratie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -491,7 +491,7 @@ paths:
put:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: |
+ summary: |
Vervangen van een AdresseerbaarObjectBasisregistratie op basis van overeenkomstige sleutelvelden.
operationId: replaceAdresseerbaarObjectBasisregistratie
parameters:
@@ -526,7 +526,7 @@ paths:
patch:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een AdresseerbaarObjectBasisregistratie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAdresseerbaarObjectBasisregistratie
@@ -563,7 +563,7 @@ paths:
get:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Retourneert een AdresseerbaarObjectBasisregistratie met de gegeven identifier
+ summary: Retourneert een AdresseerbaarObjectBasisregistratie met de gegeven identifier
operationId: readAdresseerbaarObjectBasisregistratieById
parameters:
- name: id
@@ -600,7 +600,7 @@ paths:
put:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Vervangen van een AdresseerbaarObjectBasisregistratie
+ summary: Vervangen van een AdresseerbaarObjectBasisregistratie
operationId: replaceAdresseerbaarObjectBasisregistratieById
parameters:
- name: 'id'
@@ -638,7 +638,7 @@ paths:
patch:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Wijzigen van een AdresseerbaarObjectBasisregistratie
+ summary: Wijzigen van een AdresseerbaarObjectBasisregistratie
operationId: updateAdresseerbaarObjectBasisregistratieById
parameters:
- name: 'id'
@@ -677,7 +677,7 @@ paths:
get:
tags:
- 'BagAdressen'
- description: Ophalen van BagAdressen
+ summary: Ophalen van BagAdressen
operationId: listBagAdressen
parameters:
- name: params
@@ -727,7 +727,7 @@ paths:
post:
tags:
- 'BagAdressen'
- description: Voegt een nieuw(e) BagAdres toe.
+ summary: Voegt een nieuw(e) BagAdres toe.
operationId: createBagAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -767,7 +767,7 @@ paths:
put:
tags:
- 'BagAdressen'
- description: |
+ summary: |
Vervangen van een BagAdres op basis van overeenkomstige sleutelvelden.
operationId: replaceBagAdres
parameters:
@@ -802,7 +802,7 @@ paths:
patch:
tags:
- 'BagAdressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BagAdres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBagAdres
@@ -839,7 +839,7 @@ paths:
get:
tags:
- 'BagAdressen'
- description: Retourneert een BagAdres met de gegeven identifier
+ summary: Retourneert een BagAdres met de gegeven identifier
operationId: readBagAdresById
parameters:
- name: id
@@ -876,7 +876,7 @@ paths:
put:
tags:
- 'BagAdressen'
- description: Vervangen van een BagAdres
+ summary: Vervangen van een BagAdres
operationId: replaceBagAdresById
parameters:
- name: 'id'
@@ -914,7 +914,7 @@ paths:
patch:
tags:
- 'BagAdressen'
- description: Wijzigen van een BagAdres
+ summary: Wijzigen van een BagAdres
operationId: updateBagAdresById
parameters:
- name: 'id'
@@ -953,7 +953,7 @@ paths:
get:
tags:
- 'BagPanden'
- description: Ophalen van BagPanden
+ summary: Ophalen van BagPanden
operationId: listBagPanden
parameters:
- name: params
@@ -1003,7 +1003,7 @@ paths:
post:
tags:
- 'BagPanden'
- description: Voegt een nieuw(e) BagPand toe.
+ summary: Voegt een nieuw(e) BagPand toe.
operationId: createBagPand
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1043,7 +1043,7 @@ paths:
put:
tags:
- 'BagPanden'
- description: |
+ summary: |
Vervangen van een BagPand op basis van overeenkomstige sleutelvelden.
operationId: replaceBagPand
parameters:
@@ -1078,7 +1078,7 @@ paths:
patch:
tags:
- 'BagPanden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BagPand. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBagPand
@@ -1115,7 +1115,7 @@ paths:
get:
tags:
- 'BagPanden'
- description: Retourneert een BagPand met de gegeven identifier
+ summary: Retourneert een BagPand met de gegeven identifier
operationId: readBagPandById
parameters:
- name: id
@@ -1152,7 +1152,7 @@ paths:
put:
tags:
- 'BagPanden'
- description: Vervangen van een BagPand
+ summary: Vervangen van een BagPand
operationId: replaceBagPandById
parameters:
- name: 'id'
@@ -1190,7 +1190,7 @@ paths:
patch:
tags:
- 'BagPanden'
- description: Wijzigen van een BagPand
+ summary: Wijzigen van een BagPand
operationId: updateBagPandById
parameters:
- name: 'id'
@@ -1229,7 +1229,7 @@ paths:
get:
tags:
- 'BagWoonplaatsen'
- description: Ophalen van BagWoonplaatsen
+ summary: Ophalen van BagWoonplaatsen
operationId: listBagWoonplaatsen
parameters:
- name: params
@@ -1279,7 +1279,7 @@ paths:
post:
tags:
- 'BagWoonplaatsen'
- description: Voegt een nieuw(e) BagWoonplaats toe.
+ summary: Voegt een nieuw(e) BagWoonplaats toe.
operationId: createBagWoonplaats
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1319,7 +1319,7 @@ paths:
put:
tags:
- 'BagWoonplaatsen'
- description: |
+ summary: |
Vervangen van een BagWoonplaats op basis van overeenkomstige sleutelvelden.
operationId: replaceBagWoonplaats
parameters:
@@ -1354,7 +1354,7 @@ paths:
patch:
tags:
- 'BagWoonplaatsen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BagWoonplaats. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBagWoonplaats
@@ -1391,7 +1391,7 @@ paths:
get:
tags:
- 'BagWoonplaatsen'
- description: Retourneert een BagWoonplaats met de gegeven identifier
+ summary: Retourneert een BagWoonplaats met de gegeven identifier
operationId: readBagWoonplaatsById
parameters:
- name: id
@@ -1428,7 +1428,7 @@ paths:
put:
tags:
- 'BagWoonplaatsen'
- description: Vervangen van een BagWoonplaats
+ summary: Vervangen van een BagWoonplaats
operationId: replaceBagWoonplaatsById
parameters:
- name: 'id'
@@ -1466,7 +1466,7 @@ paths:
patch:
tags:
- 'BagWoonplaatsen'
- description: Wijzigen van een BagWoonplaats
+ summary: Wijzigen van een BagWoonplaats
operationId: updateBagWoonplaatsById
parameters:
- name: 'id'
@@ -1505,7 +1505,7 @@ paths:
get:
tags:
- 'Beleidswaarden'
- description: Ophalen van Beleidswaarden
+ summary: Ophalen van Beleidswaarden
operationId: listBeleidswaarden
parameters:
- name: params
@@ -1555,7 +1555,7 @@ paths:
post:
tags:
- 'Beleidswaarden'
- description: Voegt een nieuw(e) Beleidswaarde toe.
+ summary: Voegt een nieuw(e) Beleidswaarde toe.
operationId: createBeleidswaarde
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1595,7 +1595,7 @@ paths:
put:
tags:
- 'Beleidswaarden'
- description: |
+ summary: |
Vervangen van een Beleidswaarde op basis van overeenkomstige sleutelvelden.
operationId: replaceBeleidswaarde
parameters:
@@ -1630,7 +1630,7 @@ paths:
patch:
tags:
- 'Beleidswaarden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Beleidswaarde. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBeleidswaarde
@@ -1667,7 +1667,7 @@ paths:
get:
tags:
- 'Beleidswaarden'
- description: Retourneert een Beleidswaarde met de gegeven identifier
+ summary: Retourneert een Beleidswaarde met de gegeven identifier
operationId: readBeleidswaardeById
parameters:
- name: id
@@ -1704,7 +1704,7 @@ paths:
put:
tags:
- 'Beleidswaarden'
- description: Vervangen van een Beleidswaarde
+ summary: Vervangen van een Beleidswaarde
operationId: replaceBeleidswaardeById
parameters:
- name: 'id'
@@ -1742,7 +1742,7 @@ paths:
patch:
tags:
- 'Beleidswaarden'
- description: Wijzigen van een Beleidswaarde
+ summary: Wijzigen van een Beleidswaarde
operationId: updateBeleidswaardeById
parameters:
- name: 'id'
@@ -1781,7 +1781,7 @@ paths:
get:
tags:
- 'Bouwdelen'
- description: Ophalen van Bouwdelen
+ summary: Ophalen van Bouwdelen
operationId: listBouwdelen
parameters:
- name: params
@@ -1831,7 +1831,7 @@ paths:
post:
tags:
- 'Bouwdelen'
- description: Voegt een nieuw(e) Bouwdeel toe.
+ summary: Voegt een nieuw(e) Bouwdeel toe.
operationId: createBouwdeel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1871,7 +1871,7 @@ paths:
put:
tags:
- 'Bouwdelen'
- description: |
+ summary: |
Vervangen van een Bouwdeel op basis van overeenkomstige sleutelvelden.
operationId: replaceBouwdeel
parameters:
@@ -1906,7 +1906,7 @@ paths:
patch:
tags:
- 'Bouwdelen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Bouwdeel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBouwdeel
@@ -1943,7 +1943,7 @@ paths:
get:
tags:
- 'Bouwdelen'
- description: Retourneert een Bouwdeel met de gegeven identifier
+ summary: Retourneert een Bouwdeel met de gegeven identifier
operationId: readBouwdeelById
parameters:
- name: id
@@ -1980,7 +1980,7 @@ paths:
put:
tags:
- 'Bouwdelen'
- description: Vervangen van een Bouwdeel
+ summary: Vervangen van een Bouwdeel
operationId: replaceBouwdeelById
parameters:
- name: 'id'
@@ -2018,7 +2018,7 @@ paths:
patch:
tags:
- 'Bouwdelen'
- description: Wijzigen van een Bouwdeel
+ summary: Wijzigen van een Bouwdeel
operationId: updateBouwdeelById
parameters:
- name: 'id'
@@ -2057,7 +2057,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Ophalen van BouwkundigElementen
+ summary: Ophalen van BouwkundigElementen
operationId: listBouwkundigElementen
parameters:
- name: params
@@ -2107,7 +2107,7 @@ paths:
post:
tags:
- 'BouwkundigElementen'
- description: Voegt een nieuw(e) BouwkundigElement toe.
+ summary: Voegt een nieuw(e) BouwkundigElement toe.
operationId: createBouwkundigElement
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2147,7 +2147,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Vervangen van een BouwkundigElement op basis van overeenkomstige sleutelvelden.
operationId: replaceBouwkundigElement
parameters:
@@ -2182,7 +2182,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BouwkundigElement. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBouwkundigElement
@@ -2219,7 +2219,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Retourneert een BouwkundigElement met de gegeven identifier
+ summary: Retourneert een BouwkundigElement met de gegeven identifier
operationId: readBouwkundigElementById
parameters:
- name: id
@@ -2256,7 +2256,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: Vervangen van een BouwkundigElement
+ summary: Vervangen van een BouwkundigElement
operationId: replaceBouwkundigElementById
parameters:
- name: 'id'
@@ -2294,7 +2294,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: Wijzigen van een BouwkundigElement
+ summary: Wijzigen van een BouwkundigElement
operationId: updateBouwkundigElementById
parameters:
- name: 'id'
@@ -2333,7 +2333,7 @@ paths:
get:
tags:
- 'BuitenlandsAdressen'
- description: Ophalen van BuitenlandsAdressen
+ summary: Ophalen van BuitenlandsAdressen
operationId: listBuitenlandsAdressen
parameters:
- name: params
@@ -2383,7 +2383,7 @@ paths:
post:
tags:
- 'BuitenlandsAdressen'
- description: Voegt een nieuw(e) BuitenlandsAdres toe.
+ summary: Voegt een nieuw(e) BuitenlandsAdres toe.
operationId: createBuitenlandsAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2423,7 +2423,7 @@ paths:
put:
tags:
- 'BuitenlandsAdressen'
- description: |
+ summary: |
Vervangen van een BuitenlandsAdres op basis van overeenkomstige sleutelvelden.
operationId: replaceBuitenlandsAdres
parameters:
@@ -2458,7 +2458,7 @@ paths:
patch:
tags:
- 'BuitenlandsAdressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BuitenlandsAdres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBuitenlandsAdres
@@ -2495,7 +2495,7 @@ paths:
get:
tags:
- 'BuitenlandsAdressen'
- description: Retourneert een BuitenlandsAdres met de gegeven identifier
+ summary: Retourneert een BuitenlandsAdres met de gegeven identifier
operationId: readBuitenlandsAdresById
parameters:
- name: id
@@ -2532,7 +2532,7 @@ paths:
put:
tags:
- 'BuitenlandsAdressen'
- description: Vervangen van een BuitenlandsAdres
+ summary: Vervangen van een BuitenlandsAdres
operationId: replaceBuitenlandsAdresById
parameters:
- name: 'id'
@@ -2570,7 +2570,7 @@ paths:
patch:
tags:
- 'BuitenlandsAdressen'
- description: Wijzigen van een BuitenlandsAdres
+ summary: Wijzigen van een BuitenlandsAdres
operationId: updateBuitenlandsAdresById
parameters:
- name: 'id'
@@ -2609,7 +2609,7 @@ paths:
get:
tags:
- 'Buurten'
- description: Ophalen van Buurten
+ summary: Ophalen van Buurten
operationId: listBuurten
parameters:
- name: params
@@ -2659,7 +2659,7 @@ paths:
post:
tags:
- 'Buurten'
- description: Voegt een nieuw(e) Buurt toe.
+ summary: Voegt een nieuw(e) Buurt toe.
operationId: createBuurt
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2699,7 +2699,7 @@ paths:
put:
tags:
- 'Buurten'
- description: |
+ summary: |
Vervangen van een Buurt op basis van overeenkomstige sleutelvelden.
operationId: replaceBuurt
parameters:
@@ -2734,7 +2734,7 @@ paths:
patch:
tags:
- 'Buurten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Buurt. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBuurt
@@ -2771,7 +2771,7 @@ paths:
get:
tags:
- 'Buurten'
- description: Retourneert een Buurt met de gegeven identifier
+ summary: Retourneert een Buurt met de gegeven identifier
operationId: readBuurtById
parameters:
- name: id
@@ -2808,7 +2808,7 @@ paths:
put:
tags:
- 'Buurten'
- description: Vervangen van een Buurt
+ summary: Vervangen van een Buurt
operationId: replaceBuurtById
parameters:
- name: 'id'
@@ -2846,7 +2846,7 @@ paths:
patch:
tags:
- 'Buurten'
- description: Wijzigen van een Buurt
+ summary: Wijzigen van een Buurt
operationId: updateBuurtById
parameters:
- name: 'id'
@@ -2885,7 +2885,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Ophalen van Clusters
+ summary: Ophalen van Clusters
operationId: listClusters
parameters:
- name: params
@@ -2935,7 +2935,7 @@ paths:
post:
tags:
- 'Clusters'
- description: Voegt een nieuw(e) Cluster toe.
+ summary: Voegt een nieuw(e) Cluster toe.
operationId: createCluster
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2975,7 +2975,7 @@ paths:
put:
tags:
- 'Clusters'
- description: |
+ summary: |
Vervangen van een Cluster op basis van overeenkomstige sleutelvelden.
operationId: replaceCluster
parameters:
@@ -3010,7 +3010,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Cluster. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCluster
@@ -3047,7 +3047,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Retourneert een Cluster met de gegeven identifier
+ summary: Retourneert een Cluster met de gegeven identifier
operationId: readClusterById
parameters:
- name: id
@@ -3084,7 +3084,7 @@ paths:
put:
tags:
- 'Clusters'
- description: Vervangen van een Cluster
+ summary: Vervangen van een Cluster
operationId: replaceClusterById
parameters:
- name: 'id'
@@ -3122,7 +3122,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: Wijzigen van een Cluster
+ summary: Wijzigen van een Cluster
operationId: updateClusterById
parameters:
- name: 'id'
@@ -3161,7 +3161,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Ophalen van CollectiefObjecten
+ summary: Ophalen van CollectiefObjecten
operationId: listCollectiefObjecten
parameters:
- name: params
@@ -3211,7 +3211,7 @@ paths:
post:
tags:
- 'CollectiefObjecten'
- description: Voegt een nieuw(e) CollectiefObject toe.
+ summary: Voegt een nieuw(e) CollectiefObject toe.
operationId: createCollectiefObject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3251,7 +3251,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Vervangen van een CollectiefObject op basis van overeenkomstige sleutelvelden.
operationId: replaceCollectiefObject
parameters:
@@ -3286,7 +3286,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een CollectiefObject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCollectiefObject
@@ -3323,7 +3323,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Retourneert een CollectiefObject met de gegeven identifier
+ summary: Retourneert een CollectiefObject met de gegeven identifier
operationId: readCollectiefObjectById
parameters:
- name: id
@@ -3360,7 +3360,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: Vervangen van een CollectiefObject
+ summary: Vervangen van een CollectiefObject
operationId: replaceCollectiefObjectById
parameters:
- name: 'id'
@@ -3398,7 +3398,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: Wijzigen van een CollectiefObject
+ summary: Wijzigen van een CollectiefObject
operationId: updateCollectiefObjectById
parameters:
- name: 'id'
@@ -3437,7 +3437,7 @@ paths:
get:
tags:
- 'Conditiemetingen'
- description: Ophalen van Conditiemetingen
+ summary: Ophalen van Conditiemetingen
operationId: listConditiemetingen
parameters:
- name: params
@@ -3487,7 +3487,7 @@ paths:
post:
tags:
- 'Conditiemetingen'
- description: Voegt een nieuw(e) Conditiemeting toe.
+ summary: Voegt een nieuw(e) Conditiemeting toe.
operationId: createConditiemeting
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3527,7 +3527,7 @@ paths:
put:
tags:
- 'Conditiemetingen'
- description: |
+ summary: |
Vervangen van een Conditiemeting op basis van overeenkomstige sleutelvelden.
operationId: replaceConditiemeting
parameters:
@@ -3562,7 +3562,7 @@ paths:
patch:
tags:
- 'Conditiemetingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Conditiemeting. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateConditiemeting
@@ -3599,7 +3599,7 @@ paths:
get:
tags:
- 'Conditiemetingen'
- description: Retourneert een Conditiemeting met de gegeven identifier
+ summary: Retourneert een Conditiemeting met de gegeven identifier
operationId: readConditiemetingById
parameters:
- name: id
@@ -3636,7 +3636,7 @@ paths:
put:
tags:
- 'Conditiemetingen'
- description: Vervangen van een Conditiemeting
+ summary: Vervangen van een Conditiemeting
operationId: replaceConditiemetingById
parameters:
- name: 'id'
@@ -3674,7 +3674,7 @@ paths:
patch:
tags:
- 'Conditiemetingen'
- description: Wijzigen van een Conditiemeting
+ summary: Wijzigen van een Conditiemeting
operationId: updateConditiemetingById
parameters:
- name: 'id'
@@ -3713,7 +3713,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Ophalen van Eenheden
+ summary: Ophalen van Eenheden
operationId: listEenheden
parameters:
- name: params
@@ -3763,7 +3763,7 @@ paths:
post:
tags:
- 'Eenheden'
- description: Voegt een nieuw(e) Eenheid toe.
+ summary: Voegt een nieuw(e) Eenheid toe.
operationId: createEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3803,7 +3803,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: |
+ summary: |
Vervangen van een Eenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheid
parameters:
@@ -3838,7 +3838,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheid
@@ -3875,7 +3875,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Retourneert een Eenheid met de gegeven identifier
+ summary: Retourneert een Eenheid met de gegeven identifier
operationId: readEenheidById
parameters:
- name: id
@@ -3912,7 +3912,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: Vervangen van een Eenheid
+ summary: Vervangen van een Eenheid
operationId: replaceEenheidById
parameters:
- name: 'id'
@@ -3950,7 +3950,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: Wijzigen van een Eenheid
+ summary: Wijzigen van een Eenheid
operationId: updateEenheidById
parameters:
- name: 'id'
@@ -3989,7 +3989,7 @@ paths:
get:
tags:
- 'Eenheidadressen'
- description: Ophalen van Eenheidadressen
+ summary: Ophalen van Eenheidadressen
operationId: listEenheidadressen
parameters:
- name: params
@@ -4039,7 +4039,7 @@ paths:
post:
tags:
- 'Eenheidadressen'
- description: Voegt een nieuw(e) Eenheidadres toe.
+ summary: Voegt een nieuw(e) Eenheidadres toe.
operationId: createEenheidadres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4079,7 +4079,7 @@ paths:
put:
tags:
- 'Eenheidadressen'
- description: |
+ summary: |
Vervangen van een Eenheidadres op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidadres
parameters:
@@ -4114,7 +4114,7 @@ paths:
patch:
tags:
- 'Eenheidadressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheidadres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidadres
@@ -4151,7 +4151,7 @@ paths:
get:
tags:
- 'Eenheidadressen'
- description: Retourneert een Eenheidadres met de gegeven identifier
+ summary: Retourneert een Eenheidadres met de gegeven identifier
operationId: readEenheidadresById
parameters:
- name: id
@@ -4188,7 +4188,7 @@ paths:
put:
tags:
- 'Eenheidadressen'
- description: Vervangen van een Eenheidadres
+ summary: Vervangen van een Eenheidadres
operationId: replaceEenheidadresById
parameters:
- name: 'id'
@@ -4226,7 +4226,7 @@ paths:
patch:
tags:
- 'Eenheidadressen'
- description: Wijzigen van een Eenheidadres
+ summary: Wijzigen van een Eenheidadres
operationId: updateEenheidadresById
parameters:
- name: 'id'
@@ -4265,7 +4265,7 @@ paths:
get:
tags:
- 'Eenheidcriteria'
- description: Ophalen van Eenheidcriteria
+ summary: Ophalen van Eenheidcriteria
operationId: listEenheidcriteria
parameters:
- name: params
@@ -4315,7 +4315,7 @@ paths:
post:
tags:
- 'Eenheidcriteria'
- description: Voegt een nieuw(e) Eenheidcriterium toe.
+ summary: Voegt een nieuw(e) Eenheidcriterium toe.
operationId: createEenheidcriterium
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4355,7 +4355,7 @@ paths:
put:
tags:
- 'Eenheidcriteria'
- description: |
+ summary: |
Vervangen van een Eenheidcriterium op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidcriterium
parameters:
@@ -4390,7 +4390,7 @@ paths:
patch:
tags:
- 'Eenheidcriteria'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheidcriterium. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidcriterium
@@ -4427,7 +4427,7 @@ paths:
get:
tags:
- 'Eenheidcriteria'
- description: Retourneert een Eenheidcriterium met de gegeven identifier
+ summary: Retourneert een Eenheidcriterium met de gegeven identifier
operationId: readEenheidcriteriumById
parameters:
- name: id
@@ -4464,7 +4464,7 @@ paths:
put:
tags:
- 'Eenheidcriteria'
- description: Vervangen van een Eenheidcriterium
+ summary: Vervangen van een Eenheidcriterium
operationId: replaceEenheidcriteriumById
parameters:
- name: 'id'
@@ -4502,7 +4502,7 @@ paths:
patch:
tags:
- 'Eenheidcriteria'
- description: Wijzigen van een Eenheidcriterium
+ summary: Wijzigen van een Eenheidcriterium
operationId: updateEenheidcriteriumById
parameters:
- name: 'id'
@@ -4541,7 +4541,7 @@ paths:
get:
tags:
- 'EenheidToestanden'
- description: Ophalen van EenheidToestanden
+ summary: Ophalen van EenheidToestanden
operationId: listEenheidToestanden
parameters:
- name: params
@@ -4591,7 +4591,7 @@ paths:
post:
tags:
- 'EenheidToestanden'
- description: Voegt een nieuw(e) EenheidToestand toe.
+ summary: Voegt een nieuw(e) EenheidToestand toe.
operationId: createEenheidToestand
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4631,7 +4631,7 @@ paths:
put:
tags:
- 'EenheidToestanden'
- description: |
+ summary: |
Vervangen van een EenheidToestand op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidToestand
parameters:
@@ -4666,7 +4666,7 @@ paths:
patch:
tags:
- 'EenheidToestanden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een EenheidToestand. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidToestand
@@ -4703,7 +4703,7 @@ paths:
get:
tags:
- 'EenheidToestanden'
- description: Retourneert een EenheidToestand met de gegeven identifier
+ summary: Retourneert een EenheidToestand met de gegeven identifier
operationId: readEenheidToestandById
parameters:
- name: id
@@ -4740,7 +4740,7 @@ paths:
put:
tags:
- 'EenheidToestanden'
- description: Vervangen van een EenheidToestand
+ summary: Vervangen van een EenheidToestand
operationId: replaceEenheidToestandById
parameters:
- name: 'id'
@@ -4778,7 +4778,7 @@ paths:
patch:
tags:
- 'EenheidToestanden'
- description: Wijzigen van een EenheidToestand
+ summary: Wijzigen van een EenheidToestand
operationId: updateEenheidToestandById
parameters:
- name: 'id'
@@ -4817,7 +4817,7 @@ paths:
get:
tags:
- 'EenheidVoorwaardes'
- description: Ophalen van EenheidVoorwaardes
+ summary: Ophalen van EenheidVoorwaardes
operationId: listEenheidVoorwaardes
parameters:
- name: params
@@ -4867,7 +4867,7 @@ paths:
post:
tags:
- 'EenheidVoorwaardes'
- description: Voegt een nieuw(e) EenheidVoorwaarden toe.
+ summary: Voegt een nieuw(e) EenheidVoorwaarden toe.
operationId: createEenheidVoorwaarden
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4907,7 +4907,7 @@ paths:
put:
tags:
- 'EenheidVoorwaardes'
- description: |
+ summary: |
Vervangen van een EenheidVoorwaarden op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidVoorwaarden
parameters:
@@ -4942,7 +4942,7 @@ paths:
patch:
tags:
- 'EenheidVoorwaardes'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een EenheidVoorwaarden. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidVoorwaarden
@@ -4979,7 +4979,7 @@ paths:
get:
tags:
- 'EenheidVoorwaardes'
- description: Retourneert een EenheidVoorwaarden met de gegeven identifier
+ summary: Retourneert een EenheidVoorwaarden met de gegeven identifier
operationId: readEenheidVoorwaardenById
parameters:
- name: id
@@ -5016,7 +5016,7 @@ paths:
put:
tags:
- 'EenheidVoorwaardes'
- description: Vervangen van een EenheidVoorwaarden
+ summary: Vervangen van een EenheidVoorwaarden
operationId: replaceEenheidVoorwaardenById
parameters:
- name: 'id'
@@ -5054,7 +5054,7 @@ paths:
patch:
tags:
- 'EenheidVoorwaardes'
- description: Wijzigen van een EenheidVoorwaarden
+ summary: Wijzigen van een EenheidVoorwaarden
operationId: updateEenheidVoorwaardenById
parameters:
- name: 'id'
@@ -5093,7 +5093,7 @@ paths:
get:
tags:
- 'Energieprestaties'
- description: Ophalen van Energieprestaties
+ summary: Ophalen van Energieprestaties
operationId: listEnergieprestaties
parameters:
- name: params
@@ -5143,7 +5143,7 @@ paths:
post:
tags:
- 'Energieprestaties'
- description: Voegt een nieuw(e) Energieprestatie toe.
+ summary: Voegt een nieuw(e) Energieprestatie toe.
operationId: createEnergieprestatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5183,7 +5183,7 @@ paths:
put:
tags:
- 'Energieprestaties'
- description: |
+ summary: |
Vervangen van een Energieprestatie op basis van overeenkomstige sleutelvelden.
operationId: replaceEnergieprestatie
parameters:
@@ -5218,7 +5218,7 @@ paths:
patch:
tags:
- 'Energieprestaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Energieprestatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEnergieprestatie
@@ -5255,7 +5255,7 @@ paths:
get:
tags:
- 'Energieprestaties'
- description: Retourneert een Energieprestatie met de gegeven identifier
+ summary: Retourneert een Energieprestatie met de gegeven identifier
operationId: readEnergieprestatieById
parameters:
- name: id
@@ -5292,7 +5292,7 @@ paths:
put:
tags:
- 'Energieprestaties'
- description: Vervangen van een Energieprestatie
+ summary: Vervangen van een Energieprestatie
operationId: replaceEnergieprestatieById
parameters:
- name: 'id'
@@ -5330,7 +5330,7 @@ paths:
patch:
tags:
- 'Energieprestaties'
- description: Wijzigen van een Energieprestatie
+ summary: Wijzigen van een Energieprestatie
operationId: updateEnergieprestatieById
parameters:
- name: 'id'
@@ -5369,7 +5369,7 @@ paths:
get:
tags:
- 'Garanties'
- description: Ophalen van Garanties
+ summary: Ophalen van Garanties
operationId: listGaranties
parameters:
- name: params
@@ -5419,7 +5419,7 @@ paths:
post:
tags:
- 'Garanties'
- description: Voegt een nieuw(e) Garantie toe.
+ summary: Voegt een nieuw(e) Garantie toe.
operationId: createGarantie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5459,7 +5459,7 @@ paths:
put:
tags:
- 'Garanties'
- description: |
+ summary: |
Vervangen van een Garantie op basis van overeenkomstige sleutelvelden.
operationId: replaceGarantie
parameters:
@@ -5494,7 +5494,7 @@ paths:
patch:
tags:
- 'Garanties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Garantie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGarantie
@@ -5531,7 +5531,7 @@ paths:
get:
tags:
- 'Garanties'
- description: Retourneert een Garantie met de gegeven identifier
+ summary: Retourneert een Garantie met de gegeven identifier
operationId: readGarantieById
parameters:
- name: id
@@ -5568,7 +5568,7 @@ paths:
put:
tags:
- 'Garanties'
- description: Vervangen van een Garantie
+ summary: Vervangen van een Garantie
operationId: replaceGarantieById
parameters:
- name: 'id'
@@ -5606,7 +5606,7 @@ paths:
patch:
tags:
- 'Garanties'
- description: Wijzigen van een Garantie
+ summary: Wijzigen van een Garantie
operationId: updateGarantieById
parameters:
- name: 'id'
@@ -5645,7 +5645,7 @@ paths:
get:
tags:
- 'Gebouwen'
- description: Ophalen van Gebouwen
+ summary: Ophalen van Gebouwen
operationId: listGebouwen
parameters:
- name: params
@@ -5695,7 +5695,7 @@ paths:
post:
tags:
- 'Gebouwen'
- description: Voegt een nieuw(e) Gebouw toe.
+ summary: Voegt een nieuw(e) Gebouw toe.
operationId: createGebouw
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5735,7 +5735,7 @@ paths:
put:
tags:
- 'Gebouwen'
- description: |
+ summary: |
Vervangen van een Gebouw op basis van overeenkomstige sleutelvelden.
operationId: replaceGebouw
parameters:
@@ -5770,7 +5770,7 @@ paths:
patch:
tags:
- 'Gebouwen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gebouw. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGebouw
@@ -5807,7 +5807,7 @@ paths:
get:
tags:
- 'Gebouwen'
- description: Retourneert een Gebouw met de gegeven identifier
+ summary: Retourneert een Gebouw met de gegeven identifier
operationId: readGebouwById
parameters:
- name: id
@@ -5844,7 +5844,7 @@ paths:
put:
tags:
- 'Gebouwen'
- description: Vervangen van een Gebouw
+ summary: Vervangen van een Gebouw
operationId: replaceGebouwById
parameters:
- name: 'id'
@@ -5882,7 +5882,7 @@ paths:
patch:
tags:
- 'Gebouwen'
- description: Wijzigen van een Gebouw
+ summary: Wijzigen van een Gebouw
operationId: updateGebouwById
parameters:
- name: 'id'
@@ -5921,7 +5921,7 @@ paths:
get:
tags:
- 'Gemeenten'
- description: Ophalen van Gemeenten
+ summary: Ophalen van Gemeenten
operationId: listGemeenten
parameters:
- name: params
@@ -5971,7 +5971,7 @@ paths:
post:
tags:
- 'Gemeenten'
- description: Voegt een nieuw(e) Gemeente toe.
+ summary: Voegt een nieuw(e) Gemeente toe.
operationId: createGemeente
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6011,7 +6011,7 @@ paths:
put:
tags:
- 'Gemeenten'
- description: |
+ summary: |
Vervangen van een Gemeente op basis van overeenkomstige sleutelvelden.
operationId: replaceGemeente
parameters:
@@ -6046,7 +6046,7 @@ paths:
patch:
tags:
- 'Gemeenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gemeente. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGemeente
@@ -6083,7 +6083,7 @@ paths:
get:
tags:
- 'Gemeenten'
- description: Retourneert een Gemeente met de gegeven identifier
+ summary: Retourneert een Gemeente met de gegeven identifier
operationId: readGemeenteById
parameters:
- name: id
@@ -6120,7 +6120,7 @@ paths:
put:
tags:
- 'Gemeenten'
- description: Vervangen van een Gemeente
+ summary: Vervangen van een Gemeente
operationId: replaceGemeenteById
parameters:
- name: 'id'
@@ -6158,7 +6158,7 @@ paths:
patch:
tags:
- 'Gemeenten'
- description: Wijzigen van een Gemeente
+ summary: Wijzigen van een Gemeente
operationId: updateGemeenteById
parameters:
- name: 'id'
@@ -6197,7 +6197,7 @@ paths:
get:
tags:
- 'Geometrieen'
- description: Ophalen van Geometrieen
+ summary: Ophalen van Geometrieen
operationId: listGeometrieen
parameters:
- name: params
@@ -6247,7 +6247,7 @@ paths:
post:
tags:
- 'Geometrieen'
- description: Voegt een nieuw(e) Geometrie toe.
+ summary: Voegt een nieuw(e) Geometrie toe.
operationId: createGeometrie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6287,7 +6287,7 @@ paths:
put:
tags:
- 'Geometrieen'
- description: |
+ summary: |
Vervangen van een Geometrie op basis van overeenkomstige sleutelvelden.
operationId: replaceGeometrie
parameters:
@@ -6322,7 +6322,7 @@ paths:
patch:
tags:
- 'Geometrieen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Geometrie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGeometrie
@@ -6359,7 +6359,7 @@ paths:
get:
tags:
- 'Geometrieen'
- description: Retourneert een Geometrie met de gegeven identifier
+ summary: Retourneert een Geometrie met de gegeven identifier
operationId: readGeometrieById
parameters:
- name: id
@@ -6396,7 +6396,7 @@ paths:
put:
tags:
- 'Geometrieen'
- description: Vervangen van een Geometrie
+ summary: Vervangen van een Geometrie
operationId: replaceGeometrieById
parameters:
- name: 'id'
@@ -6434,7 +6434,7 @@ paths:
patch:
tags:
- 'Geometrieen'
- description: Wijzigen van een Geometrie
+ summary: Wijzigen van een Geometrie
operationId: updateGeometrieById
parameters:
- name: 'id'
@@ -6473,7 +6473,7 @@ paths:
get:
tags:
- 'KadasterPercelen'
- description: Ophalen van KadasterPercelen
+ summary: Ophalen van KadasterPercelen
operationId: listKadasterPercelen
parameters:
- name: params
@@ -6523,7 +6523,7 @@ paths:
post:
tags:
- 'KadasterPercelen'
- description: Voegt een nieuw(e) KadasterPerceel toe.
+ summary: Voegt een nieuw(e) KadasterPerceel toe.
operationId: createKadasterPerceel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6563,7 +6563,7 @@ paths:
put:
tags:
- 'KadasterPercelen'
- description: |
+ summary: |
Vervangen van een KadasterPerceel op basis van overeenkomstige sleutelvelden.
operationId: replaceKadasterPerceel
parameters:
@@ -6598,7 +6598,7 @@ paths:
patch:
tags:
- 'KadasterPercelen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een KadasterPerceel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKadasterPerceel
@@ -6635,7 +6635,7 @@ paths:
get:
tags:
- 'KadasterPercelen'
- description: Retourneert een KadasterPerceel met de gegeven identifier
+ summary: Retourneert een KadasterPerceel met de gegeven identifier
operationId: readKadasterPerceelById
parameters:
- name: id
@@ -6672,7 +6672,7 @@ paths:
put:
tags:
- 'KadasterPercelen'
- description: Vervangen van een KadasterPerceel
+ summary: Vervangen van een KadasterPerceel
operationId: replaceKadasterPerceelById
parameters:
- name: 'id'
@@ -6710,7 +6710,7 @@ paths:
patch:
tags:
- 'KadasterPercelen'
- description: Wijzigen van een KadasterPerceel
+ summary: Wijzigen van een KadasterPerceel
operationId: updateKadasterPerceelById
parameters:
- name: 'id'
@@ -6749,7 +6749,7 @@ paths:
get:
tags:
- 'Marktwaarden'
- description: Ophalen van Marktwaarden
+ summary: Ophalen van Marktwaarden
operationId: listMarktwaarden
parameters:
- name: params
@@ -6799,7 +6799,7 @@ paths:
post:
tags:
- 'Marktwaarden'
- description: Voegt een nieuw(e) Marktwaarde toe.
+ summary: Voegt een nieuw(e) Marktwaarde toe.
operationId: createMarktwaarde
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6839,7 +6839,7 @@ paths:
put:
tags:
- 'Marktwaarden'
- description: |
+ summary: |
Vervangen van een Marktwaarde op basis van overeenkomstige sleutelvelden.
operationId: replaceMarktwaarde
parameters:
@@ -6874,7 +6874,7 @@ paths:
patch:
tags:
- 'Marktwaarden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Marktwaarde. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateMarktwaarde
@@ -6911,7 +6911,7 @@ paths:
get:
tags:
- 'Marktwaarden'
- description: Retourneert een Marktwaarde met de gegeven identifier
+ summary: Retourneert een Marktwaarde met de gegeven identifier
operationId: readMarktwaardeById
parameters:
- name: id
@@ -6948,7 +6948,7 @@ paths:
put:
tags:
- 'Marktwaarden'
- description: Vervangen van een Marktwaarde
+ summary: Vervangen van een Marktwaarde
operationId: replaceMarktwaardeById
parameters:
- name: 'id'
@@ -6986,7 +6986,7 @@ paths:
patch:
tags:
- 'Marktwaarden'
- description: Wijzigen van een Marktwaarde
+ summary: Wijzigen van een Marktwaarde
operationId: updateMarktwaardeById
parameters:
- name: 'id'
@@ -7025,7 +7025,7 @@ paths:
get:
tags:
- 'Panden'
- description: Ophalen van Panden
+ summary: Ophalen van Panden
operationId: listPanden
parameters:
- name: params
@@ -7075,7 +7075,7 @@ paths:
post:
tags:
- 'Panden'
- description: Voegt een nieuw(e) Pand toe.
+ summary: Voegt een nieuw(e) Pand toe.
operationId: createPand
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7115,7 +7115,7 @@ paths:
put:
tags:
- 'Panden'
- description: |
+ summary: |
Vervangen van een Pand op basis van overeenkomstige sleutelvelden.
operationId: replacePand
parameters:
@@ -7150,7 +7150,7 @@ paths:
patch:
tags:
- 'Panden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Pand. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePand
@@ -7187,7 +7187,7 @@ paths:
get:
tags:
- 'Panden'
- description: Retourneert een Pand met de gegeven identifier
+ summary: Retourneert een Pand met de gegeven identifier
operationId: readPandById
parameters:
- name: id
@@ -7224,7 +7224,7 @@ paths:
put:
tags:
- 'Panden'
- description: Vervangen van een Pand
+ summary: Vervangen van een Pand
operationId: replacePandById
parameters:
- name: 'id'
@@ -7262,7 +7262,7 @@ paths:
patch:
tags:
- 'Panden'
- description: Wijzigen van een Pand
+ summary: Wijzigen van een Pand
operationId: updatePandById
parameters:
- name: 'id'
@@ -7301,7 +7301,7 @@ paths:
get:
tags:
- 'Postadressen'
- description: Ophalen van Postadressen
+ summary: Ophalen van Postadressen
operationId: listPostadressen
parameters:
- name: params
@@ -7351,7 +7351,7 @@ paths:
post:
tags:
- 'Postadressen'
- description: Voegt een nieuw(e) Postadres toe.
+ summary: Voegt een nieuw(e) Postadres toe.
operationId: createPostadres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7391,7 +7391,7 @@ paths:
put:
tags:
- 'Postadressen'
- description: |
+ summary: |
Vervangen van een Postadres op basis van overeenkomstige sleutelvelden.
operationId: replacePostadres
parameters:
@@ -7426,7 +7426,7 @@ paths:
patch:
tags:
- 'Postadressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Postadres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePostadres
@@ -7463,7 +7463,7 @@ paths:
get:
tags:
- 'Postadressen'
- description: Retourneert een Postadres met de gegeven identifier
+ summary: Retourneert een Postadres met de gegeven identifier
operationId: readPostadresById
parameters:
- name: id
@@ -7500,7 +7500,7 @@ paths:
put:
tags:
- 'Postadressen'
- description: Vervangen van een Postadres
+ summary: Vervangen van een Postadres
operationId: replacePostadresById
parameters:
- name: 'id'
@@ -7538,7 +7538,7 @@ paths:
patch:
tags:
- 'Postadressen'
- description: Wijzigen van een Postadres
+ summary: Wijzigen van een Postadres
operationId: updatePostadresById
parameters:
- name: 'id'
@@ -7577,7 +7577,7 @@ paths:
get:
tags:
- 'Punten'
- description: Ophalen van Punten
+ summary: Ophalen van Punten
operationId: listPunten
parameters:
- name: params
@@ -7627,7 +7627,7 @@ paths:
post:
tags:
- 'Punten'
- description: Voegt een nieuw(e) Punt toe.
+ summary: Voegt een nieuw(e) Punt toe.
operationId: createPunt
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7667,7 +7667,7 @@ paths:
put:
tags:
- 'Punten'
- description: |
+ summary: |
Vervangen van een Punt op basis van overeenkomstige sleutelvelden.
operationId: replacePunt
parameters:
@@ -7702,7 +7702,7 @@ paths:
patch:
tags:
- 'Punten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Punt. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePunt
@@ -7739,7 +7739,7 @@ paths:
get:
tags:
- 'Punten'
- description: Retourneert een Punt met de gegeven identifier
+ summary: Retourneert een Punt met de gegeven identifier
operationId: readPuntById
parameters:
- name: id
@@ -7776,7 +7776,7 @@ paths:
put:
tags:
- 'Punten'
- description: Vervangen van een Punt
+ summary: Vervangen van een Punt
operationId: replacePuntById
parameters:
- name: 'id'
@@ -7814,7 +7814,7 @@ paths:
patch:
tags:
- 'Punten'
- description: Wijzigen van een Punt
+ summary: Wijzigen van een Punt
operationId: updatePuntById
parameters:
- name: 'id'
@@ -7853,7 +7853,7 @@ paths:
get:
tags:
- 'Renovaties'
- description: Ophalen van Renovaties
+ summary: Ophalen van Renovaties
operationId: listRenovaties
parameters:
- name: params
@@ -7903,7 +7903,7 @@ paths:
post:
tags:
- 'Renovaties'
- description: Voegt een nieuw(e) Renovatie toe.
+ summary: Voegt een nieuw(e) Renovatie toe.
operationId: createRenovatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7943,7 +7943,7 @@ paths:
put:
tags:
- 'Renovaties'
- description: |
+ summary: |
Vervangen van een Renovatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRenovatie
parameters:
@@ -7978,7 +7978,7 @@ paths:
patch:
tags:
- 'Renovaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Renovatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRenovatie
@@ -8015,7 +8015,7 @@ paths:
get:
tags:
- 'Renovaties'
- description: Retourneert een Renovatie met de gegeven identifier
+ summary: Retourneert een Renovatie met de gegeven identifier
operationId: readRenovatieById
parameters:
- name: id
@@ -8052,7 +8052,7 @@ paths:
put:
tags:
- 'Renovaties'
- description: Vervangen van een Renovatie
+ summary: Vervangen van een Renovatie
operationId: replaceRenovatieById
parameters:
- name: 'id'
@@ -8090,7 +8090,7 @@ paths:
patch:
tags:
- 'Renovaties'
- description: Wijzigen van een Renovatie
+ summary: Wijzigen van een Renovatie
operationId: updateRenovatieById
parameters:
- name: 'id'
@@ -8129,7 +8129,7 @@ paths:
get:
tags:
- 'Ruimten'
- description: Ophalen van Ruimten
+ summary: Ophalen van Ruimten
operationId: listRuimten
parameters:
- name: params
@@ -8179,7 +8179,7 @@ paths:
post:
tags:
- 'Ruimten'
- description: Voegt een nieuw(e) Ruimte toe.
+ summary: Voegt een nieuw(e) Ruimte toe.
operationId: createRuimte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8219,7 +8219,7 @@ paths:
put:
tags:
- 'Ruimten'
- description: |
+ summary: |
Vervangen van een Ruimte op basis van overeenkomstige sleutelvelden.
operationId: replaceRuimte
parameters:
@@ -8254,7 +8254,7 @@ paths:
patch:
tags:
- 'Ruimten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Ruimte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRuimte
@@ -8291,7 +8291,7 @@ paths:
get:
tags:
- 'Ruimten'
- description: Retourneert een Ruimte met de gegeven identifier
+ summary: Retourneert een Ruimte met de gegeven identifier
operationId: readRuimteById
parameters:
- name: id
@@ -8328,7 +8328,7 @@ paths:
put:
tags:
- 'Ruimten'
- description: Vervangen van een Ruimte
+ summary: Vervangen van een Ruimte
operationId: replaceRuimteById
parameters:
- name: 'id'
@@ -8366,7 +8366,7 @@ paths:
patch:
tags:
- 'Ruimten'
- description: Wijzigen van een Ruimte
+ summary: Wijzigen van een Ruimte
operationId: updateRuimteById
parameters:
- name: 'id'
@@ -8405,7 +8405,7 @@ paths:
get:
tags:
- 'Stadsdelen'
- description: Ophalen van Stadsdelen
+ summary: Ophalen van Stadsdelen
operationId: listStadsdelen
parameters:
- name: params
@@ -8455,7 +8455,7 @@ paths:
post:
tags:
- 'Stadsdelen'
- description: Voegt een nieuw(e) Stadsdeel toe.
+ summary: Voegt een nieuw(e) Stadsdeel toe.
operationId: createStadsdeel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8495,7 +8495,7 @@ paths:
put:
tags:
- 'Stadsdelen'
- description: |
+ summary: |
Vervangen van een Stadsdeel op basis van overeenkomstige sleutelvelden.
operationId: replaceStadsdeel
parameters:
@@ -8530,7 +8530,7 @@ paths:
patch:
tags:
- 'Stadsdelen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Stadsdeel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateStadsdeel
@@ -8567,7 +8567,7 @@ paths:
get:
tags:
- 'Stadsdelen'
- description: Retourneert een Stadsdeel met de gegeven identifier
+ summary: Retourneert een Stadsdeel met de gegeven identifier
operationId: readStadsdeelById
parameters:
- name: id
@@ -8604,7 +8604,7 @@ paths:
put:
tags:
- 'Stadsdelen'
- description: Vervangen van een Stadsdeel
+ summary: Vervangen van een Stadsdeel
operationId: replaceStadsdeelById
parameters:
- name: 'id'
@@ -8642,7 +8642,7 @@ paths:
patch:
tags:
- 'Stadsdelen'
- description: Wijzigen van een Stadsdeel
+ summary: Wijzigen van een Stadsdeel
operationId: updateStadsdeelById
parameters:
- name: 'id'
@@ -8681,7 +8681,7 @@ paths:
get:
tags:
- 'Taxaties'
- description: Ophalen van Taxaties
+ summary: Ophalen van Taxaties
operationId: listTaxaties
parameters:
- name: params
@@ -8731,7 +8731,7 @@ paths:
post:
tags:
- 'Taxaties'
- description: Voegt een nieuw(e) Taxatie toe.
+ summary: Voegt een nieuw(e) Taxatie toe.
operationId: createTaxatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8771,7 +8771,7 @@ paths:
put:
tags:
- 'Taxaties'
- description: |
+ summary: |
Vervangen van een Taxatie op basis van overeenkomstige sleutelvelden.
operationId: replaceTaxatie
parameters:
@@ -8806,7 +8806,7 @@ paths:
patch:
tags:
- 'Taxaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Taxatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateTaxatie
@@ -8843,7 +8843,7 @@ paths:
get:
tags:
- 'Taxaties'
- description: Retourneert een Taxatie met de gegeven identifier
+ summary: Retourneert een Taxatie met de gegeven identifier
operationId: readTaxatieById
parameters:
- name: id
@@ -8880,7 +8880,7 @@ paths:
put:
tags:
- 'Taxaties'
- description: Vervangen van een Taxatie
+ summary: Vervangen van een Taxatie
operationId: replaceTaxatieById
parameters:
- name: 'id'
@@ -8918,7 +8918,7 @@ paths:
patch:
tags:
- 'Taxaties'
- description: Wijzigen van een Taxatie
+ summary: Wijzigen van een Taxatie
operationId: updateTaxatieById
parameters:
- name: 'id'
@@ -8957,7 +8957,7 @@ paths:
get:
tags:
- 'Vertrekken'
- description: Ophalen van Vertrekken
+ summary: Ophalen van Vertrekken
operationId: listVertrekken
parameters:
- name: params
@@ -9007,7 +9007,7 @@ paths:
post:
tags:
- 'Vertrekken'
- description: Voegt een nieuw(e) Vertrek toe.
+ summary: Voegt een nieuw(e) Vertrek toe.
operationId: createVertrek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9047,7 +9047,7 @@ paths:
put:
tags:
- 'Vertrekken'
- description: |
+ summary: |
Vervangen van een Vertrek op basis van overeenkomstige sleutelvelden.
operationId: replaceVertrek
parameters:
@@ -9082,7 +9082,7 @@ paths:
patch:
tags:
- 'Vertrekken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Vertrek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVertrek
@@ -9119,7 +9119,7 @@ paths:
get:
tags:
- 'Vertrekken'
- description: Retourneert een Vertrek met de gegeven identifier
+ summary: Retourneert een Vertrek met de gegeven identifier
operationId: readVertrekById
parameters:
- name: id
@@ -9156,7 +9156,7 @@ paths:
put:
tags:
- 'Vertrekken'
- description: Vervangen van een Vertrek
+ summary: Vervangen van een Vertrek
operationId: replaceVertrekById
parameters:
- name: 'id'
@@ -9194,7 +9194,7 @@ paths:
patch:
tags:
- 'Vertrekken'
- description: Wijzigen van een Vertrek
+ summary: Wijzigen van een Vertrek
operationId: updateVertrekById
parameters:
- name: 'id'
@@ -9233,7 +9233,7 @@ paths:
get:
tags:
- 'Wijken'
- description: Ophalen van Wijken
+ summary: Ophalen van Wijken
operationId: listWijken
parameters:
- name: params
@@ -9283,7 +9283,7 @@ paths:
post:
tags:
- 'Wijken'
- description: Voegt een nieuw(e) Wijk toe.
+ summary: Voegt een nieuw(e) Wijk toe.
operationId: createWijk
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9323,7 +9323,7 @@ paths:
put:
tags:
- 'Wijken'
- description: |
+ summary: |
Vervangen van een Wijk op basis van overeenkomstige sleutelvelden.
operationId: replaceWijk
parameters:
@@ -9358,7 +9358,7 @@ paths:
patch:
tags:
- 'Wijken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Wijk. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWijk
@@ -9395,7 +9395,7 @@ paths:
get:
tags:
- 'Wijken'
- description: Retourneert een Wijk met de gegeven identifier
+ summary: Retourneert een Wijk met de gegeven identifier
operationId: readWijkById
parameters:
- name: id
@@ -9432,7 +9432,7 @@ paths:
put:
tags:
- 'Wijken'
- description: Vervangen van een Wijk
+ summary: Vervangen van een Wijk
operationId: replaceWijkById
parameters:
- name: 'id'
@@ -9470,7 +9470,7 @@ paths:
patch:
tags:
- 'Wijken'
- description: Wijzigen van een Wijk
+ summary: Wijzigen van een Wijk
operationId: updateWijkById
parameters:
- name: 'id'
@@ -9509,7 +9509,7 @@ paths:
get:
tags:
- 'Woningwaarderingen'
- description: Ophalen van Woningwaarderingen
+ summary: Ophalen van Woningwaarderingen
operationId: listWoningwaarderingen
parameters:
- name: params
@@ -9559,7 +9559,7 @@ paths:
post:
tags:
- 'Woningwaarderingen'
- description: Voegt een nieuw(e) Woningwaardering toe.
+ summary: Voegt een nieuw(e) Woningwaardering toe.
operationId: createWoningwaardering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9599,7 +9599,7 @@ paths:
put:
tags:
- 'Woningwaarderingen'
- description: |
+ summary: |
Vervangen van een Woningwaardering op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaardering
parameters:
@@ -9634,7 +9634,7 @@ paths:
patch:
tags:
- 'Woningwaarderingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Woningwaardering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaardering
@@ -9671,7 +9671,7 @@ paths:
get:
tags:
- 'Woningwaarderingen'
- description: Retourneert een Woningwaardering met de gegeven identifier
+ summary: Retourneert een Woningwaardering met de gegeven identifier
operationId: readWoningwaarderingById
parameters:
- name: id
@@ -9708,7 +9708,7 @@ paths:
put:
tags:
- 'Woningwaarderingen'
- description: Vervangen van een Woningwaardering
+ summary: Vervangen van een Woningwaardering
operationId: replaceWoningwaarderingById
parameters:
- name: 'id'
@@ -9746,7 +9746,7 @@ paths:
patch:
tags:
- 'Woningwaarderingen'
- description: Wijzigen van een Woningwaardering
+ summary: Wijzigen van een Woningwaardering
operationId: updateWoningwaarderingById
parameters:
- name: 'id'
@@ -9785,7 +9785,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteria'
- description: Ophalen van WoningwaarderingCriteria
+ summary: Ophalen van WoningwaarderingCriteria
operationId: listWoningwaarderingCriteria
parameters:
- name: params
@@ -9835,7 +9835,7 @@ paths:
post:
tags:
- 'WoningwaarderingCriteria'
- description: Voegt een nieuw(e) WoningwaarderingCriterium toe.
+ summary: Voegt een nieuw(e) WoningwaarderingCriterium toe.
operationId: createWoningwaarderingCriterium
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9875,7 +9875,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteria'
- description: |
+ summary: |
Vervangen van een WoningwaarderingCriterium op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingCriterium
parameters:
@@ -9910,7 +9910,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteria'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingCriterium. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingCriterium
@@ -9947,7 +9947,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteria'
- description: Retourneert een WoningwaarderingCriterium met de gegeven identifier
+ summary: Retourneert een WoningwaarderingCriterium met de gegeven identifier
operationId: readWoningwaarderingCriteriumById
parameters:
- name: id
@@ -9984,7 +9984,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteria'
- description: Vervangen van een WoningwaarderingCriterium
+ summary: Vervangen van een WoningwaarderingCriterium
operationId: replaceWoningwaarderingCriteriumById
parameters:
- name: 'id'
@@ -10022,7 +10022,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteria'
- description: Wijzigen van een WoningwaarderingCriterium
+ summary: Wijzigen van een WoningwaarderingCriterium
operationId: updateWoningwaarderingCriteriumById
parameters:
- name: 'id'
@@ -10061,7 +10061,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Ophalen van WoningwaarderingCriteriumGroepen
+ summary: Ophalen van WoningwaarderingCriteriumGroepen
operationId: listWoningwaarderingCriteriumGroepen
parameters:
- name: params
@@ -10111,7 +10111,7 @@ paths:
post:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Voegt een nieuw(e) WoningwaarderingCriteriumGroep toe.
+ summary: Voegt een nieuw(e) WoningwaarderingCriteriumGroep toe.
operationId: createWoningwaarderingCriteriumGroep
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10151,7 +10151,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: |
+ summary: |
Vervangen van een WoningwaarderingCriteriumGroep op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingCriteriumGroep
parameters:
@@ -10186,7 +10186,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingCriteriumGroep. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingCriteriumGroep
@@ -10223,7 +10223,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Retourneert een WoningwaarderingCriteriumGroep met de gegeven identifier
+ summary: Retourneert een WoningwaarderingCriteriumGroep met de gegeven identifier
operationId: readWoningwaarderingCriteriumGroepById
parameters:
- name: id
@@ -10260,7 +10260,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Vervangen van een WoningwaarderingCriteriumGroep
+ summary: Vervangen van een WoningwaarderingCriteriumGroep
operationId: replaceWoningwaarderingCriteriumGroepById
parameters:
- name: 'id'
@@ -10298,7 +10298,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Wijzigen van een WoningwaarderingCriteriumGroep
+ summary: Wijzigen van een WoningwaarderingCriteriumGroep
operationId: updateWoningwaarderingCriteriumGroepById
parameters:
- name: 'id'
@@ -10337,7 +10337,7 @@ paths:
get:
tags:
- 'WoningwaarderingGroepen'
- description: Ophalen van WoningwaarderingGroepen
+ summary: Ophalen van WoningwaarderingGroepen
operationId: listWoningwaarderingGroepen
parameters:
- name: params
@@ -10387,7 +10387,7 @@ paths:
post:
tags:
- 'WoningwaarderingGroepen'
- description: Voegt een nieuw(e) WoningwaarderingGroep toe.
+ summary: Voegt een nieuw(e) WoningwaarderingGroep toe.
operationId: createWoningwaarderingGroep
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10427,7 +10427,7 @@ paths:
put:
tags:
- 'WoningwaarderingGroepen'
- description: |
+ summary: |
Vervangen van een WoningwaarderingGroep op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingGroep
parameters:
@@ -10462,7 +10462,7 @@ paths:
patch:
tags:
- 'WoningwaarderingGroepen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingGroep. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingGroep
@@ -10499,7 +10499,7 @@ paths:
get:
tags:
- 'WoningwaarderingGroepen'
- description: Retourneert een WoningwaarderingGroep met de gegeven identifier
+ summary: Retourneert een WoningwaarderingGroep met de gegeven identifier
operationId: readWoningwaarderingGroepById
parameters:
- name: id
@@ -10536,7 +10536,7 @@ paths:
put:
tags:
- 'WoningwaarderingGroepen'
- description: Vervangen van een WoningwaarderingGroep
+ summary: Vervangen van een WoningwaarderingGroep
operationId: replaceWoningwaarderingGroepById
parameters:
- name: 'id'
@@ -10574,7 +10574,7 @@ paths:
patch:
tags:
- 'WoningwaarderingGroepen'
- description: Wijzigen van een WoningwaarderingGroep
+ summary: Wijzigen van een WoningwaarderingGroep
operationId: updateWoningwaarderingGroepById
parameters:
- name: 'id'
@@ -10613,7 +10613,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Ophalen van WoningwaarderingResultaten
+ summary: Ophalen van WoningwaarderingResultaten
operationId: listWoningwaarderingResultaten
parameters:
- name: params
@@ -10663,7 +10663,7 @@ paths:
post:
tags:
- 'WoningwaarderingResultaten'
- description: Voegt een nieuw(e) WoningwaarderingResultaat toe.
+ summary: Voegt een nieuw(e) WoningwaarderingResultaat toe.
operationId: createWoningwaarderingResultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10703,7 +10703,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Vervangen van een WoningwaarderingResultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingResultaat
parameters:
@@ -10738,7 +10738,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingResultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingResultaat
@@ -10775,7 +10775,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Retourneert een WoningwaarderingResultaat met de gegeven identifier
+ summary: Retourneert een WoningwaarderingResultaat met de gegeven identifier
operationId: readWoningwaarderingResultaatById
parameters:
- name: id
@@ -10812,7 +10812,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: Vervangen van een WoningwaarderingResultaat
+ summary: Vervangen van een WoningwaarderingResultaat
operationId: replaceWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -10850,7 +10850,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: Wijzigen van een WoningwaarderingResultaat
+ summary: Wijzigen van een WoningwaarderingResultaat
operationId: updateWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -10889,7 +10889,7 @@ paths:
get:
tags:
- 'Woonplaatsen'
- description: Ophalen van Woonplaatsen
+ summary: Ophalen van Woonplaatsen
operationId: listWoonplaatsen
parameters:
- name: params
@@ -10939,7 +10939,7 @@ paths:
post:
tags:
- 'Woonplaatsen'
- description: Voegt een nieuw(e) Woonplaats toe.
+ summary: Voegt een nieuw(e) Woonplaats toe.
operationId: createWoonplaats
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10979,7 +10979,7 @@ paths:
put:
tags:
- 'Woonplaatsen'
- description: |
+ summary: |
Vervangen van een Woonplaats op basis van overeenkomstige sleutelvelden.
operationId: replaceWoonplaats
parameters:
@@ -11014,7 +11014,7 @@ paths:
patch:
tags:
- 'Woonplaatsen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Woonplaats. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoonplaats
@@ -11051,7 +11051,7 @@ paths:
get:
tags:
- 'Woonplaatsen'
- description: Retourneert een Woonplaats met de gegeven identifier
+ summary: Retourneert een Woonplaats met de gegeven identifier
operationId: readWoonplaatsById
parameters:
- name: id
@@ -11088,7 +11088,7 @@ paths:
put:
tags:
- 'Woonplaatsen'
- description: Vervangen van een Woonplaats
+ summary: Vervangen van een Woonplaats
operationId: replaceWoonplaatsById
parameters:
- name: 'id'
@@ -11126,7 +11126,7 @@ paths:
patch:
tags:
- 'Woonplaatsen'
- description: Wijzigen van een Woonplaats
+ summary: Wijzigen van een Woonplaats
operationId: updateWoonplaatsById
parameters:
- name: 'id'
@@ -11165,7 +11165,7 @@ paths:
get:
tags:
- 'WozEenheden'
- description: Ophalen van WozEenheden
+ summary: Ophalen van WozEenheden
operationId: listWozEenheden
parameters:
- name: params
@@ -11215,7 +11215,7 @@ paths:
post:
tags:
- 'WozEenheden'
- description: Voegt een nieuw(e) WozEenheid toe.
+ summary: Voegt een nieuw(e) WozEenheid toe.
operationId: createWozEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -11255,7 +11255,7 @@ paths:
put:
tags:
- 'WozEenheden'
- description: |
+ summary: |
Vervangen van een WozEenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceWozEenheid
parameters:
@@ -11290,7 +11290,7 @@ paths:
patch:
tags:
- 'WozEenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WozEenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWozEenheid
@@ -11327,7 +11327,7 @@ paths:
get:
tags:
- 'WozEenheden'
- description: Retourneert een WozEenheid met de gegeven identifier
+ summary: Retourneert een WozEenheid met de gegeven identifier
operationId: readWozEenheidById
parameters:
- name: id
@@ -11364,7 +11364,7 @@ paths:
put:
tags:
- 'WozEenheden'
- description: Vervangen van een WozEenheid
+ summary: Vervangen van een WozEenheid
operationId: replaceWozEenheidById
parameters:
- name: 'id'
@@ -11402,7 +11402,7 @@ paths:
patch:
tags:
- 'WozEenheden'
- description: Wijzigen van een WozEenheid
+ summary: Wijzigen van een WozEenheid
operationId: updateWozEenheidById
parameters:
- name: 'id'
@@ -11441,7 +11441,7 @@ paths:
get:
tags:
- 'ZekerheidVerpandingen'
- description: Ophalen van ZekerheidVerpandingen
+ summary: Ophalen van ZekerheidVerpandingen
operationId: listZekerheidVerpandingen
parameters:
- name: params
@@ -11491,7 +11491,7 @@ paths:
post:
tags:
- 'ZekerheidVerpandingen'
- description: Voegt een nieuw(e) ZekerheidVerpanding toe.
+ summary: Voegt een nieuw(e) ZekerheidVerpanding toe.
operationId: createZekerheidVerpanding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -11531,7 +11531,7 @@ paths:
put:
tags:
- 'ZekerheidVerpandingen'
- description: |
+ summary: |
Vervangen van een ZekerheidVerpanding op basis van overeenkomstige sleutelvelden.
operationId: replaceZekerheidVerpanding
parameters:
@@ -11566,7 +11566,7 @@ paths:
patch:
tags:
- 'ZekerheidVerpandingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ZekerheidVerpanding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZekerheidVerpanding
@@ -11603,7 +11603,7 @@ paths:
get:
tags:
- 'ZekerheidVerpandingen'
- description: Retourneert een ZekerheidVerpanding met de gegeven identifier
+ summary: Retourneert een ZekerheidVerpanding met de gegeven identifier
operationId: readZekerheidVerpandingById
parameters:
- name: id
@@ -11640,7 +11640,7 @@ paths:
put:
tags:
- 'ZekerheidVerpandingen'
- description: Vervangen van een ZekerheidVerpanding
+ summary: Vervangen van een ZekerheidVerpanding
operationId: replaceZekerheidVerpandingById
parameters:
- name: 'id'
@@ -11678,7 +11678,7 @@ paths:
patch:
tags:
- 'ZekerheidVerpandingen'
- description: Wijzigen van een ZekerheidVerpanding
+ summary: Wijzigen van een ZekerheidVerpanding
operationId: updateZekerheidVerpandingById
parameters:
- name: 'id'
@@ -11750,10 +11750,100 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Vastgoed.All.Read: alleen lezen van alle resources
+ Vastgoed.All.ReadWrite: lezen en schrijven van alle resources
+ Vastgoed.Adressen.Read: alleen lezen van Adressen
+ Vastgoed.Adressen.ReadWrite: lezen en schrijven van Adressen
+ Vastgoed.AdresseerbareObjectenBasisregistratie.Read: alleen lezen van AdresseerbareObjectenBasisregistratie
+ Vastgoed.AdresseerbareObjectenBasisregistratie.ReadWrite: lezen en schrijven van AdresseerbareObjectenBasisregistratie
+ Vastgoed.BagAdressen.Read: alleen lezen van BagAdressen
+ Vastgoed.BagAdressen.ReadWrite: lezen en schrijven van BagAdressen
+ Vastgoed.BagPanden.Read: alleen lezen van BagPanden
+ Vastgoed.BagPanden.ReadWrite: lezen en schrijven van BagPanden
+ Vastgoed.BagWoonplaatsen.Read: alleen lezen van BagWoonplaatsen
+ Vastgoed.BagWoonplaatsen.ReadWrite: lezen en schrijven van BagWoonplaatsen
+ Vastgoed.Beleidswaarden.Read: alleen lezen van Beleidswaarden
+ Vastgoed.Beleidswaarden.ReadWrite: lezen en schrijven van Beleidswaarden
+ Vastgoed.Bouwdelen.Read: alleen lezen van Bouwdelen
+ Vastgoed.Bouwdelen.ReadWrite: lezen en schrijven van Bouwdelen
+ Vastgoed.BouwkundigElementen.Read: alleen lezen van BouwkundigElementen
+ Vastgoed.BouwkundigElementen.ReadWrite: lezen en schrijven van BouwkundigElementen
+ Vastgoed.BuitenlandsAdressen.Read: alleen lezen van BuitenlandsAdressen
+ Vastgoed.BuitenlandsAdressen.ReadWrite: lezen en schrijven van BuitenlandsAdressen
+ Vastgoed.Buurten.Read: alleen lezen van Buurten
+ Vastgoed.Buurten.ReadWrite: lezen en schrijven van Buurten
+ Vastgoed.Clusters.Read: alleen lezen van Clusters
+ Vastgoed.Clusters.ReadWrite: lezen en schrijven van Clusters
+ Vastgoed.CollectiefObjecten.Read: alleen lezen van CollectiefObjecten
+ Vastgoed.CollectiefObjecten.ReadWrite: lezen en schrijven van CollectiefObjecten
+ Vastgoed.Conditiemetingen.Read: alleen lezen van Conditiemetingen
+ Vastgoed.Conditiemetingen.ReadWrite: lezen en schrijven van Conditiemetingen
+ Vastgoed.Eenheden.Read: alleen lezen van Eenheden
+ Vastgoed.Eenheden.ReadWrite: lezen en schrijven van Eenheden
+ Vastgoed.Eenheidadressen.Read: alleen lezen van Eenheidadressen
+ Vastgoed.Eenheidadressen.ReadWrite: lezen en schrijven van Eenheidadressen
+ Vastgoed.Eenheidcriteria.Read: alleen lezen van Eenheidcriteria
+ Vastgoed.Eenheidcriteria.ReadWrite: lezen en schrijven van Eenheidcriteria
+ Vastgoed.EenheidToestanden.Read: alleen lezen van EenheidToestanden
+ Vastgoed.EenheidToestanden.ReadWrite: lezen en schrijven van EenheidToestanden
+ Vastgoed.EenheidVoorwaardes.Read: alleen lezen van EenheidVoorwaardes
+ Vastgoed.EenheidVoorwaardes.ReadWrite: lezen en schrijven van EenheidVoorwaardes
+ Vastgoed.Energieprestaties.Read: alleen lezen van Energieprestaties
+ Vastgoed.Energieprestaties.ReadWrite: lezen en schrijven van Energieprestaties
+ Vastgoed.Garanties.Read: alleen lezen van Garanties
+ Vastgoed.Garanties.ReadWrite: lezen en schrijven van Garanties
+ Vastgoed.Gebouwen.Read: alleen lezen van Gebouwen
+ Vastgoed.Gebouwen.ReadWrite: lezen en schrijven van Gebouwen
+ Vastgoed.Gemeenten.Read: alleen lezen van Gemeenten
+ Vastgoed.Gemeenten.ReadWrite: lezen en schrijven van Gemeenten
+ Vastgoed.Geometrieen.Read: alleen lezen van Geometrieen
+ Vastgoed.Geometrieen.ReadWrite: lezen en schrijven van Geometrieen
+ Vastgoed.KadasterPercelen.Read: alleen lezen van KadasterPercelen
+ Vastgoed.KadasterPercelen.ReadWrite: lezen en schrijven van KadasterPercelen
+ Vastgoed.Marktwaarden.Read: alleen lezen van Marktwaarden
+ Vastgoed.Marktwaarden.ReadWrite: lezen en schrijven van Marktwaarden
+ Vastgoed.Panden.Read: alleen lezen van Panden
+ Vastgoed.Panden.ReadWrite: lezen en schrijven van Panden
+ Vastgoed.Postadressen.Read: alleen lezen van Postadressen
+ Vastgoed.Postadressen.ReadWrite: lezen en schrijven van Postadressen
+ Vastgoed.Punten.Read: alleen lezen van Punten
+ Vastgoed.Punten.ReadWrite: lezen en schrijven van Punten
+ Vastgoed.Renovaties.Read: alleen lezen van Renovaties
+ Vastgoed.Renovaties.ReadWrite: lezen en schrijven van Renovaties
+ Vastgoed.Ruimten.Read: alleen lezen van Ruimten
+ Vastgoed.Ruimten.ReadWrite: lezen en schrijven van Ruimten
+ Vastgoed.Stadsdelen.Read: alleen lezen van Stadsdelen
+ Vastgoed.Stadsdelen.ReadWrite: lezen en schrijven van Stadsdelen
+ Vastgoed.Taxaties.Read: alleen lezen van Taxaties
+ Vastgoed.Taxaties.ReadWrite: lezen en schrijven van Taxaties
+ Vastgoed.Vertrekken.Read: alleen lezen van Vertrekken
+ Vastgoed.Vertrekken.ReadWrite: lezen en schrijven van Vertrekken
+ Vastgoed.Wijken.Read: alleen lezen van Wijken
+ Vastgoed.Wijken.ReadWrite: lezen en schrijven van Wijken
+ Vastgoed.Woningwaarderingen.Read: alleen lezen van Woningwaarderingen
+ Vastgoed.Woningwaarderingen.ReadWrite: lezen en schrijven van Woningwaarderingen
+ Vastgoed.WoningwaarderingCriteria.Read: alleen lezen van WoningwaarderingCriteria
+ Vastgoed.WoningwaarderingCriteria.ReadWrite: lezen en schrijven van WoningwaarderingCriteria
+ Vastgoed.WoningwaarderingCriteriumGroepen.Read: alleen lezen van WoningwaarderingCriteriumGroepen
+ Vastgoed.WoningwaarderingCriteriumGroepen.ReadWrite: lezen en schrijven van WoningwaarderingCriteriumGroepen
+ Vastgoed.WoningwaarderingGroepen.Read: alleen lezen van WoningwaarderingGroepen
+ Vastgoed.WoningwaarderingGroepen.ReadWrite: lezen en schrijven van WoningwaarderingGroepen
+ Vastgoed.WoningwaarderingResultaten.Read: alleen lezen van WoningwaarderingResultaten
+ Vastgoed.WoningwaarderingResultaten.ReadWrite: lezen en schrijven van WoningwaarderingResultaten
+ Vastgoed.Woonplaatsen.Read: alleen lezen van Woonplaatsen
+ Vastgoed.Woonplaatsen.ReadWrite: lezen en schrijven van Woonplaatsen
+ Vastgoed.WozEenheden.Read: alleen lezen van WozEenheden
+ Vastgoed.WozEenheden.ReadWrite: lezen en schrijven van WozEenheden
+ Vastgoed.ZekerheidVerpandingen.Read: alleen lezen van ZekerheidVerpandingen
+ Vastgoed.ZekerheidVerpandingen.ReadWrite: lezen en schrijven van ZekerheidVerpandingen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Vastgoed.All.Read: alleen lezen van alle resources
Vastgoed.All.ReadWrite: lezen en schrijven van alle resources
@@ -11922,7 +12012,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -11934,7 +12024,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -12014,7 +12104,7 @@ components:
$ref: '#/components/schemas/Referentiedata'
bagHoofdadres:
allOf:
- - $ref: '#/components/schemas/Adres'
+ - $ref: '#/components/schemas/Adres-sleutels'
description: Het hoofdadres van het adresseerbaar object uit de basisregistratie.
bagIdentificatie:
type: string
@@ -12027,7 +12117,7 @@ components:
description: De adressen die gerelateerd zijn aan het adresseerbaar object uit de basisregistratie. Het hoofdadres maakt geen deel uit van deze collectie.
type: array
items:
- $ref: '#/components/schemas/Adres'
+ $ref: '#/components/schemas/Adres-sleutels'
bagOfficieel:
type: boolean
description: De aanduiding waarmee kan worden aangegeven dat een object in de basisregistratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
@@ -12039,20 +12129,16 @@ components:
description: De panden die gerelateerd zijn aan het adresseerbaar object uit de basisregistratie.
type: array
items:
- $ref: '#/components/schemas/Pand'
+ $ref: '#/components/schemas/Pand-sleutels'
bagStatus:
type: string
format: any
description: De fase van de levenscyclus van een standplaats, ligplaats of verblijfsobject waarin het betreffende object zich bevindt.
geometrie:
allOf:
- - $ref: '#/components/schemas/Geometrie'
+ - $ref: '#/components/schemas/Geometrie-sleutels'
description: De geometrie van het adresseerbaar object uit de basisregistratie.
- Pandbericht:
- allOf:
- - $ref: '#/components/schemas/Pand'
- - $ref: '#/components/schemas/Bericht-basis'
- Pand:
+ Adres-sleutels:
type: object
properties:
id:
@@ -12071,49 +12157,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van het pand volgens de eigenaar. Referentiedatasoort PANDSTATUS.
- adresseerbareObjectenBasisregistratie:
- description: De adresseerbare objecten uit de basisregistratie behorend bij het pand.
- type: array
- items:
- $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
- bag:
- allOf:
- - $ref: '#/components/schemas/BagPand'
- description: Verwijzing naar de BAG details behorende bij het pand.
- bouwdelen:
- description: De bouwdelen behorend bij het pand.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel'
- eenheden:
- description: De eenheden behorend bij het pand. De eenheden zijn onderdeel van het pand.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
- gebouw:
- allOf:
- - $ref: '#/components/schemas/Gebouw'
- description: Het gebouw behorend bij het pand.
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van het pand.
- kavelOppervlakte:
- type: number
- format: float
- description: De oppervlakte van het kavel van het pand.
- liftAanwezig:
- type: boolean
- description: De aanduiding geeft aan of in het pand in lift aanwezig is.
- renovatie:
- allOf:
- - $ref: '#/components/schemas/Renovatie'
- description: Verwijzing naar de laatste renovatie details van het pand.
- AdresseerbaarObjectBasisregistratie-sleutels:
+ Pand-sleutels:
type: object
properties:
id:
@@ -12132,11 +12176,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- BagPandbericht:
- allOf:
- - $ref: '#/components/schemas/BagPand'
- - $ref: '#/components/schemas/Bericht-basis'
- BagPand:
+ Geometrie-sleutels:
type: object
properties:
id:
@@ -12155,29 +12195,15 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bagIdentificatie:
- type: string
- format: any
- description: Het BAG registratienummer van het pand zoals bekend is bij de BAG.
- bagStatus:
- type: string
- format: any
- description: De fase van de levenscyclus van een pand, waarin het betreffende pand zich bevindt. Dit attribuut is afkomstig uit de BAG.
- bagInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de basisregistratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- bagBouwdatum:
- type: string
- format: date
- description: De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig gereed is opgeleverd.
- Bouwdeelbericht:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
+ BagAdresbericht:
allOf:
- - $ref: '#/components/schemas/Bouwdeel'
+ - $ref: '#/components/schemas/BagAdres'
- $ref: '#/components/schemas/Bericht-basis'
- Bouwdeel:
+ BagAdres:
type: object
properties:
id:
@@ -12196,43 +12222,39 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ bagNummeraanduidingIdentificatie:
type: string
format: any
- description: De naam van het bouwdeel.
- omschrijving:
+ description: De unieke aanduiding van een nummeraanduiding.
+ bagOpenbareRuimteIdentificatie:
type: string
format: any
- description: De omschrijving van het bouwdeel.
- bouwdelen:
- description: De bouwdelen behorend bij het bouwdeel, zodat een bouwdeel kan bestaan uit bouwdelen.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- bouwkundigeElementen:
- description: De bouwkundige elementen behorend bij het bouwdeel.
- type: array
- items:
- $ref: '#/components/schemas/BouwkundigElement'
- collectieveObjecten:
- description: De collectieve objecten behorend bij het bouwdeel.
- type: array
- items:
- $ref: '#/components/schemas/CollectiefObject'
- eenheden:
- description: De eenheden behorend bij het bouwdeel.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
- gebouw:
- allOf:
- - $ref: '#/components/schemas/Gebouw'
- description: Het gebouw behorend bij het bouwdeel.
- pand:
- allOf:
- - $ref: '#/components/schemas/Pand-sleutels'
- description: Het pand behorend bij het bouwdeel.
- Bouwdeel-sleutels:
+ description: De unieke aanduiding van een openbare ruimte.
+ bagNummeraanduidingInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagNummeraanduidingOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ bagNummeraanduidingStatus:
+ type: string
+ format: any
+ description: De fase van de levenscyclus van een nummeraanduiding, waarin de betreffende nummeraanduiding zich bevindt.
+ bagOpenbareRuimteInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagOpenbareruimteOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ bagOpenbareruimtestatus:
+ type: string
+ format: any
+ description: De fase van de levenscyclus van een openbare ruimte, waarin de betreffende openbare ruimte zich bevindt.
+ BagPandbericht:
+ allOf:
+ - $ref: '#/components/schemas/BagPand'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BagPand:
type: object
properties:
id:
@@ -12251,11 +12273,29 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- BouwkundigElementbericht:
+ bagIdentificatie:
+ type: string
+ format: any
+ description: Het BAG registratienummer van het pand zoals bekend is bij de BAG.
+ bagStatus:
+ type: string
+ format: any
+ description: De fase van de levenscyclus van een pand, waarin het betreffende pand zich bevindt. Dit attribuut is afkomstig uit de BAG.
+ bagInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de basisregistratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ bagBouwdatum:
+ type: string
+ format: date
+ description: De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig gereed is opgeleverd.
+ BagWoonplaatsbericht:
allOf:
- - $ref: '#/components/schemas/BouwkundigElement'
+ - $ref: '#/components/schemas/BagWoonplaats'
- $ref: '#/components/schemas/Bericht-basis'
- BouwkundigElement:
+ BagWoonplaats:
type: object
properties:
id:
@@ -12274,64 +12314,25 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ bagIdentificatie:
type: string
format: any
- description: De naam van het bouwkundig element.
- omschrijving:
+ description: De landelijk unieke aanduiding van een woonplaats, zoals vastgesteld door de beheerder van de landelijke tabel voor woonplaatsen.
+ bagStatus:
type: string
format: any
- description: De omschrijving van het bouwkundig element.
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTDETAILSOORT.
- begindatum:
- type: string
- format: date
- description: De begindatum van het bouwkundige element.
- einddatum:
- type: string
- format: date
- description: De einddatum het bouwkundige element
- bouwdeel:
- allOf:
- - $ref: '#/components/schemas/Bouwdeel-sleutels'
- description: Het bouwdeel behorend bij het bouwkundig element.
- garanties:
- description: De garanties behorend bij het bouwkundig element.
- type: array
- items:
- $ref: '#/components/schemas/Garantie'
- locatie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De locatie waar het bouwkundig element zich bevindt. Bijvoorbeeld huiskamer of toilet. Referentiedatasoort DEFECTLOCATIE.
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- plaatsing:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Op welke wijze het bouwkundig element is aangebracht. Bijv. bij de bouw, renovatie, onderhoud of door huurder. Referentiedatasoort BOUWKUNDIGELEMENTPLAATSING.
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Garantiebericht:
+ description: De fase van de levenscyclus van een woonplaats, waarin de betreffende woonplaats zich bevindt.
+ bagInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ Beleidswaardebericht:
allOf:
- - $ref: '#/components/schemas/Garantie'
+ - $ref: '#/components/schemas/Beleidswaarde'
- $ref: '#/components/schemas/Bericht-basis'
- Garantie:
+ Beleidswaarde:
type: object
properties:
id:
@@ -12350,52 +12351,74 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
+ achterstalligOnderhoud:
+ type: number
+ format: float
+ description: Bedrag aan achterstallig onderhoud dat als correctie is toegepast.
+ afkoopErfpacht:
+ type: number
+ format: float
+ description: Het bedrag aan afkoop erfpacht dat als correctie is toegepast.
+ beheerAfslag:
+ type: number
+ format: float
+ description: 'Beheer (beheer): eventuele extra beheeruitgaven die gepaard gaan met de sociale doelgroep.'
+ beheerskosten:
+ type: number
+ format: float
+ description: Beheerkosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
+ beschikbaarheidAfslag:
+ type: number
+ format: float
+ description: 'Beschikbaarheid (doorexploiteren): in stand houden van een sociale portefeuille.'
+ betaalbaarheidAfslag:
+ type: number
+ format: float
+ description: 'Betaalbaarheid (huur): in stand houden van sociale huurprijzen passend bij de doelgroep.'
+ eenheid-sleutels:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarvoor de beleidswaarde is vastgelegd. Deze relatie is redundant omdat deze ook via de klasse Marktwaarde gelegd wordt (inclusief verslagjaar). Deze redundante relatie is ten behoeve van gemak bij mogelijke rapportages
+ kwaliteitAfslag:
+ type: number
+ format: float
+ description: 'Kwaliteit (onderhoud): eventuele extra onderhoudsuitgaven voor het op lange termijn in stand houden van de portefeuille.'
+ marktwaarde:
+ allOf:
+ - $ref: '#/components/schemas/Marktwaarde-sleutels'
+ description: De verwijzing naar de marktwaarde die ten grondslag ligt aan deze beleidswaarde.
+ onderhoudskosten:
+ type: number
+ format: float
+ description: Onderhoudskosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
+ streefhuur:
+ type: number
+ format: float
+ description: Actuele streefhuur op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
+ waarde:
+ type: number
+ format: float
+ description: 'De beleidswaarde van de eenheid waarde die rekening houdt met het beleid van de corporatie. Marktwaarde minus de afslagen voor beschikbaarheid, betaalbaarheid, kwaliteit en beheer, vormt de beleidswaarde (bron beleidswaarde WSW). Let op: het verslagjaar waarvoor de beleidswaarde is bepaald is het verslagjaar van de marktwaarde die de grondslag vormt van de beleidswaarde.'
+ Eenheid-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van de garantie.
- begindatum:
- type: string
- format: date
- description: De begindatum van de garantie.
- einddatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De einddatum van de garantie.
- bouwdelen:
- description: De bouwdelen behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- bouwkundigeElementen:
- description: De bouwkundige elementen behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/BouwkundigElement-sleutels'
- clusters:
- description: De clusters behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/Cluster'
- collectieveObjecten:
- description: De collectieve objecten behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/CollectiefObject'
- eenheden:
- description: De eenheden behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
- overeenkomst:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- relatie:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- BouwkundigElement-sleutels:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Marktwaarde-sleutels:
type: object
properties:
id:
@@ -12414,11 +12437,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Clusterbericht:
+ Bouwdeelbericht:
allOf:
- - $ref: '#/components/schemas/Cluster'
+ - $ref: '#/components/schemas/Bouwdeel'
- $ref: '#/components/schemas/Bericht-basis'
- Cluster:
+ Bouwdeel:
type: object
properties:
id:
@@ -12437,66 +12460,43 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort cluster. Bijvoorbeeld, nieuwbouwcluster, onderhoudscluster, financieel cluster. Referentiedatasoort CLUSTERSOORT.
naam:
type: string
format: any
- description: De naam van de cluster.
+ description: De naam van het bouwdeel.
omschrijving:
type: string
format: any
- description: De omschrijving van de cluster.
- bovenliggendeCluster:
- allOf:
- - $ref: '#/components/schemas/Cluster-sleutels'
- description: Het bovenliggende / overkoepelende cluster waar dit cluster eventueel onderdeel van is.
- begindatum:
- type: string
- format: date
- description: De begindatum van de cluster.
- einddatum:
- type: string
- format: date
- description: De einddatum van de cluster.
- collectieveObjecten:
- description: De collectieve objecten behorend bij de cluster.
- type: array
- items:
- $ref: '#/components/schemas/CollectiefObject'
- conditiemeting:
- allOf:
- - $ref: '#/components/schemas/Conditiemeting'
- description: Aan een cluster kunnen meerdere conditiescores conform de NEN 2767 gekoppeld worden (per tijdvak).
- eenheden:
- description: De eenheden behorend bij de cluster.
+ description: De omschrijving van het bouwdeel.
+ bouwdelen:
+ description: De bouwdelen behorend bij het bouwdeel, zodat een bouwdeel kan bestaan uit bouwdelen.
type: array
items:
- $ref: '#/components/schemas/Eenheid'
- garanties:
- description: De garanties behorend bij de cluster.
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ bouwkundigeElementen:
+ description: De bouwkundige elementen behorend bij het bouwdeel.
type: array
items:
- $ref: '#/components/schemas/Garantie-sleutels'
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de cluster.
- overeenkomsten:
+ $ref: '#/components/schemas/BouwkundigElement-sleutels'
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij het bouwdeel.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- relaties:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ eenheden:
+ description: De eenheden behorend bij het bouwdeel.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Cluster-sleutels:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ gebouw:
+ allOf:
+ - $ref: '#/components/schemas/Gebouw-sleutels'
+ description: Het gebouw behorend bij het bouwdeel.
+ pand:
+ allOf:
+ - $ref: '#/components/schemas/Pand-sleutels'
+ description: Het pand behorend bij het bouwdeel.
+ Bouwdeel-sleutels:
type: object
properties:
id:
@@ -12515,15 +12515,68 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ BouwkundigElement-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De naam van de cluster.
- CollectiefObjectbericht:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ CollectiefObject-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Gebouw-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ BouwkundigElementbericht:
allOf:
- - $ref: '#/components/schemas/CollectiefObject'
+ - $ref: '#/components/schemas/BouwkundigElement'
- $ref: '#/components/schemas/Bericht-basis'
- CollectiefObject:
+ BouwkundigElement:
type: object
properties:
id:
@@ -12542,55 +12595,60 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van het bouwkundig element.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het bouwkundig element.
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Bijvoorbeeld: fietsenstalling, galerij, lift etc. Referentiedatasoort COLLECTIEFOBJECTSOORT.'
- naam:
+ description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTDETAILSOORT.
+ begindatum:
type: string
- format: any
- description: De naam van het collectief object.
- adres:
+ format: date
+ description: De begindatum van het bouwkundige element.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum het bouwkundige element
+ bouwdeel:
allOf:
- - $ref: '#/components/schemas/Adres'
- description: Aan een Collectief Object kan een adres gekoppeld worden zodat een specifieke locatie opgenomen kan worden. Met name bij onderhoudswerkzaamheden is dit wenselijk.
- bouwdelen:
- description: De bouwdelen behorend bij het collectief object.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- clusters:
- description: De clusters behorend bij het collectief object.
- type: array
- items:
- $ref: '#/components/schemas/Cluster-sleutels'
- eenheden:
- description: De eenheden behorend bij het collectief object.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
+ - $ref: '#/components/schemas/Bouwdeel-sleutels'
+ description: Het bouwdeel behorend bij het bouwkundig element.
garanties:
- description: De garanties behorend bij het collectief object.
+ description: De garanties behorend bij het bouwkundig element.
type: array
items:
$ref: '#/components/schemas/Garantie-sleutels'
+ locatie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De locatie waar het bouwkundig element zich bevindt. Bijvoorbeeld huiskamer of toilet. Referentiedatasoort DEFECTLOCATIE.
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ plaatsing:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Op welke wijze het bouwkundig element is aangebracht. Bijv. bij de bouw, renovatie, onderhoud of door huurder. Referentiedatasoort BOUWKUNDIGELEMENTPLAATSING.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Eenheidbericht:
- allOf:
- - $ref: '#/components/schemas/Eenheid'
- - $ref: '#/components/schemas/Bericht-basis'
- Eenheid:
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ Garantie-sleutels:
type: object
properties:
id:
@@ -12609,393 +12667,942 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De dienstverlening (soort) die geboden kan worden met de eenheid. Voorbeeld: Woonruimte, Bedrijfsruimte, Parkeergelegenheid. Referentiedatasoort EENHEIDSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het type van de eenheid. Bijvoorbeeld: Hoekwoning, Tussenwoning, Flat, Maisonnette. Hiervoor wordt de lijst van de waarderingskamer als uitgangspunt genomen. Referentiedatasoort EENHEIDDETAILSOORT.'
- naam:
+ BuitenlandsAdresbericht:
+ allOf:
+ - $ref: '#/components/schemas/BuitenlandsAdres'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BuitenlandsAdres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-basis'
+ - type: object
+ properties:
+ adresregel1:
+ type: string
+ format: any
+ description: Adresregel in verband met een buitenlands adres.
+ adresregel2:
+ type: string
+ format: any
+ description: Adresregel in verband met een buitenlands adres.
+ land:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ postbusnummer:
+ type: string
+ format: any
+ description: Het postbusnummer behorende bij het adres
+ provincie:
+ type: string
+ format: any
+ description: De provincie behorend bij het adres.
+ woonplaats:
+ type: string
+ format: any
+ description: De woonplaats waarin het adres zich bevindt.
+ Buurtbericht:
+ allOf:
+ - $ref: '#/components/schemas/Buurt'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Buurt:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De naam van de eenheid.
- omschrijving:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: De omschrijving van de eenheid.
- bouwnummer:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: Het bouwnummer behorende bij de eenheid. Dit wordt aan een eenheid toegekend bij nieuwbouw van de eenheid. Vaak is op dat moment het adres van de eenheid nog niet bepaald.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De status van de eenheid, bijvoorbeeld: Leegstand, Uit beheer, Renovatie, Verhuurd, Verkocht Referentiedatasoort EENHEIDSTATUS.'
- detailStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De detailstatus (ook wel substatus) van een status. De detailstatus geeft een extra reden op van de eenheid status die de eenheid heeft. Bijvoorbeeld: de status is Renovatie, de detailstatus geeft aan dat het om planmatig onderhoud gaat. Referentiedatasoort EENHEIDDETAILSTATUS.'
- inExploitatiedatum:
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: date
- description: De datum waarop de eenheid in exploitatie is gegaan. We spreken over exploitatie als de eenheid in beheer is met als doel dat er resultaat wordt behaald.
- uitExploitatiedatum:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
type: string
- format: date
- description: De datum waarop de eenheid uit exploitatie is gegaan, zowel het beheer als andere activiteiten stoppen.
- beginBouwdatum:
+ format: any
+ description: De naam van de buurt.
+ omschrijving:
type: string
- format: date
- description: De begindatum van de bouw van de eenheid.
- bouwjaar:
- type: integer
- format: int32
- description: Het bouwjaar waarin de bouw van de eenheid is afgerond.
- opleverdatum:
- type: string
- format: date
- description: De opleverdatum van de eenheid. De bouw van de eenheid is dan gereed of de eenheid is beschikbaar voor een volgende gebruiker.
- aantalOnzelfstandigeEenheden:
- type: integer
- format: int32
- description: Het aantal onzelfstandige eenheden (units, kamers) dat binnen de als geheel verhuurde eenheid valt. Bedoeld om het aantal onzelfstandige eenheden te kunnen verantwoorden in (verplichte) rapportages zoals dVi. Het attribuut wordt gebruikt als slechts één eenheid (met één huurovereenkomst) in het administratieve systeem is vastgelegd, in plaats van de (door VERA geadviseerde) registratie van alle eenheden met een bovenliggendeEenheid.
- aanvullendeDoelgroep:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De aanvullende doelgroep waarvoor de woning het meest geschikt is en waarvoor meestal ook voorrang wordt verleend. Bijv. Ouderen, Geestelijk gehandicapten, Lichamelijk gehandicapten, GGZ-Patiënten etc. Eventueel te gebruiken in combinatie met doelgroep. Referentiedatasoort AANVULLENDEDOELGROEP.
- adres:
- allOf:
- - $ref: '#/components/schemas/Adres'
- description: Het adres van de eenheid.
- adresseerbaarObjectBasisregistratie:
- allOf:
- - $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
- description: Het adresseerbare object uit de BAG die overeenkomt met de eenheid.
- beleidswaarde:
- description: De beleidswaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
- type: array
- items:
- $ref: '#/components/schemas/Beleidswaarde'
- benodigdeAfspraakverzoeken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Afspraakverzoek in informatiedomein Relaties
- beoogdUitExploitatieDatum:
- type: string
- format: date
- description: Verwachte datum waarop de eenheid aan het bezit zal worden onttrokken door sloop of verkoop.
- bestemming:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Door de corporatie bepaalde bestemming van de eenheid bij mutatie (sloop, verkoop, huur). In AddresseerbaarObjectRegistratie wordt met het attribuut gebruiksdoel aangegeven wat volgens de gemeente het gebruiksdoel van de eenheid is (wonen, werken, zorg, enz.) Referentiedatasoort BESTEMMING.
- bouwdelen:
- description: Het bouwdelen behorend bij de eenheid
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- bovenliggendeEenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De bovenliggende eenheid waarvan de eenheid onderdeel van uit maakt.
- brutohuur:
- type: number
- format: float
- description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
- buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- clusters:
- description: De clusters waar de eenheid onderdeel van uitmaakt.
- type: array
- items:
- $ref: '#/components/schemas/Cluster-sleutels'
- collectieveObjecten:
- description: De collectieve objecten behorend bij de eenheid.
+ format: any
+ description: De omschrijving van de buurt.
+ eenheden:
+ description: De eenheden behorend bij de buurt.
type: array
items:
- $ref: '#/components/schemas/CollectiefObject-sleutels'
- criteria:
- description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid.
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ gebouwen:
+ description: De gebouwen behorend bij de buurt.
type: array
items:
- $ref: '#/components/schemas/Eenheidcriterium'
- doelgroep:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De doelgroep waarvoor de eenheid bestemd is, bijv. zorgwoning, jongerenwoning, seniorenwoning, eengezinswoning, starterswoning etc. Eventueel te gebruiken in combinatie met aanvullendeDoelgroep. Referentiedatasoort DOELGROEP.
- energieprestatie:
+ $ref: '#/components/schemas/Gebouw-sleutels'
+ geometrie:
allOf:
- - $ref: '#/components/schemas/Energieprestatie'
- description: De huidige energieprestatie van de eenheid. OBSOLETE
- deprecated: true
- energieprestaties:
- description: De huidige energieprestatie(s) van de eenheid.
- type: array
- items:
- $ref: '#/components/schemas/Energieprestatie'
- energievoorzieningen:
- description: Voorzieningen met betrekking tot energie zoals zonnepanelen en oplaadpunten Referentiedatasoort EENHEIDENERGIEVOORZIENING.
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de buurt.
+ relaties:
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- etage:
- type: integer
- format: int32
- description: De etage waarop de eenheid zich bevindt.
- gebouw:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ wijk:
allOf:
- - $ref: '#/components/schemas/Gebouw'
- description: Het gebouw waaruit de eenheid onderdeel van maakt.
- gebruiksoppervlakte:
- type: integer
- format: int32
- description: De gebruiksoppervlakte van een eenheid(verblijfsobject) in gehele vierkante meters, gemeten conform NEN 2580. Te gebruiken voor verantwoording dVi. Naast gebruiksoppervlakte is ook een attribuut totaleOppervlakte beschikbaar.
- inExploitatieReden:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De wijk behorend bij de buurt.
+ Wijk-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de wijk.
+ Clusterbericht:
+ allOf:
+ - $ref: '#/components/schemas/Cluster'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Cluster:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het in exploitatie nemen van een eenheid. Bijvoorbeeld: verhuur of beheer namens andere eigenaren. Referentiedatasoort INEXPLOITATIEREDEN.'
- interieur:
- description: Binnenruimte van de woning zoals gemeubileerd en vloerbedekking in de woonkamer. Referentiedatasoort EENHEIDINTERIEUR.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- isolatie:
- description: Getroffen isolatie maatregelen in de eenheid. Referentiedatasoort EENHEIDISOLATIE.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- juridischEigendomspercentage:
- type: integer
- format: int32
- description: Het percentage juridisch eigendom zoals vastgelegd in de eigendomsakte.
- kadastraalNummer:
+ description: Het soort cluster. Bijvoorbeeld, nieuwbouwcluster, onderhoudscluster, financieel cluster. Referentiedatasoort CLUSTERSOORT.
+ naam:
type: string
format: any
- description: Het kadastraalnummer behorend bij de eenheid.
- kamersAantal:
- type: integer
- format: int32
- description: Het aantal leefruimten en slaapkamers behorende bij de eenheid.
- klimaatbeheersing:
- description: Verzameling van kenmerken die het binnenklimaat (lucht, warmte en koeling) regelen in de eenheid. Referentiedatasoort EENHEIDKLIMAATBEHEERSING.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- kwaliteitsniveau:
+ description: De naam van de cluster.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de cluster.
+ bovenliggendeCluster:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het kwaliteitsniveau van de eenheid. Referentiedatasoort KWALITEITSNIVEAU.
- ligging:
- description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg en vrij uitzicht Referentiedatasoort EENHEIDLIGGING.'
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- liggingBuitenruimten:
- description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ - $ref: '#/components/schemas/Cluster-sleutels'
+ description: Het bovenliggende / overkoepelende cluster waar dit cluster eventueel onderdeel van is.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de cluster.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de cluster.
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij de cluster.
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- maatschappelijkLabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort de eenheid tot de DAEB-tak of tot de niet-DAEB-tak. Het label op de eenheid kan afwijken van het maatschappelijk label van de huurovereenkomst. Hiermee kan worden aangegeven dat een eenheid die behoort tot de niet-DAEB tak als DAEB-verhuring verantwoord moet worden. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
- marktlabel:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ conditiemeting:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het marklabel wordt gebruikt om het strategisch voorraadbeleid vast te leggen. Referentiedatasoort MARKTLABEL.
- marktwaarde:
- description: De marktwaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
- type: array
- items:
- $ref: '#/components/schemas/Marktwaarde'
- monumenten:
- description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort EENHEIDMONUMENT.
+ - $ref: '#/components/schemas/Conditiemeting-sleutels'
+ description: Aan een cluster kunnen meerdere conditiescores conform de NEN 2767 gekoppeld worden (per tijdvak).
+ eenheden:
+ description: De eenheden behorend bij de cluster.
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- nevenadressen:
- description: De nevenadressen van de eenheid.
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ garanties:
+ description: De garanties behorend bij de cluster.
type: array
items:
- $ref: '#/components/schemas/Adres'
- onderhoudslabel:
+ $ref: '#/components/schemas/Garantie-sleutels'
+ geometrie:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het onderhoudslabel geeft aan hoe hoog of laag het onderhoudsniveau van het betreffende eenheid moet zijn. Hierbij wordt rekening gehouden met het soort bewoners en de toekomst van het pand. Referentiedatasoort ONDERHOUDSLABEL.
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de cluster.
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- overigeVertrekkenTotaalOppervlakte:
- type: number
- format: float
- description: Het totaal aan oppervlakte van overige vertrekken. Met overige vertrekken worden de ruimtes bedoeld die ook in de categorie overige ruimtes vallen bij het bepalen van de woningwaarderingspunten.
- panden:
- description: De panden behorend bij een eenheid.
- type: array
- items:
- $ref: '#/components/schemas/Pand-sleutels'
- prestatieafspraken:
- description: Geeft aan of voor de eenheid een specifieke prestatieafspraak is gemaakt (meestal met een gemeente), bijvoorbeeld over het aanwenden van een extra inkomensafhankelijke huurverhoging voor investeringen. Referentiedatasoort PRESTATIEAFSPRAAK.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- prijscomponenten:
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Prijscomponent in informatiedomein Overeenkomsten
- prijsconditie:
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ Cluster-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de cluster.
+ Conditiemeting-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ CollectiefObjectbericht:
+ allOf:
+ - $ref: '#/components/schemas/CollectiefObject'
+ - $ref: '#/components/schemas/Bericht-basis'
+ CollectiefObject:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De voorwaarden behorende bij de huur- of koopprijs. Bijv. Kopers Kosten. Referentiedatasoort EENHEIDPRIJSCONDITIE.
- publicatie:
- type: string
- format: uri
- description: Referentie naar Publicatie in informatiedomein Woonruimteverdeling
- publicatieLabel:
+ description: 'Bijvoorbeeld: fietsenstalling, galerij, lift etc. Referentiedatasoort COLLECTIEFOBJECTSOORT.'
+ naam:
type: string
format: any
- description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning etc.
- rekenhuur:
- type: number
- format: float
- description: De subsidiabele huur in euro's die geregistreerd staat bij de eenheid. De subsidiabele huur is het bedrag van de huur dat in aanmerking komt voor huurtoeslag.
+ description: De naam van het collectief object.
+ adres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-sleutels'
+ description: Aan een Collectief Object kan een adres gekoppeld worden zodat een specifieke locatie opgenomen kan worden. Met name bij onderhoudswerkzaamheden is dit wenselijk.
+ bouwdelen:
+ description: De bouwdelen behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ clusters:
+ description: De clusters behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster-sleutels'
+ eenheden:
+ description: De eenheden behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ garanties:
+ description: De garanties behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Garantie-sleutels'
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- renovatie:
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ Conditiemetingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Conditiemeting'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Conditiemeting:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum die aangeeft wanneer de conditiescore is bepaald. De combinatie van start en einddatum geven een sluitende periode waarin een bepaalde conditiescore geldig is.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum die aangeeft tot wanneer de conditiescore geldig is. Als de einddatum niet beschikbaar is, dan hoeft dit niet opgegeven worden en is de conditiescore voor onbepaalde tijd geldig.
+ conditiescore:
allOf:
- - $ref: '#/components/schemas/Renovatie'
- description: De details van de laatste renovatie van de eenheid.
- ruimten:
- description: De verschillende ruimtes behorend bij de eenheid Bij. 'Achtertuin' of 'Woonkamer'.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De conditiescore uit de NEN 2767. Bijvoorbeeld score 1 voor uitstekende conditie, 4 voor matige conditie. Referentiedatasoort CONDITIESCORE.
+ Eenheidbericht:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Eenheid:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De dienstverlening (soort) die geboden kan worden met de eenheid. Voorbeeld: Woonruimte, Bedrijfsruimte, Parkeergelegenheid. Referentiedatasoort EENHEIDSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het type van de eenheid. Bijvoorbeeld: Hoekwoning, Tussenwoning, Flat, Maisonnette. Hiervoor wordt de lijst van de waarderingskamer als uitgangspunt genomen. Referentiedatasoort EENHEIDDETAILSOORT.'
+ naam:
+ type: string
+ format: any
+ description: De naam van de eenheid.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de eenheid.
+ bouwnummer:
+ type: string
+ format: any
+ description: Het bouwnummer behorende bij de eenheid. Dit wordt aan een eenheid toegekend bij nieuwbouw van de eenheid. Vaak is op dat moment het adres van de eenheid nog niet bepaald.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De status van de eenheid, bijvoorbeeld: Leegstand, Uit beheer, Renovatie, Verhuurd, Verkocht Referentiedatasoort EENHEIDSTATUS.'
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De detailstatus (ook wel substatus) van een status. De detailstatus geeft een extra reden op van de eenheid status die de eenheid heeft. Bijvoorbeeld: de status is Renovatie, de detailstatus geeft aan dat het om planmatig onderhoud gaat. Referentiedatasoort EENHEIDDETAILSTATUS.'
+ inExploitatiedatum:
+ type: string
+ format: date
+ description: De datum waarop de eenheid in exploitatie is gegaan. We spreken over exploitatie als de eenheid in beheer is met als doel dat er resultaat wordt behaald.
+ uitExploitatiedatum:
+ type: string
+ format: date
+ description: De datum waarop de eenheid uit exploitatie is gegaan, zowel het beheer als andere activiteiten stoppen.
+ beginBouwdatum:
+ type: string
+ format: date
+ description: De begindatum van de bouw van de eenheid.
+ bouwjaar:
+ type: integer
+ format: int32
+ description: Het bouwjaar waarin de bouw van de eenheid is afgerond.
+ opleverdatum:
+ type: string
+ format: date
+ description: De opleverdatum van de eenheid. De bouw van de eenheid is dan gereed of de eenheid is beschikbaar voor een volgende gebruiker.
+ aantalOnzelfstandigeEenheden:
+ type: integer
+ format: int32
+ description: Het aantal onzelfstandige eenheden (units, kamers) dat binnen de als geheel verhuurde eenheid valt. Bedoeld om het aantal onzelfstandige eenheden te kunnen verantwoorden in (verplichte) rapportages zoals dVi. Het attribuut wordt gebruikt als slechts één eenheid (met één huurovereenkomst) in het administratieve systeem is vastgelegd, in plaats van de (door VERA geadviseerde) registratie van alle eenheden met een bovenliggendeEenheid.
+ aanvullendeDoelgroep:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De aanvullende doelgroep waarvoor de woning het meest geschikt is en waarvoor meestal ook voorrang wordt verleend. Bijv. Ouderen, Geestelijk gehandicapten, Lichamelijk gehandicapten, GGZ-Patiënten etc. Eventueel te gebruiken in combinatie met doelgroep. Referentiedatasoort AANVULLENDEDOELGROEP.
+ adres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-sleutels'
+ description: Het adres van de eenheid.
+ adresseerbaarObjectBasisregistratie:
+ allOf:
+ - $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
+ description: Het adresseerbare object uit de BAG die overeenkomt met de eenheid.
+ beleidswaarde:
+ description: De beleidswaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
type: array
items:
- $ref: '#/components/schemas/Ruimte'
- sanitair:
- description: Sanitaire voorzieningen Referentiedatasoort EENHEIDSANITAIR.
+ $ref: '#/components/schemas/Beleidswaarde-sleutels'
+ benodigdeAfspraakverzoeken:
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- situering:
+ type: string
+ format: uri
+ description: Referenties naar Afspraakverzoek-sleutels in informatiedomein Relaties
+ beoogdUitExploitatieDatum:
+ type: string
+ format: date
+ description: Verwachte datum waarop de eenheid aan het bezit zal worden onttrokken door sloop of verkoop.
+ bestemming:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Door de corporatie bepaalde bestemming van de eenheid bij mutatie (sloop, verkoop, huur). In AddresseerbaarObjectRegistratie wordt met het attribuut gebruiksdoel aangegeven wat volgens de gemeente het gebruiksdoel van de eenheid is (wonen, werken, zorg, enz.) Referentiedatasoort BESTEMMING.
+ bouwdelen:
+ description: Het bouwdelen behorend bij de eenheid
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ bovenliggendeEenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De bovenliggende eenheid waarvan de eenheid onderdeel van uit maakt.
+ brutohuur:
+ type: number
+ format: float
+ description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
+ buitenruimten:
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ deprecated: true
+ clusters:
+ description: De clusters waar de eenheid onderdeel van uitmaakt.
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster-sleutels'
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ criteria:
+ description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheidcriterium-sleutels'
+ doelgroep:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De doelgroep waarvoor de eenheid bestemd is, bijv. zorgwoning, jongerenwoning, seniorenwoning, eengezinswoning, starterswoning etc. Eventueel te gebruiken in combinatie met aanvullendeDoelgroep. Referentiedatasoort DOELGROEP.
+ energieprestatie:
+ allOf:
+ - $ref: '#/components/schemas/Energieprestatie-sleutels'
+ description: De huidige energieprestatie van de eenheid. OBSOLETE
+ deprecated: true
+ energieprestaties:
+ description: De huidige energieprestatie(s) van de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Energieprestatie-sleutels'
+ energievoorzieningen:
+ description: Voorzieningen met betrekking tot energie zoals zonnepanelen en oplaadpunten Referentiedatasoort EENHEIDENERGIEVOORZIENING.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ etage:
+ type: integer
+ format: int32
+ description: De etage waarop de eenheid zich bevindt.
+ gebouw:
+ allOf:
+ - $ref: '#/components/schemas/Gebouw-sleutels'
+ description: Het gebouw waaruit de eenheid onderdeel van maakt.
+ gebruiksoppervlakte:
+ type: integer
+ format: int32
+ description: De gebruiksoppervlakte van een eenheid(verblijfsobject) in gehele vierkante meters, gemeten conform NEN 2580. Te gebruiken voor verantwoording dVi. Naast gebruiksoppervlakte is ook een attribuut totaleOppervlakte beschikbaar.
+ inExploitatieReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De reden voor het in exploitatie nemen van een eenheid. Bijvoorbeeld: verhuur of beheer namens andere eigenaren. Referentiedatasoort INEXPLOITATIEREDEN.'
+ interieur:
+ description: Binnenruimte van de woning zoals gemeubileerd en vloerbedekking in de woonkamer. Referentiedatasoort EENHEIDINTERIEUR.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ isolatie:
+ description: Getroffen isolatie maatregelen in de eenheid. Referentiedatasoort EENHEIDISOLATIE.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ juridischEigendomspercentage:
+ type: integer
+ format: int32
+ description: Het percentage juridisch eigendom zoals vastgelegd in de eigendomsakte.
+ kadastraalNummer:
+ type: string
+ format: any
+ description: Het kadastraalnummer behorend bij de eenheid.
+ kamersAantal:
+ type: integer
+ format: int32
+ description: Het aantal leefruimten en slaapkamers behorende bij de eenheid.
+ klimaatbeheersing:
+ description: Verzameling van kenmerken die het binnenklimaat (lucht, warmte en koeling) regelen in de eenheid. Referentiedatasoort EENHEIDKLIMAATBEHEERSING.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ kwaliteitsniveau:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het kwaliteitsniveau van de eenheid. Referentiedatasoort KWALITEITSNIVEAU.
+ ligging:
+ description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg en vrij uitzicht Referentiedatasoort EENHEIDLIGGING.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ liggingBuitenruimten:
+ description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc. OBSOLETE Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ deprecated: true
+ liggingTuin:
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ deprecated: true
+ maatschappelijkLabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort de eenheid tot de DAEB-tak of tot de niet-DAEB-tak. Het label op de eenheid kan afwijken van het maatschappelijk label van de huurovereenkomst. Hiermee kan worden aangegeven dat een eenheid die behoort tot de niet-DAEB tak als DAEB-verhuring verantwoord moet worden. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
+ marktlabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het marklabel wordt gebruikt om het strategisch voorraadbeleid vast te leggen. Referentiedatasoort MARKTLABEL.
+ marktwaarde:
+ description: De marktwaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
+ type: array
+ items:
+ $ref: '#/components/schemas/Marktwaarde-sleutels'
+ monumenten:
+ description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort EENHEIDMONUMENT.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ nevenadressen:
+ description: De nevenadressen van de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Adres-sleutels'
+ onderhoudslabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het onderhoudslabel geeft aan hoe hoog of laag het onderhoudsniveau van het betreffende eenheid moet zijn. Hierbij wordt rekening gehouden met het soort bewoners en de toekomst van het pand. Referentiedatasoort ONDERHOUDSLABEL.
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ overigeVertrekkenTotaalOppervlakte:
+ type: number
+ format: float
+ description: Het totaal aan oppervlakte van overige vertrekken. Met overige vertrekken worden de ruimtes bedoeld die ook in de categorie overige ruimtes vallen bij het bepalen van de woningwaarderingspunten.
+ panden:
+ description: De panden behorend bij een eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Pand-sleutels'
+ prestatieafspraken:
+ description: Geeft aan of voor de eenheid een specifieke prestatieafspraak is gemaakt (meestal met een gemeente), bijvoorbeeld over het aanwenden van een extra inkomensafhankelijke huurverhoging voor investeringen. Referentiedatasoort PRESTATIEAFSPRAAK.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ prijscomponenten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Prijscomponent-sleutels in informatiedomein Overeenkomsten
+ prijsconditie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De voorwaarden behorende bij de huur- of koopprijs. Bijv. Kopers Kosten. Referentiedatasoort EENHEIDPRIJSCONDITIE.
+ publicatie:
+ type: string
+ format: uri
+ description: Referentie naar Publicatie-sleutels in informatiedomein Woonruimteverdeling
+ publicatieLabel:
+ type: string
+ format: any
+ description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning, Appartement etc.
+ rekenhuur:
+ type: number
+ format: float
+ description: De subsidiabele huur in euro's die geregistreerd staat bij de eenheid. De subsidiabele huur is het bedrag van de huur dat in aanmerking komt voor huurtoeslag.
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ renovatie:
+ allOf:
+ - $ref: '#/components/schemas/Renovatie-sleutels'
+ description: De details van de laatste renovatie van de eenheid.
+ ruimten:
+ description: De verschillende ruimtes behorend bij de eenheid Bij. 'Achtertuin' of 'Woonkamer'.
+ type: array
+ items:
+ $ref: '#/components/schemas/Ruimte-sleutels'
+ sanitair:
+ description: Sanitaire voorzieningen Referentiedatasoort EENHEIDSANITAIR.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ situering:
+ type: string
+ format: any
+ description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg'
+ streefhuur:
+ type: number
+ format: float
+ description: De netto huur in euro's waarnaar de woningcorporatie streeft.
+ taxaties:
+ description: 'De taxaties van een eenheid. Let op: Voor de waardering van vastgoed ter verantwoording aan AW en WSW (dVi/dPi) worden de waardebegrippen Marktwaarde en Beleidswaarde gebruikt. Dit zijn aparte klassen.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Taxatie-sleutels'
+ toegankelijkheidslabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
+ totaalInhoud:
+ type: number
+ format: float
+ description: De totale inhoud van de eenheid in m3. Zowel bewoonbare als onbewoonbare vertrekken worden hierbij meegeteld.
+ totaleOppervlakte:
+ type: number
+ format: float
+ description: 'De totale oppervlakte van een eenheid. Vertrekken die niet bewoonbaar zijn, worden hierbij meegeteld. Let op: niet te verwarren met de voor de dVi vereiste "gebruiksoppervlakte".'
+ uitExploitatieReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De reden voor het uit exploitatie nemen van een eenheid. Voorbeeld: sloop. Referentiedatasoort UITEXPLOITATIEREDEN.'
+ verkoop:
+ type: boolean
+ description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
+ vertrekken:
+ description: De ruimten behorend bij de eenheid. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Vertrek-sleutels'
+ deprecated: true
+ vertrekkenAantal:
+ type: integer
+ format: int32
+ description: Het aantal vertrekken behorende bij de eenheid.
+ verwarmdeVertrekkenAantal:
+ type: integer
+ format: int32
+ description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
+ volgnummer:
+ type: string
+ format: any
+ description: Het volgnummer van een eenheid, zoals een appartementsaanduiding, of een nummering van garageboxen.
+ voorwaarden:
+ allOf:
+ - $ref: '#/components/schemas/EenheidVoorwaarden-sleutels'
+ description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid. OBSOLETE
+ deprecated: true
+ vraagprijs:
+ type: number
+ format: float
+ description: De vraagprijs voor de verkoop van de eenheid.
+ woningwaarderingResultaat:
+ allOf:
+ - $ref: '#/components/schemas/WoningwaarderingResultaat-sleutels'
+ description: De woningwaardering van de eenheid.
+ Woningwaarderingstelsel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
+ woonvertrekInhoud:
+ type: number
+ format: float
+ description: De inhoud van de eenheid in m3 waarin gewoond kan worden.
+ woonvertrekkenTotaalOppervlakte:
+ type: number
+ format: float
+ description: Het totaal aan oppervlakte van woonvertrekken. Met woonvertrekken worden de ruimtes bedoeld die ook in de categorie woonvertrekken vallen bij het bepalen van de woningwaarderingspunten.
+ woonvorm:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De woonvorm van de eenheid. Bijvoorbeeld groepswonen. Referentiedatasoort WOONVORM.
+ wozEenheden:
+ description: De WOZ eenheden behorend bij de eenheid. Dit zijn de WOZ waarden behorende bij de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/WozEenheid-sleutels'
+ zekerheidVerpandingen:
+ description: De zekerheid verpandingen die horen bij de eenheid. Het bekendste voorbeeld van een zekerheidsverpanding is de hypotheek. Andere voorbeelden zijn pandrechten of het vruchtgebruik (huurpenningen).
+ type: array
+ items:
+ $ref: '#/components/schemas/ZekerheidVerpanding-sleutels'
+ zelfstandig:
+ type: boolean
+ description: Geeft aan of het een zelfstandige of onzelfstandige eenheid betreft. Dit gegeven wordt ook gebruikt bij het bepalen van het woningwaardering volgens het woningwaarderingsstelsel.
+ zorgfaciliteitOmschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de zorgfaciliteit behorende bij de eenheid.
+ AdresseerbaarObjectBasisregistratie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Beleidswaarde-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Eenheidcriterium-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ Energieprestatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Renovatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Ruimte-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Taxatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Vertrek-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ EenheidVoorwaarden-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WoningwaarderingResultaat-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg'
- streefhuur:
- type: number
- format: float
- description: De netto huur in euro's waarnaar de woningcorporatie streeft.
- taxaties:
- description: 'De taxaties van een eenheid. Let op: Voor de waardering van vastgoed ter verantwoording aan AW en WSW (dVi/dPi) worden de waardebegrippen Marktwaarde en Beleidswaarde gebruikt. Dit zijn aparte klassen.'
- type: array
- items:
- $ref: '#/components/schemas/Taxatie'
- toegankelijkheidslabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
- totaalInhoud:
- type: number
- format: float
- description: De totale inhoud van de eenheid in m3. Zowel bewoonbare als onbewoonbare vertrekken worden hierbij meegeteld.
- totaleOppervlakte:
- type: number
- format: float
- description: 'De totale oppervlakte van een eenheid. Vertrekken die niet bewoonbaar zijn, worden hierbij meegeteld. Let op: niet te verwarren met de voor de dVi vereiste "gebruiksoppervlakte".'
- uitExploitatieReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het uit exploitatie nemen van een eenheid. Voorbeeld: sloop. Referentiedatasoort UITEXPLOITATIEREDEN.'
- verkoop:
- type: boolean
- description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
- vertrekken:
- description: De ruimten behorend bij de eenheid. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/Vertrek'
- deprecated: true
- vertrekkenAantal:
- type: integer
- format: int32
- description: Het aantal vertrekken behorende bij de eenheid.
- verwarmdeVertrekkenAantal:
- type: integer
- format: int32
- description: Het aantal verwarmde vertrekken van de eenheid.
- volgnummer:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: Het volgnummer van een eenheid, zoals een appartementsaanduiding, of een nummering van garageboxen.
- voorwaarden:
- allOf:
- - $ref: '#/components/schemas/EenheidVoorwaarden'
- description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid. OBSOLETE
- deprecated: true
- vraagprijs:
- type: number
- format: float
- description: De vraagprijs voor de verkoop van de eenheid.
- woningwaarderingResultaat:
- allOf:
- - $ref: '#/components/schemas/WoningwaarderingResultaat'
- description: De woningwaardering van de eenheid.
- Woningwaarderingstelsel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
- woonvertrekInhoud:
- type: number
- format: float
- description: De inhoud van de eenheid in m3 waarin gewoond kan worden.
- woonvertrekkenTotaalOppervlakte:
- type: number
- format: float
- description: Het totaal aan oppervlakte van woonvertrekken. Met woonvertrekken worden de ruimtes bedoeld die ook in de categorie woonvertrekken vallen bij het bepalen van de woningwaarderingspunten.
- woonvorm:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De woonvorm van de eenheid. Bijvoorbeeld groepswonen. Referentiedatasoort WOONVORM.
- wozEenheden:
- description: De WOZ eenheden behorend bij de eenheid. Dit zijn de WOZ waarden behorende bij de eenheid.
- type: array
- items:
- $ref: '#/components/schemas/WozEenheid'
- zekerheidVerpandingen:
- description: De zekerheid verpandingen die horen bij de eenheid. Het bekendste voorbeeld van een zekerheidsverpanding is de hypotheek. Andere voorbeelden zijn pandrechten of het vruchtgebruik (huurpenningen).
- type: array
- items:
- $ref: '#/components/schemas/ZekerheidVerpanding'
- zelfstandig:
- type: boolean
- description: Geeft aan of het een zelfstandige of onzelfstandige eenheid betreft. Dit gegeven wordt ook gebruikt bij het bepalen van het woningwaardering volgens het woningwaarderingsstelsel.
- zorgfaciliteitOmschrijving:
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
format: any
- description: De omschrijving van de zorgfaciliteit behorende bij de eenheid.
- Beleidswaardebericht:
- allOf:
- - $ref: '#/components/schemas/Beleidswaarde'
- - $ref: '#/components/schemas/Bericht-basis'
- Beleidswaarde:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WozEenheid-sleutels:
type: object
properties:
id:
@@ -13014,55 +13621,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- achterstalligOnderhoud:
- type: number
- format: float
- description: Bedrag aan achterstallig onderhoud dat als correctie is toegepast.
- afkoopErfpacht:
- type: number
- format: float
- description: Het bedrag aan afkoop erfpacht dat als correctie is toegepast.
- beheerAfslag:
- type: number
- format: float
- description: 'Beheer (beheer): eventuele extra beheeruitgaven die gepaard gaan met de sociale doelgroep.'
- beheerskosten:
- type: number
- format: float
- description: Beheerkosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
- beschikbaarheidAfslag:
- type: number
- format: float
- description: 'Beschikbaarheid (doorexploiteren): in stand houden van een sociale portefeuille.'
- betaalbaarheidAfslag:
- type: number
- format: float
- description: 'Betaalbaarheid (huur): in stand houden van sociale huurprijzen passend bij de doelgroep.'
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarvoor de beleidswaarde is vastgelegd. Deze relatie is redundant omdat deze ook via de klasse Marktwaarde gelegd wordt (inclusief verslagjaar). Deze redundante relatie is ten behoeve van gemak bij mogelijke rapportages
- kwaliteitAfslag:
- type: number
- format: float
- description: 'Kwaliteit (onderhoud): eventuele extra onderhoudsuitgaven voor het op lange termijn in stand houden van de portefeuille.'
- marktwaarde:
- allOf:
- - $ref: '#/components/schemas/Marktwaarde'
- description: De verwijzing naar de marktwaarde die ten grondslag ligt aan deze beleidswaarde.
- onderhoudskosten:
- type: number
- format: float
- description: Onderhoudskosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
- streefhuur:
- type: number
- format: float
- description: Actuele streefhuur op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
- waarde:
- type: number
- format: float
- description: 'De beleidswaarde van de eenheid waarde die rekening houdt met het beleid van de corporatie. Marktwaarde minus de afslagen voor beschikbaarheid, betaalbaarheid, kwaliteit en beheer, vormt de beleidswaarde (bron beleidswaarde WSW). Let op: het verslagjaar waarvoor de beleidswaarde is bepaald is het verslagjaar van de marktwaarde die de grondslag vormt van de beleidswaarde.'
- Eenheid-sleutels:
+ ZekerheidVerpanding-sleutels:
type: object
properties:
id:
@@ -13081,11 +13640,52 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Marktwaardebericht:
+ Eenheidadresbericht:
allOf:
- - $ref: '#/components/schemas/Marktwaarde'
+ - $ref: '#/components/schemas/Eenheidadres'
- $ref: '#/components/schemas/Bericht-basis'
- Marktwaarde:
+ Eenheidadres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-basis'
+ - type: object
+ properties:
+ bag:
+ allOf:
+ - $ref: '#/components/schemas/BagAdres-sleutels'
+ description: De unieke aanduiding van een nummeraanduiding.
+ buurt:
+ allOf:
+ - $ref: '#/components/schemas/Buurt-sleutels'
+ description: De buurt behorend bij het adres.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Gemeente-sleutels'
+ description: De gemeente behorend bij het adres.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van het adres.
+ land:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ provincie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De provincie behorend bij het adres. Referentiedatasoort PROVINCIE.
+ stadsdeel:
+ allOf:
+ - $ref: '#/components/schemas/Stadsdeel-sleutels'
+ description: Het stadsdeel behorend bij het adres.
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De wijk behorend bij het adres.
+ woonplaats:
+ allOf:
+ - $ref: '#/components/schemas/Woonplaats-sleutels'
+ description: De woonplaats waarin het adres zich bevindt.
+ BagAdres-sleutels:
type: object
properties:
id:
@@ -13104,51 +13704,72 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- beheersKosten:
- type: number
- format: float
- description: Beheerkosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
- contractJaarhuur:
- type: number
- format: float
- description: De contractueel afgesproken jaarhuur op het moment van waarderen.
- disconteringsvoet:
- type: number
- format: float
- description: Disconteringsvoet op het moment van waarderen.
- doorexploiterenDisconteringsvoet:
- type: number
- format: float
- description: Disconteringsvoet doorexploiteren op het moment van waarderen.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarvoor de marktwaarde is vastgelegd.
- leegwaarde:
- type: number
- format: float
- description: De geschatte verkoopprijs op basis van de kosten koper, vrij van huur en overige lasten (Handboek MVS).
- marktJaarhuur:
- type: number
- format: float
- description: Actuele markt jaarhuur op het moment van waarderen.
- onderhoudsKosten:
- type: number
- format: float
- description: Onderhoudskosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
- verhuurderheffing:
- type: number
- format: float
- description: De verhuurderheffing voor de volledige DCF-periode. De heffing wordt berekend als een percentage van de WOZ-waarde (Handboek MVS).
- verslagJaar:
- type: integer
- format: int32
- description: Het verslagjaar waarop de marktwaarde bepaling betrekking heeft.
- waarde:
- type: number
- format: float
- description: De vastgestelde taxatiewaarde, ook wel marktwaarde in verhuurde staat.
- CollectiefObject-sleutels:
+ Buurt-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de buurt.
+ Gemeente-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de gemeente.
+ Stadsdeel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Woonplaats-sleutels:
type: object
properties:
id:
@@ -13167,6 +13788,10 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de woonplaats.
Eenheidcriteriumbericht:
allOf:
- $ref: '#/components/schemas/Eenheidcriterium'
@@ -13194,6 +13819,10 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het soort criterium op basis waarvan de woning passend is of waarop men voorang kan krijgen. Referentiedatasoort EENHEIDCRITERIUMDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van het criterium.
aantalBovengrens:
type: number
format: float
@@ -13214,11 +13843,11 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Of het een selectie- of sorteercriterium betreft. Referentiedatasoort EENHEIDCRITERIUMTOEPASSING.
- Energieprestatiebericht:
+ EenheidToestandbericht:
allOf:
- - $ref: '#/components/schemas/Energieprestatie'
+ - $ref: '#/components/schemas/EenheidToestand'
- $ref: '#/components/schemas/Bericht-basis'
- Energieprestatie:
+ EenheidToestand:
type: object
properties:
id:
@@ -13237,52 +13866,31 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
+ status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort energieprestatie. Bijv. Voorloping Energielabel, Energieprestatieindex etc.. Referentiedatasoort ENERGIEPRESTATIESOORT.
- status:
+ description: De status van de eenheid. Dit kan bijvoorbeeld verhuurd, gesloopt of leeg zijn. Referentiedatasoort EENHEIDSTATUS.
+ detailStatus:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft de status van de energieprestatie aan: Voorlopig of Definitief. Een voorlopige energieprestatie wordt ook wel "pré-label" genoemd. Een definitieve energieprestatie is afgemeld bij de Rijksoverheid. Referentiedatasoort ENERGIEPRESTATIESTATUS.'
+ description: De status van de eenheid. Dit kan bijvoorbeeld frictieleegstand, mutatieleegstand of reguliere verhuur zijn. Referentiedatasoort EENHEIDDETAILSTATUS.
begindatum:
type: string
format: date
- description: De datum die aangeeft vanaf welk moment de energieprestatie geldt. Indien de energieprestatie is vastgesteld door een adviseur dan is deze datum gelijk aan de opnamedatum. Indien het een voorlopige energieprestatie (pré-label) is dan is de begindatum de datum waarop de energieprestatie is berekend op basis van de beschikbare woningkenmerken. De combinatie van start en einddatum geven een sluitende periode waarin een bepaald energielabel.
+ description: De ingangsdatum van de toestand van de eenheid.
einddatum:
type: string
format: date
- description: De datum die aangeeft tot welk moment de energieprestatie geldig is. Indien de energieprestatie een officiële status heft (afgemeld bij de Rijksoverheid) dan is dit de 'Geldig tot'-datum van de registratie. Indien het een voorlopige energieprestatie is, dan kan de einddatum leeg zijn.
- registratiedatum:
- type: string
- format: date
- description: De datum waarop de energieprestatie is geregistreerd bij de Rijksoverheid. Als sprake is van een voorlopige energieprestatie is geen registratiedatum bekend.
+ description: De einddatum van de toestand van de eenheid.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarop de energielabel van toepassing is.
- index:
- type: number
- format: float
- description: De energieprestatie index van de eenheid. OBSOLETE
- deprecated: true
- label:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het energielabel voor woningen geeft met klassen (A**** tot en met G) en kleuren (groen tot en met rood) aan hoe energiezuinig een huis is ten opzichte van andere soortgelijke woningen. Energielabel A (donkergroen) is zuinig, energielabel G (rood) is onzuinig. Het energielabel is meestal een afgeleide van de waarde van de energieprestatie. Referentiedatasoort ENERGIELABEL.
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- waarde:
- type: string
- format: any
- description: 'De door een adviseur vastgestelde, of afgeleide, waarde die hoort bij de energieprestatie. De waarde is afhankelijk van het soort energieprestatie: een energie-index of een EP2-score. Van deze waarde is het energielabel afgeleid. Als de energieprestatiesoort "Voorlopig energielabel" is, dan is er géén waarde bekend.'
- Gebouwbericht:
+ description: De eenheid waar de toestand voor geldt.
+ EenheidVoorwaardenbericht:
allOf:
- - $ref: '#/components/schemas/Gebouw'
+ - $ref: '#/components/schemas/EenheidVoorwaarden'
- $ref: '#/components/schemas/Bericht-basis'
- Gebouw:
+ EenheidVoorwaarden:
type: object
properties:
id:
@@ -13301,50 +13909,45 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van het gebouw.
- omschrijving:
- type: string
- format: any
- description: De omschrijving van het gebouw.
- bouwdelen:
- description: De bouwdelen behorend bij het gebouw.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- buurt:
- allOf:
- - $ref: '#/components/schemas/Buurt'
- description: De buurt behorend bij het gebouw.
- corporatieBuurt:
- allOf:
- - $ref: '#/components/schemas/Buurt'
- description: De door de corporatie verzonnen buurt behorend bij het gebouw.
- corporatieWijk:
- allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De door de corporatie verzonnen wijk behorend bij het gebouw.
- eenheden:
- description: sleutels
+ maximumAantalPersonen:
+ type: integer
+ format: int32
+ description: Het maximaal aantal personen waarvoor de eenheid geschikt is.
+ maximuminkomen:
+ type: number
+ format: float
+ description: Het maximuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
+ maximunleeftijd:
+ type: integer
+ format: int32
+ description: De maximumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
+ minimumAantalPersonen:
+ type: integer
+ format: int32
+ description: Het minimum aantal personen waarvoor de eenheid geschikt is.
+ minimuminkomen:
+ type: number
+ format: float
+ description: Het minimuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
+ minimumleeftijd:
+ type: integer
+ format: int32
+ description: De minimumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
+ selectiecriteria:
+ description: De criteria waaraan men moet voldoen om in aanmerking te komen voor deze eenheid. Referentiedatasoort SELECTIECRITERIA.
type: array
items:
- $ref: '#/components/schemas/Eenheid-sleutels'
- panden:
- description: De panden behorend bij het gebouw.
+ $ref: '#/components/schemas/Referentiedata'
+ voorrangscriteria:
+ description: De criteria waaraan men moet voldoen om voorrang te krijgen voor deze eenheid. Referentiedatasoort VOORRANGSCRITERIA.
type: array
items:
- $ref: '#/components/schemas/Pand-sleutels'
- wijk:
- allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De wijk behorend bij het gebouw.
- Buurtbericht:
+ $ref: '#/components/schemas/Referentiedata'
+ Energieprestatiebericht:
allOf:
- - $ref: '#/components/schemas/Buurt'
+ - $ref: '#/components/schemas/Energieprestatie'
- $ref: '#/components/schemas/Bericht-basis'
- Buurt:
+ Energieprestatie:
type: object
properties:
id:
@@ -13363,97 +13966,52 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de buurt.
- omschrijving:
- type: string
- format: any
- description: De omschrijving van de buurt.
- eenheden:
- description: De eenheden behorend bij de buurt.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid-sleutels'
- gebouwen:
- description: De gebouwen behorend bij de buurt.
- type: array
- items:
- $ref: '#/components/schemas/Gebouw-sleutels'
- geometrie:
+ soort:
allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de buurt.
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- wijk:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort energieprestatie. Bijv. Voorloping Energielabel, Energieprestatieindex etc.. Referentiedatasoort ENERGIEPRESTATIESOORT.
+ status:
allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De wijk behorend bij de buurt.
- Gebouw-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Geometrie-basis:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Geeft de status van de energieprestatie aan: Voorlopig of Definitief. Een voorlopige energieprestatie wordt ook wel "pré-label" genoemd. Een definitieve energieprestatie is afgemeld bij de Rijksoverheid. Referentiedatasoort ENERGIEPRESTATIESTATUS.'
+ begindatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ format: date
+ description: De datum die aangeeft vanaf welk moment de energieprestatie geldt. Indien de energieprestatie is vastgesteld door een adviseur dan is deze datum gelijk aan de opnamedatum. Indien het een voorlopige energieprestatie (pré-label) is dan is de begindatum de datum waarop de energieprestatie is berekend op basis van de beschikbare woningkenmerken. De combinatie van start en einddatum geven een sluitende periode waarin een bepaald energielabel.
+ einddatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ format: date
+ description: De datum die aangeeft tot welk moment de energieprestatie geldig is. Indien de energieprestatie een officiële status heft (afgemeld bij de Rijksoverheid) dan is dit de 'Geldig tot'-datum van de registratie. Indien het een voorlopige energieprestatie is, dan kan de einddatum leeg zijn.
+ registratiedatum:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
+ format: date
+ description: De datum waarop de energieprestatie is geregistreerd bij de Rijksoverheid. Als sprake is van een voorlopige energieprestatie is geen registratiedatum bekend.
+ eenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarop de energielabel van toepassing is.
+ index:
+ type: number
+ format: float
+ description: De energieprestatie index van de eenheid. OBSOLETE
+ deprecated: true
+ label:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
- omschrijving:
+ description: Het energielabel voor woningen geeft met klassen (A**** tot en met G) en kleuren (groen tot en met rood) aan hoe energiezuinig een huis is ten opzichte van andere soortgelijke woningen. Energielabel A (donkergroen) is zuinig, energielabel G (rood) is onzuinig. Het energielabel is meestal een afgeleide van de waarde van de energieprestatie. Referentiedatasoort ENERGIELABEL.
+ relatie:
type: string
- format: any
- description: 'De omschrijving van de geometrie. Bijvoorbeeld: Lindelaan 3'
- Geometriebericht:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- - $ref: '#/components/schemas/Bericht-basis'
- Geometrie:
- oneOf:
- - $ref: '#/components/schemas/Punt'
- - $ref: '#/components/schemas/Geometrie-basis'
- Wijkbericht:
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ waarde:
+ type: string
+ format: any
+ description: 'De door een adviseur vastgestelde, of afgeleide, waarde die hoort bij de energieprestatie. De waarde is afhankelijk van het soort energieprestatie: een energie-index of een EP2-score. Van deze waarde is het energielabel afgeleid. Als de energieprestatiesoort "Voorlopig energielabel" is, dan is er géén waarde bekend.'
+ Garantiebericht:
allOf:
- - $ref: '#/components/schemas/Wijk'
+ - $ref: '#/components/schemas/Garantie'
- $ref: '#/components/schemas/Bericht-basis'
- Wijk:
+ Garantie:
type: object
properties:
id:
@@ -13472,65 +14030,56 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de wijk.
omschrijving:
type: string
format: any
- description: De omschrijving van de wijk.
- buurten:
- description: De buurten behorend bij de wijk.
+ description: De omschrijving van de garantie.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de garantie.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de garantie.
+ bouwdelen:
+ description: De bouwdelen behorend bij de garantie.
type: array
items:
- $ref: '#/components/schemas/Buurt-sleutels'
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de wijk.
- relaties:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ bouwkundigeElementen:
+ description: De bouwkundige elementen behorend bij de garantie.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- stadsdeel:
- allOf:
- - $ref: '#/components/schemas/Stadsdeel'
- description: Het stadsdeel van de wijk.
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- description: De woonplaats waar de wijk deel uit van maakt.
- Buurt-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ $ref: '#/components/schemas/BouwkundigElement-sleutels'
+ clusters:
+ description: De clusters behorend bij de garantie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster-sleutels'
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij de garantie.
+ type: array
+ items:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ eenheden:
+ description: De eenheden behorend bij de garantie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ overeenkomst:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relatie:
type: string
- format: any
- description: De naam van de buurt.
- Stadsdeelbericht:
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ Gebouwbericht:
allOf:
- - $ref: '#/components/schemas/Stadsdeel'
+ - $ref: '#/components/schemas/Gebouw'
- $ref: '#/components/schemas/Bericht-basis'
- Stadsdeel:
+ Gebouw:
type: object
properties:
id:
@@ -13552,20 +14101,42 @@ components:
naam:
type: string
format: any
- description: De naam van het stadsdeel.
- gemeente:
+ description: De naam van het gebouw.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gebouw.
+ bouwdelen:
+ description: De bouwdelen behorend bij het gebouw.
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ buurt:
allOf:
- - $ref: '#/components/schemas/Gemeente'
- description: De gemeente behorend bij het stadsdeel.
- geometrie:
+ - $ref: '#/components/schemas/Buurt-sleutels'
+ description: De buurt behorend bij het gebouw.
+ corporatieBuurt:
allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van het stadsdeel.
- wijken:
- description: De wijken die in het stadsdeel liggen.
+ - $ref: '#/components/schemas/Buurt-sleutels'
+ description: De door de corporatie verzonnen buurt behorend bij het gebouw.
+ corporatieWijk:
+ allOf:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De door de corporatie verzonnen wijk behorend bij het gebouw.
+ eenheden:
+ description: De eenheden behorend bij het gebouw.
type: array
items:
- $ref: '#/components/schemas/Wijk-sleutels'
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ panden:
+ description: De panden behorend bij het gebouw.
+ type: array
+ items:
+ $ref: '#/components/schemas/Pand-sleutels'
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De wijk behorend bij het gebouw.
Gemeentebericht:
allOf:
- $ref: '#/components/schemas/Gemeente'
@@ -13595,7 +14166,7 @@ components:
description: De naam van de gemeente.
geometrie:
allOf:
- - $ref: '#/components/schemas/Geometrie'
+ - $ref: '#/components/schemas/Geometrie-sleutels'
description: De geometrie van de gemeente.
provincie:
allOf:
@@ -13611,34 +14182,11 @@ components:
items:
$ref: '#/components/schemas/Stadsdeel-sleutels'
woonplaatsen:
- description: sleutels
+ description: De woonplaatsen van de gemeente.
type: array
items:
- $ref: '#/components/schemas/Woonplaats'
- Stadsdeel-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Woonplaatsbericht:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- - $ref: '#/components/schemas/Bericht-basis'
- Woonplaats:
+ $ref: '#/components/schemas/Woonplaats-sleutels'
+ Geometrie-basis:
type: object
properties:
id:
@@ -13657,32 +14205,27 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
+ omschrijving:
type: string
format: any
- description: De naam van de woonplaats.
- bag:
- allOf:
- - $ref: '#/components/schemas/BagWoonplaats'
- description: Verwijzing naar de BAG registratie van de woonplaats.
- gemeente:
- allOf:
- - $ref: '#/components/schemas/Gemeente-sleutels'
- description: De gemeente behorend bij de woonplaats.
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de woonplaats.
- wijken:
- description: De wijken behorend bij de woonplaats.
- type: array
- items:
- $ref: '#/components/schemas/Wijk-sleutels'
- BagWoonplaatsbericht:
+ description: 'De omschrijving van de geometrie. Bijvoorbeeld: Lindelaan 3'
+ Geometriebericht:
allOf:
- - $ref: '#/components/schemas/BagWoonplaats'
+ - $ref: '#/components/schemas/Geometrie'
- $ref: '#/components/schemas/Bericht-basis'
- BagWoonplaats:
+ Geometrie:
+ oneOf:
+ - $ref: '#/components/schemas/Punt'
+ - $ref: '#/components/schemas/Geometrie-basis'
+ KadasterPerceelbericht:
+ allOf:
+ - $ref: '#/components/schemas/KadasterPerceel'
+ - $ref: '#/components/schemas/Bericht-basis'
+ KadasterPerceel:
type: object
properties:
id:
@@ -13701,21 +14244,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bagIdentificatie:
- type: string
- format: any
- description: De landelijk unieke aanduiding van een woonplaats, zoals vastgesteld door de beheerder van de landelijke tabel voor woonplaatsen.
- bagStatus:
- type: string
- format: any
- description: De fase van de levenscyclus van een woonplaats, waarin de betreffende woonplaats zich bevindt.
- bagInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- Gemeente-sleutels:
+ Marktwaardebericht:
+ allOf:
+ - $ref: '#/components/schemas/Marktwaarde'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Marktwaarde:
type: object
properties:
id:
@@ -13734,11 +14267,55 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de gemeente.
- Wijk-sleutels:
+ beheersKosten:
+ type: number
+ format: float
+ description: Beheerkosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
+ contractJaarhuur:
+ type: number
+ format: float
+ description: De contractueel afgesproken jaarhuur op het moment van waarderen.
+ disconteringsvoet:
+ type: number
+ format: float
+ description: Disconteringsvoet op het moment van waarderen.
+ doorexploiterenDisconteringsvoet:
+ type: number
+ format: float
+ description: Disconteringsvoet doorexploiteren op het moment van waarderen.
+ eenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarvoor de marktwaarde is vastgelegd.
+ leegwaarde:
+ type: number
+ format: float
+ description: De geschatte verkoopprijs op basis van de kosten koper, vrij van huur en overige lasten (Handboek MVS).
+ marktJaarhuur:
+ type: number
+ format: float
+ description: Actuele markt jaarhuur op het moment van waarderen.
+ onderhoudsKosten:
+ type: number
+ format: float
+ description: Onderhoudskosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
+ verhuurderheffing:
+ type: number
+ format: float
+ description: De verhuurderheffing voor de volledige DCF-periode. De heffing wordt berekend als een percentage van de WOZ-waarde (Handboek MVS).
+ verslagJaar:
+ type: integer
+ format: int32
+ description: Het verslagjaar waarop de marktwaarde bepaling betrekking heeft.
+ waarde:
+ type: number
+ format: float
+ description: De vastgestelde taxatiewaarde, ook wel marktwaarde in verhuurde staat.
+ Pandbericht:
+ allOf:
+ - $ref: '#/components/schemas/Pand'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Pand:
type: object
properties:
id:
@@ -13757,11 +14334,49 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de wijk.
- Pand-sleutels:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het pand volgens de eigenaar. Referentiedatasoort PANDSTATUS.
+ adresseerbareObjectenBasisregistratie:
+ description: De adresseerbare objecten uit de basisregistratie behorend bij het pand.
+ type: array
+ items:
+ $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
+ bag:
+ allOf:
+ - $ref: '#/components/schemas/BagPand-sleutels'
+ description: Verwijzing naar de BAG details behorende bij het pand.
+ bouwdelen:
+ description: De bouwdelen behorend bij het pand.
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ eenheden:
+ description: De eenheden behorend bij het pand. De eenheden zijn onderdeel van het pand.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ gebouw:
+ allOf:
+ - $ref: '#/components/schemas/Gebouw-sleutels'
+ description: Het gebouw behorend bij het pand.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van het pand.
+ kavelOppervlakte:
+ type: number
+ format: float
+ description: De oppervlakte van het kavel van het pand.
+ liftAanwezig:
+ type: boolean
+ description: De aanduiding geeft aan of in het pand in lift aanwezig is.
+ renovatie:
+ allOf:
+ - $ref: '#/components/schemas/Renovatie-sleutels'
+ description: Verwijzing naar de laatste renovatie details van het pand.
+ BagPand-sleutels:
type: object
properties:
id:
@@ -13780,6 +14395,44 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Postadresbericht:
+ allOf:
+ - $ref: '#/components/schemas/Postadres'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Postadres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-basis'
+ - type: object
+ properties:
+ antwoordnummer:
+ type: string
+ format: any
+ description: Het antwoordnummer behorende bij het adres.
+ postbusnummer:
+ type: string
+ format: any
+ description: Het postbusnummer behorende bij het adres.
+ woonplaats:
+ allOf:
+ - $ref: '#/components/schemas/Woonplaats-sleutels'
+ description: De woonplaats waarin het adres zich bevindt.
+ Puntbericht:
+ allOf:
+ - $ref: '#/components/schemas/Punt'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Punt:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-basis'
+ - type: object
+ properties:
+ breedtegraad:
+ type: number
+ format: float
+ description: De breedtegraad.
+ lengtegraad:
+ type: number
+ format: float
+ description: De lengtegraad.
Renovatiebericht:
allOf:
- $ref: '#/components/schemas/Renovatie'
@@ -13867,55 +14520,16 @@ components:
ligging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De ligging van de ruimte. Referentiedatasoort EENHEIDLIGGINGRUIMTE.
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
oppervlakte:
type: number
format: float
description: De oppervlakte van de ruimte
- Taxatiebericht:
- allOf:
- - $ref: '#/components/schemas/Taxatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Taxatie:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De soort taxatie die heeft plaatsgevonden. Bijvoorbeeld: geveltaxatie of volledige taxatie. Referentiedatasoort TAXATIESOORT.'
- datum:
- type: string
- format: date
- description: De datum waarop de taxatie heeft plaatsgevonden.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarvoor de taxatie heeft plaatsgevonden.
- waarde:
- type: number
- format: float
- description: De taxatiewaarde van de getaxeerde eenheid.
- Vertrekbericht:
+ Stadsdeelbericht:
allOf:
- - $ref: '#/components/schemas/Vertrek'
+ - $ref: '#/components/schemas/Stadsdeel'
- $ref: '#/components/schemas/Bericht-basis'
- Vertrek:
+ Stadsdeel:
type: object
properties:
id:
@@ -13934,92 +14548,28 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort ruimte. Ruimtes worden verdeeld in vertrekken die meetellen voor de woningwaardering, buitenruimtes en overige ruimtes. Referentiedatasoort RUIMTESOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het detailsoort van de ruimte. Bijv. Slaapkamer, Dakteras, Tuin etc. Referentiedatasoort RUIMTEDETAILSOORT.
naam:
type: string
format: any
- description: De omschrijving van de ruimte.
- eenheid:
+ description: De naam van het stadsdeel.
+ gemeente:
allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de ruimte.
- inhoud:
- type: number
- format: float
- description: De inhoud van de ruimte in m3.
- oppervlakte:
- type: number
- format: float
- description: De oppervlakte van de ruimte
- EenheidVoorwaardenbericht:
- allOf:
- - $ref: '#/components/schemas/EenheidVoorwaarden'
- - $ref: '#/components/schemas/Bericht-basis'
- EenheidVoorwaarden:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- maximumAantalPersonen:
- type: integer
- format: int32
- description: Het maximaal aantal personen waarvoor de eenheid geschikt is.
- maximuminkomen:
- type: number
- format: float
- description: Het maximuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
- maximunleeftijd:
- type: integer
- format: int32
- description: De maximumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
- minimumAantalPersonen:
- type: integer
- format: int32
- description: Het minimum aantal personen waarvoor de eenheid geschikt is.
- minimuminkomen:
- type: number
- format: float
- description: Het minimuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
- minimumleeftijd:
- type: integer
- format: int32
- description: De minimumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
- selectiecriteria:
- description: De criteria waaraan men moet voldoen om in aanmerking te komen voor deze eenheid. Referentiedatasoort SELECTIECRITERIA.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- voorrangscriteria:
- description: De criteria waaraan men moet voldoen om voorrang te krijgen voor deze eenheid. Referentiedatasoort VOORRANGSCRITERIA.
+ - $ref: '#/components/schemas/Gemeente-sleutels'
+ description: De gemeente behorend bij het stadsdeel.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van het stadsdeel.
+ wijken:
+ description: De wijken die in het stadsdeel liggen.
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- WoningwaarderingResultaatbericht:
+ $ref: '#/components/schemas/Wijk-sleutels'
+ Taxatiebericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingResultaat'
+ - $ref: '#/components/schemas/Taxatie'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingResultaat:
+ Taxatie:
type: object
properties:
id:
@@ -14038,40 +14588,27 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date
- description: De begindatum van de woningwaardering puntentotaal.
- einddatum:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De soort taxatie die heeft plaatsgevonden. Bijvoorbeeld: geveltaxatie of volledige taxatie. Referentiedatasoort TAXATIESOORT.'
+ datum:
type: string
format: date
- description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
+ description: De datum waarop de taxatie heeft plaatsgevonden.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de woningwaardering.
- groepen:
- description: De woningwaarderingenGroep behorend bij het woningwaardering puntentotaal.
- type: array
- items:
- $ref: '#/components/schemas/WoningwaarderingGroep'
- maximaleHuur:
- type: number
- format: float
- description: De maximaal redelijke huur in euro's die geregistreerd staat bij de eenheid. De maximale huur is de huurprijs die gevraagd kan worden voor de eenheid op basis van de woningwaarderingspunten.
- opslagpercentage:
- type: number
- format: float
- description: Het percentage dat boven de maximale huurprijs op basis van punten mag worden gerekend. Bijvoorbeeld bij specifieke monumenten binnen stads of dorpsgezichten van voor 1945 waarbij de corporatie extra onderhoud pleegt aan het monument.
- punten:
+ description: De eenheid waarvoor de taxatie heeft plaatsgevonden.
+ waarde:
type: number
format: float
- description: Het aantal woningwaarderingsstelsel punten dat is toegekend.
- WoningwaarderingGroepbericht:
+ description: De taxatiewaarde van de getaxeerde eenheid.
+ Vertrekbericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingGroep'
+ - $ref: '#/components/schemas/Vertrek'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingGroep:
+ Vertrek:
type: object
properties:
id:
@@ -14090,36 +14627,35 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date
- description: De begindatum van de woningwaardering groep.
- einddatum:
- type: string
- format: date
- description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
- criteriumGroep:
+ soort:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep'
- description: De woningwaardering criterium groep behorend bij de woningwaardering groep.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort ruimte. Ruimtes worden verdeeld in vertrekken die meetellen voor de woningwaardering, buitenruimtes en overige ruimtes. Referentiedatasoort RUIMTESOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het detailsoort van de ruimte. Bijv. Slaapkamer, Dakteras, Tuin etc. Referentiedatasoort RUIMTEDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De omschrijving van de ruimte.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de woningwaardering.
- punten:
+ description: De eenheid behorend bij de ruimte.
+ inhoud:
type: number
format: float
- description: De som van het aantal punten dat is toegekend aan de onderliggende Woningwaarderingen.
- woningwaarderingen:
- description: sleutels
- type: array
- items:
- $ref: '#/components/schemas/Woningwaardering'
- WoningwaarderingCriteriumGroepbericht:
+ description: De inhoud van de ruimte in m3.
+ oppervlakte:
+ type: number
+ format: float
+ description: De oppervlakte van de ruimte
+ Wijkbericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep'
+ - $ref: '#/components/schemas/Wijk'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingCriteriumGroep:
+ Wijk:
type: object
properties:
id:
@@ -14141,34 +14677,39 @@ components:
naam:
type: string
format: any
- description: De naam van de groep.
+ description: De naam van de wijk.
omschrijving:
type: string
format: any
- description: De omschrijving van de groep.
- criteria:
- description: De woningwaardering criteria behorend bij de woningwaardering criterium groep.
+ description: De omschrijving van de wijk.
+ buurten:
+ description: De buurten behorend bij de wijk.
type: array
items:
- $ref: '#/components/schemas/WoningwaarderingCriterium'
- soort:
+ $ref: '#/components/schemas/Buurt-sleutels'
+ geometrie:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. OBSOLETE. Referentiedatasoort WONINGWAARDERINGCRITERIUMGROEPSOORT.
- deprecated: true
- stelsel:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de wijk.
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ stadsdeel:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
- stelselgroep:
+ - $ref: '#/components/schemas/Stadsdeel-sleutels'
+ description: Het stadsdeel van de wijk.
+ woonplaats:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. Referentiedatasoort WONINGWAARDERINGSTELSELGROEP.
- WoningwaarderingCriteriumbericht:
+ - $ref: '#/components/schemas/Woonplaats-sleutels'
+ description: De woonplaats waar de wijk deel uit van maakt.
+ Woningwaarderingbericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriterium'
+ - $ref: '#/components/schemas/Woningwaardering'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingCriterium:
+ Woningwaardering:
type: object
properties:
id:
@@ -14187,23 +14728,35 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ begindatum:
type: string
- format: any
- description: De naam van het woningwaardering element.
- criteriumGroep:
+ format: date
+ description: De datum waarop het woning waardering onderdeel in gaat of is ingegaan.
+ einddatum:
+ type: string
+ format: date
+ description: De datum waarop het woningwaardering onderdeel niet meer van toepassing is.
+ aantal:
+ type: number
+ format: float
+ description: Het aantal van de opgegeven meeteenheid van de bijbehorende woningwaardering criterium.
+ criterium:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep-sleutels'
- description: De groep waarbij de woningwaardering criterium bij hoort.
- meeteenheid:
+ - $ref: '#/components/schemas/WoningwaarderingCriterium-sleutels'
+ description: De omschrijving van het woningwaardering onderdeel.
+ eenheid:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De meeteenheid waarmee het criterium wordt aangeduid. Referentiedatasoort MEETEENHEID.
- stelsel:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid die is gewaardeerd.
+ groep:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
- WoningwaarderingCriteriumGroep-sleutels:
+ - $ref: '#/components/schemas/WoningwaarderingGroep-sleutels'
+ description: De woningwaardering groep behorend bij de woningwaardering.
+ punten:
+ type: number
+ format: float
+ description: Het aantal punten dat is toegekend op basis van het opgegeven aantal, voor de betreffende woningwaardering. Voor bepaalde woningwaarderingGroepen binnen een woningwaarderingstelsel geldt dat het aantal punten op groepsniveau bepaald wordt. In die gevallen kan het attribuut aantal punten in deze klasse leeg blijven
+ WoningwaarderingCriterium-sleutels:
type: object
properties:
id:
@@ -14222,11 +14775,30 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Woningwaarderingbericht:
+ WoningwaarderingGroep-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WoningwaarderingCriteriumbericht:
allOf:
- - $ref: '#/components/schemas/Woningwaardering'
+ - $ref: '#/components/schemas/WoningwaarderingCriterium'
- $ref: '#/components/schemas/Bericht-basis'
- Woningwaardering:
+ WoningwaarderingCriterium:
type: object
properties:
id:
@@ -14245,35 +14817,23 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date
- description: De datum waarop het woning waardering onderdeel in gaat of is ingegaan.
- einddatum:
+ naam:
type: string
- format: date
- description: De datum waarop het woningwaardering onderdeel niet meer van toepassing is.
- aantal:
- type: number
- format: float
- description: Het aantal van de opgegeven meeteenheid van de bijbehorende woningwaardering criterium.
- criterium:
+ format: any
+ description: De naam van het woningwaardering element.
+ criteriumGroep:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriterium'
- description: De omschrijving van het woningwaardering onderdeel.
- eenheid:
+ - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep-sleutels'
+ description: De groep waarbij de woningwaardering criterium bij hoort.
+ meeteenheid:
allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid die is gewaardeerd.
- groep:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De meeteenheid waarmee het criterium wordt aangeduid. Referentiedatasoort MEETEENHEID.
+ stelsel:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingGroep-sleutels'
- description: De woningwaardering groep behorend bij de woningwaardering.
- punten:
- type: number
- format: float
- description: Het aantal punten dat is toegekend op basis van het opgegeven aantal, voor de betreffende woningwaardering. Voor bepaalde woningwaarderingGroepen binnen een woningwaarderingstelsel geldt dat het aantal punten op groepsniveau bepaald wordt. In die gevallen kan het attribuut aantal punten in deze klasse leeg blijven
- WoningwaarderingGroep-sleutels:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
+ WoningwaarderingCriteriumGroep-sleutels:
type: object
properties:
id:
@@ -14292,11 +14852,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- WozEenheidbericht:
+ WoningwaarderingCriteriumGroepbericht:
allOf:
- - $ref: '#/components/schemas/WozEenheid'
+ - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep'
- $ref: '#/components/schemas/Bericht-basis'
- WozEenheid:
+ WoningwaarderingCriteriumGroep:
type: object
properties:
id:
@@ -14315,23 +14875,37 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de WOZ eenheid. De WOZ gegevens die in het WOZEenheid object worden ingevoerd hebben betrekking op de eenheid die is aangegeven voor dit attribuut.
- vastgesteldeWaarde:
- type: number
- format: float
- description: De WOZ waarde in euro's die eventueel wordt doorberekend aan de eenheid.
- waardepeildatum:
+ naam:
type: string
- format: date
- description: De datum waarop de WOZ waarde is vastgesteld.
- ZekerheidVerpandingbericht:
+ format: any
+ description: De naam van de groep.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de groep.
+ criteria:
+ description: De woningwaardering criteria behorend bij de woningwaardering criterium groep.
+ type: array
+ items:
+ $ref: '#/components/schemas/WoningwaarderingCriterium-sleutels'
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. OBSOLETE. Referentiedatasoort WONINGWAARDERINGCRITERIUMGROEPSOORT.
+ deprecated: true
+ stelsel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
+ stelselgroep:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. Referentiedatasoort WONINGWAARDERINGSTELSELGROEP.
+ WoningwaarderingGroepbericht:
allOf:
- - $ref: '#/components/schemas/ZekerheidVerpanding'
+ - $ref: '#/components/schemas/WoningwaarderingGroep'
- $ref: '#/components/schemas/Bericht-basis'
- ZekerheidVerpanding:
+ WoningwaarderingGroep:
type: object
properties:
id:
@@ -14350,40 +14924,32 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort of type zekerheid dat op de eenheid is gevestigd. Bijvoorbeeld Hypotheek of Pandrecht huurpenningen. Referentiedatasoort ZEKERHEIDVERPANDINGSOORT.
begindatum:
type: string
format: date
- description: De begindatum die aangeeft wanneer de zekerheid is afgegeven.
+ description: De begindatum van de woningwaardering groep.
einddatum:
type: string
format: date
- description: De einddatum die aangeeft wanneer de zekerheid is ingetrokken of opgeheven.
- akteSoort:
+ description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
+ criteriumGroep:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort akte waarmee de zekerheid is gevestigd. (Notarieel of onderhands) Referentiedatasoort AKTESOORT.
- belastingdienstRegistratiedatum:
- type: string
- format: date
- description: 'In het geval van een onderhandse akte: de datum van registratie bij de belastingdienst.'
+ - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep-sleutels'
+ description: De woningwaardering criterium groep behorend bij de woningwaardering groep.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarop de zekerheid is verleend.
- onderpandWSW:
- type: boolean
- description: Is de eenheid als onderpand ingebracht bij het WSW?
- relaties:
+ description: De eenheid behorend bij de woningwaardering.
+ punten:
+ type: number
+ format: float
+ description: De som van het aantal punten dat is toegekend aan de onderliggende Woningwaarderingen.
+ woningwaarderingen:
+ description: De woningwaarderingen behorend bij de woningwaardering groep.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Garantie-sleutels:
+ $ref: '#/components/schemas/Woningwaardering-sleutels'
+ Woningwaardering-sleutels:
type: object
properties:
id:
@@ -14402,11 +14968,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Conditiemetingbericht:
+ WoningwaarderingResultaatbericht:
allOf:
- - $ref: '#/components/schemas/Conditiemeting'
+ - $ref: '#/components/schemas/WoningwaarderingResultaat'
- $ref: '#/components/schemas/Bericht-basis'
- Conditiemeting:
+ WoningwaarderingResultaat:
type: object
properties:
id:
@@ -14428,20 +14994,37 @@ components:
begindatum:
type: string
format: date
- description: De begindatum die aangeeft wanneer de conditiescore is bepaald. De combinatie van start en einddatum geven een sluitende periode waarin een bepaalde conditiescore geldig is.
+ description: De begindatum van de woningwaardering puntentotaal.
einddatum:
type: string
format: date
- description: De einddatum die aangeeft tot wanneer de conditiescore geldig is. Als de einddatum niet beschikbaar is, dan hoeft dit niet opgegeven worden en is de conditiescore voor onbepaalde tijd geldig.
- conditiescore:
+ description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
+ eenheid:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De conditiescore uit de NEN 2767. Bijvoorbeeld score 1 voor uitstekende conditie, 4 voor matige conditie. Referentiedatasoort CONDITIESCORE.
- BagAdresbericht:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid behorend bij de woningwaardering.
+ groepen:
+ description: De woningwaarderingenGroep behorend bij het woningwaardering puntentotaal.
+ type: array
+ items:
+ $ref: '#/components/schemas/WoningwaarderingGroep-sleutels'
+ maximaleHuur:
+ type: number
+ format: float
+ description: De maximaal redelijke huur in euro's die geregistreerd staat bij de eenheid. De maximale huur is de huurprijs die gevraagd kan worden voor de eenheid op basis van de woningwaarderingspunten.
+ opslagpercentage:
+ type: number
+ format: float
+ description: Het percentage dat boven de maximale huurprijs op basis van punten mag worden gerekend. Bijvoorbeeld bij specifieke monumenten binnen stads of dorpsgezichten van voor 1945 waarbij de corporatie extra onderhoud pleegt aan het monument.
+ punten:
+ type: number
+ format: float
+ description: Het aantal woningwaarderingsstelsel punten dat is toegekend.
+ Woonplaatsbericht:
allOf:
- - $ref: '#/components/schemas/BagAdres'
+ - $ref: '#/components/schemas/Woonplaats'
- $ref: '#/components/schemas/Bericht-basis'
- BagAdres:
+ Woonplaats:
type: object
properties:
id:
@@ -14460,113 +15043,51 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bagNummeraanduidingIdentificatie:
+ naam:
type: string
format: any
- description: De unieke aanduiding van een nummeraanduiding.
- bagOpenbareRuimteIdentificatie:
+ description: De naam van de woonplaats.
+ bag:
+ allOf:
+ - $ref: '#/components/schemas/BagWoonplaats-sleutels'
+ description: Verwijzing naar de BAG registratie van de woonplaats.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Gemeente-sleutels'
+ description: De gemeente behorend bij de woonplaats.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de woonplaats.
+ wijken:
+ description: De wijken behorend bij de woonplaats.
+ type: array
+ items:
+ $ref: '#/components/schemas/Wijk-sleutels'
+ BagWoonplaats-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De unieke aanduiding van een openbare ruimte.
- bagNummeraanduidingInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagNummeraanduidingOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- bagNummeraanduidingStatus:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: De fase van de levenscyclus van een nummeraanduiding, waarin de betreffende nummeraanduiding zich bevindt.
- bagOpenbareRuimteInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagOpenbareruimteOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- bagOpenbareruimtestatus:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: De fase van de levenscyclus van een openbare ruimte, waarin de betreffende openbare ruimte zich bevindt.
- BuitenlandsAdresbericht:
- allOf:
- - $ref: '#/components/schemas/BuitenlandsAdres'
- - $ref: '#/components/schemas/Bericht-basis'
- BuitenlandsAdres:
- allOf:
- - $ref: '#/components/schemas/Adres-basis'
- - type: object
- properties:
- adresregel1:
- type: string
- format: any
- description: Adresregel in verband met een buitenlands adres.
- adresregel2:
- type: string
- format: any
- description: Adresregel in verband met een buitenlands adres.
- land:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
- postbusnummer:
- type: string
- format: any
- description: Het postbusnummer behorende bij het adres
- provincie:
- type: string
- format: any
- description: De provincie behorend bij het adres.
- woonplaats:
- type: string
- format: any
- description: De woonplaats waarin het adres zich bevindt.
- Eenheidadresbericht:
- allOf:
- - $ref: '#/components/schemas/Eenheidadres'
- - $ref: '#/components/schemas/Bericht-basis'
- Eenheidadres:
- allOf:
- - $ref: '#/components/schemas/Adres-basis'
- - type: object
- properties:
- bag:
- allOf:
- - $ref: '#/components/schemas/BagAdres'
- description: De unieke aanduiding van een nummeraanduiding.
- buurt:
- allOf:
- - $ref: '#/components/schemas/Buurt'
- description: De buurt behorend bij het adres.
- gemeente:
- allOf:
- - $ref: '#/components/schemas/Gemeente'
- description: De gemeente behorend bij het adres.
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van het adres.
- land:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
- provincie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De provincie behorend bij het adres. Referentiedatasoort PROVINCIE.
- wijk:
- allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De wijk behorend bij het adres.
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- description: De woonplaats waarin het adres zich bevindt.
- EenheidToestandbericht:
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WozEenheidbericht:
allOf:
- - $ref: '#/components/schemas/EenheidToestand'
+ - $ref: '#/components/schemas/WozEenheid'
- $ref: '#/components/schemas/Bericht-basis'
- EenheidToestand:
+ WozEenheid:
type: object
properties:
id:
@@ -14585,31 +15106,23 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de eenheid. Dit kan bijvoorbeeld verhuurd, gesloopt of leeg zijn. Referentiedatasoort EENHEIDSTATUS.
- detailStatus:
+ eenheid:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de eenheid. Dit kan bijvoorbeeld frictieleegstand, mutatieleegstand of reguliere verhuur zijn. Referentiedatasoort EENHEIDDETAILSTATUS.
- begindatum:
- type: string
- format: date
- description: De ingangsdatum van de toestand van de eenheid.
- einddatum:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid behorend bij de WOZ eenheid. De WOZ gegevens die in het WOZEenheid object worden ingevoerd hebben betrekking op de eenheid die is aangegeven voor dit attribuut.
+ vastgesteldeWaarde:
+ type: number
+ format: float
+ description: De WOZ waarde in euro's die eventueel wordt doorberekend aan de eenheid.
+ waardepeildatum:
type: string
format: date
- description: De einddatum van de toestand van de eenheid.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid'
- description: De eenheid waar de toestand voor geldt.
- KadasterPerceelbericht:
+ description: De datum waarop de WOZ waarde is vastgesteld.
+ ZekerheidVerpandingbericht:
allOf:
- - $ref: '#/components/schemas/KadasterPerceel'
+ - $ref: '#/components/schemas/ZekerheidVerpanding'
- $ref: '#/components/schemas/Bericht-basis'
- KadasterPerceel:
+ ZekerheidVerpanding:
type: object
properties:
id:
@@ -14628,44 +15141,39 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Postadresbericht:
- allOf:
- - $ref: '#/components/schemas/Postadres'
- - $ref: '#/components/schemas/Bericht-basis'
- Postadres:
- allOf:
- - $ref: '#/components/schemas/Adres-basis'
- - type: object
- properties:
- antwoordnummer:
- type: string
- format: any
- description: Het antwoordnummer behorende bij het adres.
- postbusnummer:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort of type zekerheid dat op de eenheid is gevestigd. Bijvoorbeeld Hypotheek of Pandrecht huurpenningen. Referentiedatasoort ZEKERHEIDVERPANDINGSOORT.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum die aangeeft wanneer de zekerheid is afgegeven.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum die aangeeft wanneer de zekerheid is ingetrokken of opgeheven.
+ akteSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort akte waarmee de zekerheid is gevestigd. (Notarieel of onderhands) Referentiedatasoort AKTESOORT.
+ belastingdienstRegistratiedatum:
+ type: string
+ format: date
+ description: 'In het geval van een onderhandse akte: de datum van registratie bij de belastingdienst.'
+ eenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarop de zekerheid is verleend.
+ onderpandWSW:
+ type: boolean
+ description: Is de eenheid als onderpand ingebracht bij het WSW?
+ relaties:
+ type: array
+ items:
type: string
- format: any
- description: Het postbusnummer behorende bij het adres.
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- description: De woonplaats waarin het adres zich bevindt.
- Puntbericht:
- allOf:
- - $ref: '#/components/schemas/Punt'
- - $ref: '#/components/schemas/Bericht-basis'
- Punt:
- allOf:
- - $ref: '#/components/schemas/Geometrie-basis'
- - type: object
- properties:
- breedtegraad:
- type: number
- format: float
- description: De breedtegraad.
- lengtegraad:
- type: number
- format: float
- description: De lengtegraad.
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Bericht-basis:
type: object
properties:
diff --git a/Informatiedomeinen/Woonruimteverdeling.yaml b/Informatiedomeinen/Woonruimteverdeling.yaml
index 9736a9c..1fbef1a 100644
--- a/Informatiedomeinen/Woonruimteverdeling.yaml
+++ b/Informatiedomeinen/Woonruimteverdeling.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://woonruimteverdeling.vera.io:{port}/{basePath}
description: Productieserver
@@ -57,7 +57,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -73,7 +73,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Ophalen van Aanbiedingen
+ summary: Ophalen van Aanbiedingen
operationId: listAanbiedingen
parameters:
- name: params
@@ -123,7 +123,7 @@ paths:
post:
tags:
- 'Aanbiedingen'
- description: Voegt een nieuw(e) Aanbieding toe.
+ summary: Voegt een nieuw(e) Aanbieding toe.
operationId: createAanbieding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -163,7 +163,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Vervangen van een Aanbieding op basis van overeenkomstige sleutelvelden.
operationId: replaceAanbieding
parameters:
@@ -198,7 +198,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aanbieding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAanbieding
@@ -235,7 +235,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Retourneert een Aanbieding met de gegeven identifier
+ summary: Retourneert een Aanbieding met de gegeven identifier
operationId: readAanbiedingById
parameters:
- name: id
@@ -272,7 +272,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: Vervangen van een Aanbieding
+ summary: Vervangen van een Aanbieding
operationId: replaceAanbiedingById
parameters:
- name: 'id'
@@ -310,7 +310,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: Wijzigen van een Aanbieding
+ summary: Wijzigen van een Aanbieding
operationId: updateAanbiedingById
parameters:
- name: 'id'
@@ -349,7 +349,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Ophalen van Gebeurtenissen
+ summary: Ophalen van Gebeurtenissen
operationId: listGebeurtenissen
parameters:
- name: params
@@ -399,7 +399,7 @@ paths:
post:
tags:
- 'Gebeurtenissen'
- description: Voegt een nieuw(e) Gebeurtenis toe.
+ summary: Voegt een nieuw(e) Gebeurtenis toe.
operationId: createGebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -439,7 +439,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Vervangen van een Gebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replaceGebeurtenis
parameters:
@@ -474,7 +474,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGebeurtenis
@@ -511,7 +511,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Retourneert een Gebeurtenis met de gegeven identifier
+ summary: Retourneert een Gebeurtenis met de gegeven identifier
operationId: readGebeurtenisById
parameters:
- name: id
@@ -548,7 +548,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: Vervangen van een Gebeurtenis
+ summary: Vervangen van een Gebeurtenis
operationId: replaceGebeurtenisById
parameters:
- name: 'id'
@@ -586,7 +586,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: Wijzigen van een Gebeurtenis
+ summary: Wijzigen van een Gebeurtenis
operationId: updateGebeurtenisById
parameters:
- name: 'id'
@@ -625,7 +625,7 @@ paths:
get:
tags:
- 'HuidigeGebruikers'
- description: Ophalen van HuidigeGebruikers
+ summary: Ophalen van HuidigeGebruikers
operationId: listHuidigeGebruikers
parameters:
- name: params
@@ -675,7 +675,7 @@ paths:
post:
tags:
- 'HuidigeGebruikers'
- description: Voegt een nieuw(e) HuidigeGebruiker toe.
+ summary: Voegt een nieuw(e) HuidigeGebruiker toe.
operationId: createHuidigeGebruiker
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -715,7 +715,7 @@ paths:
put:
tags:
- 'HuidigeGebruikers'
- description: |
+ summary: |
Vervangen van een HuidigeGebruiker op basis van overeenkomstige sleutelvelden.
operationId: replaceHuidigeGebruiker
parameters:
@@ -750,7 +750,7 @@ paths:
patch:
tags:
- 'HuidigeGebruikers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een HuidigeGebruiker. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuidigeGebruiker
@@ -787,7 +787,7 @@ paths:
get:
tags:
- 'HuidigeGebruikers'
- description: Retourneert een HuidigeGebruiker met de gegeven identifier
+ summary: Retourneert een HuidigeGebruiker met de gegeven identifier
operationId: readHuidigeGebruikerById
parameters:
- name: id
@@ -824,7 +824,7 @@ paths:
put:
tags:
- 'HuidigeGebruikers'
- description: Vervangen van een HuidigeGebruiker
+ summary: Vervangen van een HuidigeGebruiker
operationId: replaceHuidigeGebruikerById
parameters:
- name: 'id'
@@ -862,7 +862,7 @@ paths:
patch:
tags:
- 'HuidigeGebruikers'
- description: Wijzigen van een HuidigeGebruiker
+ summary: Wijzigen van een HuidigeGebruiker
operationId: updateHuidigeGebruikerById
parameters:
- name: 'id'
@@ -901,7 +901,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Ophalen van Kandidaten
+ summary: Ophalen van Kandidaten
operationId: listKandidaten
parameters:
- name: params
@@ -951,7 +951,7 @@ paths:
post:
tags:
- 'Kandidaten'
- description: Voegt een nieuw(e) Kandidaat toe.
+ summary: Voegt een nieuw(e) Kandidaat toe.
operationId: createKandidaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -991,7 +991,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Vervangen van een Kandidaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKandidaat
parameters:
@@ -1026,7 +1026,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kandidaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKandidaat
@@ -1063,7 +1063,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Retourneert een Kandidaat met de gegeven identifier
+ summary: Retourneert een Kandidaat met de gegeven identifier
operationId: readKandidaatById
parameters:
- name: id
@@ -1100,7 +1100,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: Vervangen van een Kandidaat
+ summary: Vervangen van een Kandidaat
operationId: replaceKandidaatById
parameters:
- name: 'id'
@@ -1138,7 +1138,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: Wijzigen van een Kandidaat
+ summary: Wijzigen van een Kandidaat
operationId: updateKandidaatById
parameters:
- name: 'id'
@@ -1177,7 +1177,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Ophalen van Publicaties
+ summary: Ophalen van Publicaties
operationId: listPublicaties
parameters:
- name: params
@@ -1227,7 +1227,7 @@ paths:
post:
tags:
- 'Publicaties'
- description: Voegt een nieuw(e) Publicatie toe.
+ summary: Voegt een nieuw(e) Publicatie toe.
operationId: createPublicatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1267,7 +1267,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: |
+ summary: |
Vervangen van een Publicatie op basis van overeenkomstige sleutelvelden.
operationId: replacePublicatie
parameters:
@@ -1302,7 +1302,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Publicatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePublicatie
@@ -1339,7 +1339,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Retourneert een Publicatie met de gegeven identifier
+ summary: Retourneert een Publicatie met de gegeven identifier
operationId: readPublicatieById
parameters:
- name: id
@@ -1376,7 +1376,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: Vervangen van een Publicatie
+ summary: Vervangen van een Publicatie
operationId: replacePublicatieById
parameters:
- name: 'id'
@@ -1414,7 +1414,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: Wijzigen van een Publicatie
+ summary: Wijzigen van een Publicatie
operationId: updatePublicatieById
parameters:
- name: 'id'
@@ -1453,7 +1453,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Ophalen van Puntenberekeningen
+ summary: Ophalen van Puntenberekeningen
operationId: listPuntenberekeningen
parameters:
- name: params
@@ -1503,7 +1503,7 @@ paths:
post:
tags:
- 'Puntenberekeningen'
- description: Voegt een nieuw(e) Puntenberekening toe.
+ summary: Voegt een nieuw(e) Puntenberekening toe.
operationId: createPuntenberekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1543,7 +1543,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Vervangen van een Puntenberekening op basis van overeenkomstige sleutelvelden.
operationId: replacePuntenberekening
parameters:
@@ -1578,7 +1578,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntenberekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntenberekening
@@ -1615,7 +1615,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Retourneert een Puntenberekening met de gegeven identifier
+ summary: Retourneert een Puntenberekening met de gegeven identifier
operationId: readPuntenberekeningById
parameters:
- name: id
@@ -1652,7 +1652,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: Vervangen van een Puntenberekening
+ summary: Vervangen van een Puntenberekening
operationId: replacePuntenberekeningById
parameters:
- name: 'id'
@@ -1690,7 +1690,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: Wijzigen van een Puntenberekening
+ summary: Wijzigen van een Puntenberekening
operationId: updatePuntenberekeningById
parameters:
- name: 'id'
@@ -1729,7 +1729,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Ophalen van Puntengebeurtenissen
+ summary: Ophalen van Puntengebeurtenissen
operationId: listPuntengebeurtenissen
parameters:
- name: params
@@ -1779,7 +1779,7 @@ paths:
post:
tags:
- 'Puntengebeurtenissen'
- description: Voegt een nieuw(e) Puntengebeurtenis toe.
+ summary: Voegt een nieuw(e) Puntengebeurtenis toe.
operationId: createPuntengebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1819,7 +1819,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Vervangen van een Puntengebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replacePuntengebeurtenis
parameters:
@@ -1854,7 +1854,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntengebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntengebeurtenis
@@ -1891,7 +1891,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Retourneert een Puntengebeurtenis met de gegeven identifier
+ summary: Retourneert een Puntengebeurtenis met de gegeven identifier
operationId: readPuntengebeurtenisById
parameters:
- name: id
@@ -1928,7 +1928,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: Vervangen van een Puntengebeurtenis
+ summary: Vervangen van een Puntengebeurtenis
operationId: replacePuntengebeurtenisById
parameters:
- name: 'id'
@@ -1966,7 +1966,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: Wijzigen van een Puntengebeurtenis
+ summary: Wijzigen van een Puntengebeurtenis
operationId: updatePuntengebeurtenisById
parameters:
- name: 'id'
@@ -2005,7 +2005,7 @@ paths:
get:
tags:
- 'Puntenmutaties'
- description: Ophalen van Puntenmutaties
+ summary: Ophalen van Puntenmutaties
operationId: listPuntenmutaties
parameters:
- name: params
@@ -2055,7 +2055,7 @@ paths:
post:
tags:
- 'Puntenmutaties'
- description: Voegt een nieuw(e) Puntenmutatie toe.
+ summary: Voegt een nieuw(e) Puntenmutatie toe.
operationId: createPuntenmutatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2095,7 +2095,7 @@ paths:
put:
tags:
- 'Puntenmutaties'
- description: |
+ summary: |
Vervangen van een Puntenmutatie op basis van overeenkomstige sleutelvelden.
operationId: replacePuntenmutatie
parameters:
@@ -2130,7 +2130,7 @@ paths:
patch:
tags:
- 'Puntenmutaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntenmutatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntenmutatie
@@ -2167,7 +2167,7 @@ paths:
get:
tags:
- 'Puntenmutaties'
- description: Retourneert een Puntenmutatie met de gegeven identifier
+ summary: Retourneert een Puntenmutatie met de gegeven identifier
operationId: readPuntenmutatieById
parameters:
- name: id
@@ -2204,7 +2204,7 @@ paths:
put:
tags:
- 'Puntenmutaties'
- description: Vervangen van een Puntenmutatie
+ summary: Vervangen van een Puntenmutatie
operationId: replacePuntenmutatieById
parameters:
- name: 'id'
@@ -2242,7 +2242,7 @@ paths:
patch:
tags:
- 'Puntenmutaties'
- description: Wijzigen van een Puntenmutatie
+ summary: Wijzigen van een Puntenmutatie
operationId: updatePuntenmutatieById
parameters:
- name: 'id'
@@ -2281,7 +2281,7 @@ paths:
get:
tags:
- 'Reacties'
- description: Ophalen van Reacties
+ summary: Ophalen van Reacties
operationId: listReacties
parameters:
- name: params
@@ -2331,7 +2331,7 @@ paths:
post:
tags:
- 'Reacties'
- description: Voegt een nieuw(e) Reactie toe.
+ summary: Voegt een nieuw(e) Reactie toe.
operationId: createReactie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2371,7 +2371,7 @@ paths:
put:
tags:
- 'Reacties'
- description: |
+ summary: |
Vervangen van een Reactie op basis van overeenkomstige sleutelvelden.
operationId: replaceReactie
parameters:
@@ -2406,7 +2406,7 @@ paths:
patch:
tags:
- 'Reacties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Reactie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReactie
@@ -2443,7 +2443,7 @@ paths:
get:
tags:
- 'Reacties'
- description: Retourneert een Reactie met de gegeven identifier
+ summary: Retourneert een Reactie met de gegeven identifier
operationId: readReactieById
parameters:
- name: id
@@ -2480,7 +2480,7 @@ paths:
put:
tags:
- 'Reacties'
- description: Vervangen van een Reactie
+ summary: Vervangen van een Reactie
operationId: replaceReactieById
parameters:
- name: 'id'
@@ -2518,7 +2518,7 @@ paths:
patch:
tags:
- 'Reacties'
- description: Wijzigen van een Reactie
+ summary: Wijzigen van een Reactie
operationId: updateReactieById
parameters:
- name: 'id'
@@ -2557,7 +2557,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Ophalen van Reclamaties
+ summary: Ophalen van Reclamaties
operationId: listReclamaties
parameters:
- name: params
@@ -2607,7 +2607,7 @@ paths:
post:
tags:
- 'Reclamaties'
- description: Voegt een nieuw(e) Reclamatie toe.
+ summary: Voegt een nieuw(e) Reclamatie toe.
operationId: createReclamatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2647,7 +2647,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Vervangen van een Reclamatie op basis van overeenkomstige sleutelvelden.
operationId: replaceReclamatie
parameters:
@@ -2682,7 +2682,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Reclamatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReclamatie
@@ -2719,7 +2719,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Retourneert een Reclamatie met de gegeven identifier
+ summary: Retourneert een Reclamatie met de gegeven identifier
operationId: readReclamatieById
parameters:
- name: id
@@ -2756,7 +2756,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: Vervangen van een Reclamatie
+ summary: Vervangen van een Reclamatie
operationId: replaceReclamatieById
parameters:
- name: 'id'
@@ -2794,7 +2794,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: Wijzigen van een Reclamatie
+ summary: Wijzigen van een Reclamatie
operationId: updateReclamatieById
parameters:
- name: 'id'
@@ -2833,7 +2833,7 @@ paths:
get:
tags:
- 'Regelingen'
- description: Ophalen van Regelingen
+ summary: Ophalen van Regelingen
operationId: listRegelingen
parameters:
- name: params
@@ -2883,7 +2883,7 @@ paths:
post:
tags:
- 'Regelingen'
- description: Voegt een nieuw(e) Regeling toe.
+ summary: Voegt een nieuw(e) Regeling toe.
operationId: createRegeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2923,7 +2923,7 @@ paths:
put:
tags:
- 'Regelingen'
- description: |
+ summary: |
Vervangen van een Regeling op basis van overeenkomstige sleutelvelden.
operationId: replaceRegeling
parameters:
@@ -2958,7 +2958,7 @@ paths:
patch:
tags:
- 'Regelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Regeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRegeling
@@ -2995,7 +2995,7 @@ paths:
get:
tags:
- 'Regelingen'
- description: Retourneert een Regeling met de gegeven identifier
+ summary: Retourneert een Regeling met de gegeven identifier
operationId: readRegelingById
parameters:
- name: id
@@ -3032,7 +3032,7 @@ paths:
put:
tags:
- 'Regelingen'
- description: Vervangen van een Regeling
+ summary: Vervangen van een Regeling
operationId: replaceRegelingById
parameters:
- name: 'id'
@@ -3070,7 +3070,7 @@ paths:
patch:
tags:
- 'Regelingen'
- description: Wijzigen van een Regeling
+ summary: Wijzigen van een Regeling
operationId: updateRegelingById
parameters:
- name: 'id'
@@ -3109,7 +3109,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Ophalen van Sancties
+ summary: Ophalen van Sancties
operationId: listSancties
parameters:
- name: params
@@ -3159,7 +3159,7 @@ paths:
post:
tags:
- 'Sancties'
- description: Voegt een nieuw(e) Sanctie toe.
+ summary: Voegt een nieuw(e) Sanctie toe.
operationId: createSanctie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3199,7 +3199,7 @@ paths:
put:
tags:
- 'Sancties'
- description: |
+ summary: |
Vervangen van een Sanctie op basis van overeenkomstige sleutelvelden.
operationId: replaceSanctie
parameters:
@@ -3234,7 +3234,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Sanctie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSanctie
@@ -3271,7 +3271,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Retourneert een Sanctie met de gegeven identifier
+ summary: Retourneert een Sanctie met de gegeven identifier
operationId: readSanctieById
parameters:
- name: id
@@ -3308,7 +3308,7 @@ paths:
put:
tags:
- 'Sancties'
- description: Vervangen van een Sanctie
+ summary: Vervangen van een Sanctie
operationId: replaceSanctieById
parameters:
- name: 'id'
@@ -3346,7 +3346,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: Wijzigen van een Sanctie
+ summary: Wijzigen van een Sanctie
operationId: updateSanctieById
parameters:
- name: 'id'
@@ -3385,7 +3385,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Ophalen van Toewijzingen
+ summary: Ophalen van Toewijzingen
operationId: listToewijzingen
parameters:
- name: params
@@ -3435,7 +3435,7 @@ paths:
post:
tags:
- 'Toewijzingen'
- description: Voegt een nieuw(e) Toewijzing toe.
+ summary: Voegt een nieuw(e) Toewijzing toe.
operationId: createToewijzing
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3475,7 +3475,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Vervangen van een Toewijzing op basis van overeenkomstige sleutelvelden.
operationId: replaceToewijzing
parameters:
@@ -3510,7 +3510,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Toewijzing. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateToewijzing
@@ -3547,7 +3547,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Retourneert een Toewijzing met de gegeven identifier
+ summary: Retourneert een Toewijzing met de gegeven identifier
operationId: readToewijzingById
parameters:
- name: id
@@ -3584,7 +3584,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: Vervangen van een Toewijzing
+ summary: Vervangen van een Toewijzing
operationId: replaceToewijzingById
parameters:
- name: 'id'
@@ -3622,7 +3622,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: Wijzigen van een Toewijzing
+ summary: Wijzigen van een Toewijzing
operationId: updateToewijzingById
parameters:
- name: 'id'
@@ -3661,7 +3661,7 @@ paths:
get:
tags:
- 'Voorrangsregelingen'
- description: Ophalen van Voorrangsregelingen
+ summary: Ophalen van Voorrangsregelingen
operationId: listVoorrangsregelingen
parameters:
- name: params
@@ -3711,7 +3711,7 @@ paths:
post:
tags:
- 'Voorrangsregelingen'
- description: Voegt een nieuw(e) Voorrangsregeling toe.
+ summary: Voegt een nieuw(e) Voorrangsregeling toe.
operationId: createVoorrangsregeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3751,7 +3751,7 @@ paths:
put:
tags:
- 'Voorrangsregelingen'
- description: |
+ summary: |
Vervangen van een Voorrangsregeling op basis van overeenkomstige sleutelvelden.
operationId: replaceVoorrangsregeling
parameters:
@@ -3786,7 +3786,7 @@ paths:
patch:
tags:
- 'Voorrangsregelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Voorrangsregeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVoorrangsregeling
@@ -3823,7 +3823,7 @@ paths:
get:
tags:
- 'Voorrangsregelingen'
- description: Retourneert een Voorrangsregeling met de gegeven identifier
+ summary: Retourneert een Voorrangsregeling met de gegeven identifier
operationId: readVoorrangsregelingById
parameters:
- name: id
@@ -3860,7 +3860,7 @@ paths:
put:
tags:
- 'Voorrangsregelingen'
- description: Vervangen van een Voorrangsregeling
+ summary: Vervangen van een Voorrangsregeling
operationId: replaceVoorrangsregelingById
parameters:
- name: 'id'
@@ -3898,7 +3898,7 @@ paths:
patch:
tags:
- 'Voorrangsregelingen'
- description: Wijzigen van een Voorrangsregeling
+ summary: Wijzigen van een Voorrangsregeling
operationId: updateVoorrangsregelingById
parameters:
- name: 'id'
@@ -3937,7 +3937,7 @@ paths:
get:
tags:
- 'VoorrangsregelingProfielen'
- description: Ophalen van VoorrangsregelingProfielen
+ summary: Ophalen van VoorrangsregelingProfielen
operationId: listVoorrangsregelingProfielen
parameters:
- name: params
@@ -3987,7 +3987,7 @@ paths:
post:
tags:
- 'VoorrangsregelingProfielen'
- description: Voegt een nieuw(e) VoorrangsregelingProfiel toe.
+ summary: Voegt een nieuw(e) VoorrangsregelingProfiel toe.
operationId: createVoorrangsregelingProfiel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4027,7 +4027,7 @@ paths:
put:
tags:
- 'VoorrangsregelingProfielen'
- description: |
+ summary: |
Vervangen van een VoorrangsregelingProfiel op basis van overeenkomstige sleutelvelden.
operationId: replaceVoorrangsregelingProfiel
parameters:
@@ -4062,7 +4062,7 @@ paths:
patch:
tags:
- 'VoorrangsregelingProfielen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een VoorrangsregelingProfiel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVoorrangsregelingProfiel
@@ -4099,7 +4099,7 @@ paths:
get:
tags:
- 'VoorrangsregelingProfielen'
- description: Retourneert een VoorrangsregelingProfiel met de gegeven identifier
+ summary: Retourneert een VoorrangsregelingProfiel met de gegeven identifier
operationId: readVoorrangsregelingProfielById
parameters:
- name: id
@@ -4136,7 +4136,7 @@ paths:
put:
tags:
- 'VoorrangsregelingProfielen'
- description: Vervangen van een VoorrangsregelingProfiel
+ summary: Vervangen van een VoorrangsregelingProfiel
operationId: replaceVoorrangsregelingProfielById
parameters:
- name: 'id'
@@ -4174,7 +4174,7 @@ paths:
patch:
tags:
- 'VoorrangsregelingProfielen'
- description: Wijzigen van een VoorrangsregelingProfiel
+ summary: Wijzigen van een VoorrangsregelingProfiel
operationId: updateVoorrangsregelingProfielById
parameters:
- name: 'id'
@@ -4213,7 +4213,7 @@ paths:
get:
tags:
- 'Zoekprofiellen'
- description: Ophalen van Zoekprofiellen
+ summary: Ophalen van Zoekprofiellen
operationId: listZoekprofiellen
parameters:
- name: params
@@ -4263,7 +4263,7 @@ paths:
post:
tags:
- 'Zoekprofiellen'
- description: Voegt een nieuw(e) Zoekprofiel toe.
+ summary: Voegt een nieuw(e) Zoekprofiel toe.
operationId: createZoekprofiel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4303,7 +4303,7 @@ paths:
put:
tags:
- 'Zoekprofiellen'
- description: |
+ summary: |
Vervangen van een Zoekprofiel op basis van overeenkomstige sleutelvelden.
operationId: replaceZoekprofiel
parameters:
@@ -4338,7 +4338,7 @@ paths:
patch:
tags:
- 'Zoekprofiellen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zoekprofiel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZoekprofiel
@@ -4375,7 +4375,7 @@ paths:
get:
tags:
- 'Zoekprofiellen'
- description: Retourneert een Zoekprofiel met de gegeven identifier
+ summary: Retourneert een Zoekprofiel met de gegeven identifier
operationId: readZoekprofielById
parameters:
- name: id
@@ -4412,7 +4412,7 @@ paths:
put:
tags:
- 'Zoekprofiellen'
- description: Vervangen van een Zoekprofiel
+ summary: Vervangen van een Zoekprofiel
operationId: replaceZoekprofielById
parameters:
- name: 'id'
@@ -4450,7 +4450,7 @@ paths:
patch:
tags:
- 'Zoekprofiellen'
- description: Wijzigen van een Zoekprofiel
+ summary: Wijzigen van een Zoekprofiel
operationId: updateZoekprofielById
parameters:
- name: 'id'
@@ -4522,10 +4522,48 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Woonruimteverdeling.All.Read: alleen lezen van alle resources
+ Woonruimteverdeling.All.ReadWrite: lezen en schrijven van alle resources
+ Woonruimteverdeling.Aanbiedingen.Read: alleen lezen van Aanbiedingen
+ Woonruimteverdeling.Aanbiedingen.ReadWrite: lezen en schrijven van Aanbiedingen
+ Woonruimteverdeling.Gebeurtenissen.Read: alleen lezen van Gebeurtenissen
+ Woonruimteverdeling.Gebeurtenissen.ReadWrite: lezen en schrijven van Gebeurtenissen
+ Woonruimteverdeling.HuidigeGebruikers.Read: alleen lezen van HuidigeGebruikers
+ Woonruimteverdeling.HuidigeGebruikers.ReadWrite: lezen en schrijven van HuidigeGebruikers
+ Woonruimteverdeling.Kandidaten.Read: alleen lezen van Kandidaten
+ Woonruimteverdeling.Kandidaten.ReadWrite: lezen en schrijven van Kandidaten
+ Woonruimteverdeling.Publicaties.Read: alleen lezen van Publicaties
+ Woonruimteverdeling.Publicaties.ReadWrite: lezen en schrijven van Publicaties
+ Woonruimteverdeling.Puntenberekeningen.Read: alleen lezen van Puntenberekeningen
+ Woonruimteverdeling.Puntenberekeningen.ReadWrite: lezen en schrijven van Puntenberekeningen
+ Woonruimteverdeling.Puntengebeurtenissen.Read: alleen lezen van Puntengebeurtenissen
+ Woonruimteverdeling.Puntengebeurtenissen.ReadWrite: lezen en schrijven van Puntengebeurtenissen
+ Woonruimteverdeling.Puntenmutaties.Read: alleen lezen van Puntenmutaties
+ Woonruimteverdeling.Puntenmutaties.ReadWrite: lezen en schrijven van Puntenmutaties
+ Woonruimteverdeling.Reacties.Read: alleen lezen van Reacties
+ Woonruimteverdeling.Reacties.ReadWrite: lezen en schrijven van Reacties
+ Woonruimteverdeling.Reclamaties.Read: alleen lezen van Reclamaties
+ Woonruimteverdeling.Reclamaties.ReadWrite: lezen en schrijven van Reclamaties
+ Woonruimteverdeling.Regelingen.Read: alleen lezen van Regelingen
+ Woonruimteverdeling.Regelingen.ReadWrite: lezen en schrijven van Regelingen
+ Woonruimteverdeling.Sancties.Read: alleen lezen van Sancties
+ Woonruimteverdeling.Sancties.ReadWrite: lezen en schrijven van Sancties
+ Woonruimteverdeling.Toewijzingen.Read: alleen lezen van Toewijzingen
+ Woonruimteverdeling.Toewijzingen.ReadWrite: lezen en schrijven van Toewijzingen
+ Woonruimteverdeling.Voorrangsregelingen.Read: alleen lezen van Voorrangsregelingen
+ Woonruimteverdeling.Voorrangsregelingen.ReadWrite: lezen en schrijven van Voorrangsregelingen
+ Woonruimteverdeling.VoorrangsregelingProfielen.Read: alleen lezen van VoorrangsregelingProfielen
+ Woonruimteverdeling.VoorrangsregelingProfielen.ReadWrite: lezen en schrijven van VoorrangsregelingProfielen
+ Woonruimteverdeling.Zoekprofiellen.Read: alleen lezen van Zoekprofiellen
+ Woonruimteverdeling.Zoekprofiellen.ReadWrite: lezen en schrijven van Zoekprofiellen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Woonruimteverdeling.All.Read: alleen lezen van alle resources
Woonruimteverdeling.All.ReadWrite: lezen en schrijven van alle resources
@@ -4619,33 +4657,33 @@ components:
bezichtiging:
type: string
format: uri
- description: Referentie naar Afspraak in informatiedomein Relaties
+ description: Referentie naar Afspraak-sleutels in informatiedomein Relaties
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
kandidaat:
allOf:
- - $ref: '#/components/schemas/Kandidaat'
+ - $ref: '#/components/schemas/Kandidaat-sleutels'
description: De kandidaat behorend bij de aanbieding.
publicatie:
allOf:
- - $ref: '#/components/schemas/Publicatie'
+ - $ref: '#/components/schemas/Publicatie-sleutels'
description: De publicatie naar aanleiding waarvan de aanbieding is gedaan.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4672,7 +4710,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -4684,7 +4722,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -4720,6 +4758,144 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ Kandidaat-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Publicatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Gebeurtenisbericht:
+ allOf:
+ - $ref: '#/components/schemas/Gebeurtenis'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Gebeurtenis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn. OBSOLETE
+ deprecated: true
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling. OBSOLETE
+ deprecated: true
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden. OBSOLETE
+ deprecated: true
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
+ deprecated: true
+ datum:
+ type: string
+ format: date-time
+ description: De datum waarop gebeurtenis heeft plaatsgevonden. OBSOLETE
+ deprecated: true
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum van de geldigheid van de gebeurtenis. OBSOLETE
+ deprecated: true
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum van de geldigheid van de gebeurtenis. OBSOLETE
+ deprecated: true
+ adres:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ contextId:
+ type: string
+ format: any
+ description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc. OBSOLETE
+ deprecated: true
+ inschrijving:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. OBSOLETE Referentiedatasoort VESTIGING.
+ deprecated: true
+ HuidigeGebruikerbericht:
+ allOf:
+ - $ref: '#/components/schemas/HuidigeGebruiker'
+ - $ref: '#/components/schemas/Bericht-basis'
+ HuidigeGebruiker:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Vertrekdatum:
+ type: string
+ format: date-time
+ description: de vertrekdatum van de huidige gebruiker OBSOLETE
+ deprecated: true
+ vertrekdatum:
+ type: string
+ format: date-time
+ description: de vertrekdatum van de huidige gebruiker
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ contactgegevens:
+ type: string
+ format: uri
+ description: Referentie naar Contactgegeven-sleutels in informatiedomein Relaties
Kandidaatbericht:
allOf:
- $ref: '#/components/schemas/Kandidaat'
@@ -4761,27 +4937,27 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
positie:
type: integer
format: int32
description: De positie van de kandidaat voor een eenheid ten opzichte van de overige kandidaten.
publicatie:
allOf:
- - $ref: '#/components/schemas/Publicatie'
+ - $ref: '#/components/schemas/Publicatie-sleutels'
description: De publicatie waarvoor de kandidaat in aanmerking komt.
reactie:
allOf:
- - $ref: '#/components/schemas/Reactie'
+ - $ref: '#/components/schemas/Reactie-sleutels'
description: De reactie behorend bij de kandidaat.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Aanbieding-sleutels:
type: object
properties:
@@ -4801,6 +4977,25 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Reactie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Publicatiebericht:
allOf:
- $ref: '#/components/schemas/Publicatie'
@@ -4863,7 +5058,7 @@ components:
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
detailModel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4873,10 +5068,10 @@ components:
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
huidigeGebruiker:
allOf:
- - $ref: '#/components/schemas/HuidigeGebruiker'
+ - $ref: '#/components/schemas/HuidigeGebruiker-sleutels'
description: De huidige gebruiker van de eenheid
intakevorm:
allOf:
@@ -4923,11 +5118,7 @@ components:
type: integer
format: int32
description: De gemiddelde wachttijd in maanden voor mensen met voorrang.
- HuidigeGebruikerbericht:
- allOf:
- - $ref: '#/components/schemas/HuidigeGebruiker'
- - $ref: '#/components/schemas/Bericht-basis'
- HuidigeGebruiker:
+ HuidigeGebruiker-sleutels:
type: object
properties:
id:
@@ -4946,28 +5137,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Vertrekdatum:
- type: string
- format: date-time
- description: de vertrekdatum van de huidige gebruiker OBSOLETE
- deprecated: true
- vertrekdatum:
- type: string
- format: date-time
- description: de vertrekdatum van de huidige gebruiker
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- contactgegevens:
- type: string
- format: uri
- description: Referentie naar Contactgegeven in informatiedomein Relaties
- Reactiebericht:
+ Puntenberekeningbericht:
allOf:
- - $ref: '#/components/schemas/Reactie'
+ - $ref: '#/components/schemas/Puntenberekening'
- $ref: '#/components/schemas/Bericht-basis'
- Reactie:
+ Puntenberekening:
type: object
properties:
id:
@@ -4982,127 +5156,118 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
- type: string
- format: any
- description: 'Het soort reactie. Bijvoorbeeld: Optie of belangstelling.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de reactie. Referentiedatasoort REACTIESTATUS.
- detailStatus:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De detail status van de reactie. Referentiedatasoort REACTIEDETAILSTATUS.
+ description: Het soort puntenberekening. Bij. Nieuwe inschrijving, Maandelijkse herberekening etc. Referentiedatasoort Puntenberekeningsoort.
datum:
type: string
format: date-time
- description: De datum en het tijdstip waarop de reactie is geplaatst.
- begeleiderDatum:
+ description: De datum waarop berekening heeft plaatsgevonden.
+ begindatum:
type: string
format: date-time
- description: De datum en tijd waarop de begeleider namens de woningzoekende een reactie heeft geplaatst.
- contactmomenten:
+ description: De begindatum van de geldigheid van de berekenis.
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum van de geldigheid van de berekenis.
+ puntenmutaties:
+ description: De puntenmutaties die hebben geleid tot een puntenberekening.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- overeenkomst:
+ $ref: '#/components/schemas/Puntenmutatie-sleutels'
+ relatie:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- positie:
- type: integer
- format: int32
- description: De positie van de kandidaat ten tijde van de reactie.
- publicatie:
- allOf:
- - $ref: '#/components/schemas/Publicatie'
- description: De publicatie behorend bij de reactie.
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- statusToelichting:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ situatiepunten:
+ type: number
+ format: float
+ description: Het aantal punten voor dringende omstandigheden die niet binnen gemeentelijk urgentiebeleid vallen.
+ startpunten:
+ type: number
+ format: float
+ description: Het aantal punten dat men krijgt voor voorrang binnen de eigen gemeente.
+ zoekpunten:
+ type: number
+ format: float
+ description: Het aantal punten dat aangeeft hoe actief men op zoek is naar een woning.
+ Puntenmutatie-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van de status van de reactie in het proces.
- voorkeur:
- type: integer
- format: int32
- description: De volgorde van reacties op voorkeur van de woningzoekende.
- Gebeurtenisbericht:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort puntenmutatie. Referentiedatasoort PUNTENMUTATIESOORT.
+ Puntengebeurtenisbericht:
allOf:
- - $ref: '#/components/schemas/Gebeurtenis'
+ - $ref: '#/components/schemas/Puntengebeurtenis'
- $ref: '#/components/schemas/Bericht-basis'
- Gebeurtenis:
+ Puntengebeurtenis:
type: object
properties:
id:
type: string
format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn. OBSOLETE
- deprecated: true
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
idExtern:
type: string
format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling. OBSOLETE
- deprecated: true
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
idGegevensbeheerder:
type: string
format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden. OBSOLETE
- deprecated: true
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
- deprecated: true
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. Referentiedatasoort GEBEURTENISSOORT.
datum:
type: string
format: date-time
- description: De datum waarop gebeurtenis heeft plaatsgevonden. OBSOLETE
- deprecated: true
+ description: De datum waarop gebeurtenis heeft plaatsgevonden.
begindatum:
type: string
format: date-time
- description: De begindatum van de geldigheid van de gebeurtenis. OBSOLETE
- deprecated: true
+ description: De begindatum van de geldigheid van de gebeurtenis.
einddatum:
type: string
format: date-time
- description: De einddatum van de geldigheid van de gebeurtenis. OBSOLETE
- deprecated: true
+ description: De einddatum van de geldigheid van de gebeurtenis.
adres:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
contextId:
type: string
format: any
- description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc. OBSOLETE
- deprecated: true
+ description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc.
+ gerelateerdeGebeurtenis:
+ allOf:
+ - $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
+ description: Gebeurtenis waarop de gebeurtenis betrekking op heeft. Hiermee kan bijvoorbeeld de relatie worden gelegd tussen een ingetrokken no-show en een no-show.
inschrijving:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
vestiging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. OBSOLETE Referentiedatasoort VESTIGING.
- deprecated: true
- Puntenberekeningbericht:
- allOf:
- - $ref: '#/components/schemas/Puntenberekening'
- - $ref: '#/components/schemas/Bericht-basis'
- Puntenberekening:
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
+ Puntengebeurtenis-sleutels:
type: object
properties:
id:
@@ -5120,40 +5285,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort puntenberekening. Bij. Nieuwe inschrijving, Maandelijkse herberekening etc. Referentiedatasoort Puntenberekeningsoort.
- datum:
- type: string
- format: date-time
- description: De datum waarop berekening heeft plaatsgevonden.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van de geldigheid van de berekenis.
- einddatum:
- type: string
- format: date-time
- description: De einddatum van de geldigheid van de berekenis.
- puntenmutaties:
- description: De puntenmutaties die hebben geleid tot een puntenberekening.
- type: array
- items:
- $ref: '#/components/schemas/Puntenmutatie'
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- situatiepunten:
- type: number
- format: float
- description: Het aantal punten voor dringende omstandigheden die niet binnen gemeentelijk urgentiebeleid vallen.
- startpunten:
- type: number
- format: float
- description: Het aantal punten dat men krijgt voor voorrang binnen de eigen gemeente.
- zoekpunten:
- type: number
- format: float
- description: Het aantal punten dat aangeeft hoe actief men op zoek is naar een woning.
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. Referentiedatasoort GEBEURTENISSOORT.
Puntenmutatiebericht:
allOf:
- $ref: '#/components/schemas/Puntenmutatie'
@@ -5189,17 +5321,17 @@ components:
description: De gebeurtenissen welke hebben geleid tot de puntenmutatie. OBSOLETE.
type: array
items:
- $ref: '#/components/schemas/Gebeurtenis'
+ $ref: '#/components/schemas/Gebeurtenis-sleutels'
deprecated: true
puntengebeurtenissen:
description: De gebeurtenissen welke hebben geleid tot de puntenmutatie.
type: array
items:
- $ref: '#/components/schemas/Puntengebeurtenis'
+ $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
situatiepunten:
type: number
format: float
@@ -5212,62 +5344,34 @@ components:
type: number
format: float
description: Het aantal punten dat aangeeft hoe actief men op zoek is naar een woning.
- Puntengebeurtenisbericht:
- allOf:
- - $ref: '#/components/schemas/Puntengebeurtenis'
- - $ref: '#/components/schemas/Bericht-basis'
- Puntengebeurtenis:
+ Gebeurtenis-sleutels:
type: object
properties:
id:
type: string
format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn. OBSOLETE
+ deprecated: true
idExtern:
type: string
format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling. OBSOLETE
+ deprecated: true
idGegevensbeheerder:
type: string
format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden. OBSOLETE
+ deprecated: true
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. Referentiedatasoort GEBEURTENISSOORT.
- datum:
- type: string
- format: date-time
- description: De datum waarop gebeurtenis heeft plaatsgevonden.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van de geldigheid van de gebeurtenis.
- einddatum:
- type: string
- format: date-time
- description: De einddatum van de geldigheid van de gebeurtenis.
- adres:
- type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- contextId:
- type: string
- format: any
- description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc.
- gerelateerdeGebeurtenis:
- allOf:
- - $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
- description: Gebeurtenis waarop de gebeurtenis betrekking op heeft. Hiermee kan bijvoorbeeld de relatie worden gelegd tussen een ingetrokken no-show en een no-show.
- inschrijving:
- type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- vestiging:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
- Puntengebeurtenis-sleutels:
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
+ deprecated: true
+ Reactiebericht:
+ allOf:
+ - $ref: '#/components/schemas/Reactie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Reactie:
type: object
properties:
id:
@@ -5282,10 +5386,62 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
+ type: string
+ format: any
+ description: 'Het soort reactie. Bijvoorbeeld: Optie of belangstelling.'
+ status:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de reactie. Referentiedatasoort REACTIESTATUS.
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De detail status van de reactie. Referentiedatasoort REACTIEDETAILSTATUS.
+ datum:
+ type: string
+ format: date-time
+ description: De datum en het tijdstip waarop de reactie is geplaatst.
+ begeleiderDatum:
+ type: string
+ format: date-time
+ description: De datum en tijd waarop de begeleider namens de woningzoekende een reactie heeft geplaatst.
+ contactmomenten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ positie:
+ type: integer
+ format: int32
+ description: De positie van de kandidaat ten tijde van de reactie.
+ publicatie:
+ allOf:
+ - $ref: '#/components/schemas/Publicatie-sleutels'
+ description: De publicatie behorend bij de reactie.
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ statusToelichting:
+ type: string
+ format: any
+ description: De omschrijving van de status van de reactie in het proces.
+ voorkeur:
+ type: integer
+ format: int32
+ description: De volgorde van reacties op voorkeur van de woningzoekende.
Reclamatiebericht:
allOf:
- $ref: '#/components/schemas/Reclamatie'
@@ -5334,15 +5490,15 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
puntengebeurtenis:
allOf:
- - $ref: '#/components/schemas/Puntengebeurtenis'
+ - $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
description: De gebeurtenis waarover de klacht of het bezwaar is ingediend.
relaties:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Regelingbericht:
allOf:
- $ref: '#/components/schemas/Regeling'
@@ -5378,13 +5534,17 @@ components:
type: string
format: date-time
description: De einddatum die aangeeft tot wanneer men van de regeling gebruik maakt of mag maken.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
gebruiken:
type: boolean
description: De waarde die aangeeft of men gebruik maakt van de regeling.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Sanctiebericht:
allOf:
- $ref: '#/components/schemas/Sanctie'
@@ -5428,17 +5588,17 @@ components:
description: De geberutenissen die hebben geleid tot de sanctie. OBSOLETE.
type: array
items:
- $ref: '#/components/schemas/Gebeurtenis'
+ $ref: '#/components/schemas/Gebeurtenis-sleutels'
deprecated: true
puntengebeurtenissen:
- description: De geberutenissen die hebben geleid tot de sanctie.
+ description: De gebeurtenissen die hebben geleid tot de sanctie.
type: array
items:
- $ref: '#/components/schemas/Puntengebeurtenis'
+ $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Toewijzingbericht:
allOf:
- $ref: '#/components/schemas/Toewijzing'
@@ -5468,7 +5628,7 @@ components:
description: De datum waarop de eenheid is toegewezen.
aanbieding:
allOf:
- - $ref: '#/components/schemas/Aanbieding'
+ - $ref: '#/components/schemas/Aanbieding-sleutels'
description: De aanbieding behorend bij de toewijzing.
aanvullendeDoelgroep:
allOf:
@@ -5479,13 +5639,13 @@ components:
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
doelgroep:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5493,7 +5653,7 @@ components:
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
huishoudgrootte:
type: integer
format: int32
@@ -5503,12 +5663,12 @@ components:
description: Geeft aan of de kandidaat, of één van diens medebewoners, op 1 januari van het jaar van toewijzen de pensioengerechtigde leeftijd bereikt.
kandidaat:
allOf:
- - $ref: '#/components/schemas/Kandidaat'
+ - $ref: '#/components/schemas/Kandidaat-sleutels'
description: De kandidaat behorende bij de toewijzing.
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
passendheiddetailsoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5519,7 +5679,7 @@ components:
description: De indicatie of de toewijzing passend is volgens de wetgeving of valt binnen de vrij toe te wijzen ruimte. Referentiedatasoort PASSENDHEIDSSOORT.
publicatie:
allOf:
- - $ref: '#/components/schemas/Publicatie'
+ - $ref: '#/components/schemas/Publicatie-sleutels'
description: De publicatie behorende bij de toewijzing.
rekenhuur:
type: number
@@ -5536,12 +5696,31 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
voorrangsregelingen:
description: De voorrangsregeling(en) die van toepassing was of waren voor de toewijzing binnen het woonruimteverdeelproces. Onderdeel van de reden van de toewijzing.
type: array
items:
- $ref: '#/components/schemas/Voorrangsregeling'
+ $ref: '#/components/schemas/Voorrangsregeling-sleutels'
+ Voorrangsregeling-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Voorrangsregelingbericht:
allOf:
- $ref: '#/components/schemas/Voorrangsregeling'
@@ -5585,14 +5764,37 @@ components:
type: string
format: date-time
description: De einddatum tot wanneer men deze voorrang heeft.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
profiel:
allOf:
- - $ref: '#/components/schemas/VoorrangsregelingProfiel'
+ - $ref: '#/components/schemas/VoorrangsregelingProfiel-sleutels'
description: Het profiel waarop de voorrangsregeling van toepassing is.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ VoorrangsregelingProfiel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
VoorrangsregelingProfielbericht:
allOf:
- $ref: '#/components/schemas/VoorrangsregelingProfiel'
@@ -5621,7 +5823,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Buurt in informatiedomein Vastgoed
+ description: Referenties naar Buurt-sleutels in informatiedomein Vastgoed
eenheidSoorten:
description: De eenheid soorten waar het voorrangsregeling profiel voor geldt. Referentiedatasoort VOORRANGEENHEIDSOORT.
type: array
@@ -5632,7 +5834,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Gemeente in informatiedomein Vastgoed
+ description: Referenties naar Gemeente-sleutels in informatiedomein Vastgoed
huidigeOppervlakte:
type: integer
format: int32
@@ -5669,7 +5871,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Stadsdeel in informatiedomein Vastgoed
+ description: Referenties naar Stadsdeel-sleutels in informatiedomein Vastgoed
toegankelijkheidslabels:
description: De toegankelijkheidslabels waar het voorrangsregeling profiel voor geldt. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
type: array
@@ -5680,13 +5882,13 @@ components:
items:
type: string
format: uri
- description: Referenties naar Wijk in informatiedomein Vastgoed
+ description: Referenties naar Wijk-sleutels in informatiedomein Vastgoed
woonplaatsen:
type: array
items:
type: string
format: uri
- description: Referenties naar Woonplaats in informatiedomein Vastgoed
+ description: Referenties naar Woonplaats-sleutels in informatiedomein Vastgoed
Zoekprofielbericht:
allOf:
- $ref: '#/components/schemas/Zoekprofiel'
@@ -5748,7 +5950,7 @@ components:
locaties:
type: string
format: uri
- description: Referentie naar Gemeente in informatiedomein Vastgoed
+ description: Referentie naar Gemeente-sleutels in informatiedomein Vastgoed
Publicatiemodellen:
description: Referentiedatasoort PUBLICATIEMODEL.
type: array
@@ -5757,9 +5959,9 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Toegankelijkheid:
- description: Welk niveau van toegankelijkheid men zoekt. Referentiedatasoort TOEGANKELIJKHEIDSLABELS.
+ description: Welk niveau van toegankelijkheid men zoekt. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
diff --git a/Ketenprocessen/BDO.yaml b/Ketenprocessen/BDO.yaml
index bf10924..286ffdc 100644
--- a/Ketenprocessen/BDO.yaml
+++ b/Ketenprocessen/BDO.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Casemanagement
- description: API-specificatie van ketenproces 'Casemanagement'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Casemanagement'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bdo.vera.io:{port}/{basePath}
description: Productieserver
@@ -31,7 +31,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -47,7 +47,7 @@ paths:
get:
tags:
- 'Dossiers'
- description: Ophalen van Dossiers
+ summary: Ophalen van Dossiers
operationId: listDossiers
parameters:
- name: params
@@ -97,7 +97,7 @@ paths:
post:
tags:
- 'Dossiers'
- description: Voegt een nieuw(e) Dossier toe.
+ summary: Voegt een nieuw(e) Dossier toe.
operationId: createDossier
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: |
+ summary: |
Vervangen van een Dossier op basis van overeenkomstige sleutelvelden.
operationId: replaceDossier
parameters:
@@ -172,7 +172,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Dossier. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDossier
@@ -209,7 +209,7 @@ paths:
get:
tags:
- 'Dossiers'
- description: Retourneert een Dossier met de gegeven identifier
+ summary: Retourneert een Dossier met de gegeven identifier
operationId: readDossierById
parameters:
- name: id
@@ -246,7 +246,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: Vervangen van een Dossier
+ summary: Vervangen van een Dossier
operationId: replaceDossierById
parameters:
- name: 'id'
@@ -284,7 +284,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: Wijzigen van een Dossier
+ summary: Wijzigen van een Dossier
operationId: updateDossierById
parameters:
- name: 'id'
@@ -323,7 +323,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Ophalen van Informatieobjecten
+ summary: Ophalen van Informatieobjecten
operationId: listInformatieobjecten
parameters:
- name: params
@@ -373,7 +373,7 @@ paths:
post:
tags:
- 'Informatieobjecten'
- description: Voegt een nieuw(e) Informatieobject toe.
+ summary: Voegt een nieuw(e) Informatieobject toe.
operationId: createInformatieobject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Vervangen van een Informatieobject op basis van overeenkomstige sleutelvelden.
operationId: replaceInformatieobject
parameters:
@@ -448,7 +448,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Informatieobject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInformatieobject
@@ -485,7 +485,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Retourneert een Informatieobject met de gegeven identifier
+ summary: Retourneert een Informatieobject met de gegeven identifier
operationId: readInformatieobjectById
parameters:
- name: id
@@ -522,7 +522,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: Vervangen van een Informatieobject
+ summary: Vervangen van een Informatieobject
operationId: replaceInformatieobjectById
parameters:
- name: 'id'
@@ -560,7 +560,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: Wijzigen van een Informatieobject
+ summary: Wijzigen van een Informatieobject
operationId: updateInformatieobjectById
parameters:
- name: 'id'
@@ -599,7 +599,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Ophalen van Zaken
+ summary: Ophalen van Zaken
operationId: listZaken
parameters:
- name: params
@@ -649,7 +649,7 @@ paths:
post:
tags:
- 'Zaken'
- description: Voegt een nieuw(e) Zaak toe.
+ summary: Voegt een nieuw(e) Zaak toe.
operationId: createZaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
put:
tags:
- 'Zaken'
- description: |
+ summary: |
Vervangen van een Zaak op basis van overeenkomstige sleutelvelden.
operationId: replaceZaak
parameters:
@@ -724,7 +724,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaak
@@ -761,7 +761,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Retourneert een Zaak met de gegeven identifier
+ summary: Retourneert een Zaak met de gegeven identifier
operationId: readZaakById
parameters:
- name: id
@@ -798,7 +798,7 @@ paths:
put:
tags:
- 'Zaken'
- description: Vervangen van een Zaak
+ summary: Vervangen van een Zaak
operationId: replaceZaakById
parameters:
- name: 'id'
@@ -836,7 +836,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: Wijzigen van een Zaak
+ summary: Wijzigen van een Zaak
operationId: updateZaakById
parameters:
- name: 'id'
@@ -908,10 +908,22 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BDO.All.Read: alleen lezen van alle resources
+ BDO.All.ReadWrite: lezen en schrijven van alle resources
+ BDO.Dossiers.Read: alleen lezen van Dossiers
+ BDO.Dossiers.ReadWrite: lezen en schrijven van Dossiers
+ BDO.Informatieobjecten.Read: alleen lezen van Informatieobjecten
+ BDO.Informatieobjecten.ReadWrite: lezen en schrijven van Informatieobjecten
+ BDO.Zaken.Read: alleen lezen van Zaken
+ BDO.Zaken.ReadWrite: lezen en schrijven van Zaken
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BDO.All.Read: alleen lezen van alle resources
BDO.All.ReadWrite: lezen en schrijven van alle resources
@@ -1122,31 +1134,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
Dossier-sleutels:
type: object
properties:
@@ -1274,8 +1263,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Proces-sleutels:
type: object
properties:
@@ -1463,7 +1452,58 @@ components:
description: De contactpersonen behorend bij de rechtspersoon.
type: array
items:
- $ref: '#/components/schemas/Dossiers-Relatie'
+ $ref: '#/components/schemas/Relatie-sleutels'
+ Relatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ Relatierol-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Dossiers-Relatie-basis:
type: object
properties:
@@ -1987,57 +2027,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Relatie-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
- rollen:
- description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
- type: array
- items:
- $ref: '#/components/schemas/Relatierol-sleutels'
- Relatierol-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Informatieobjecten-Relatie:
type: object
properties:
diff --git a/Ketenprocessen/BFG.yaml b/Ketenprocessen/BFG.yaml
index 540df2d..202bbf3 100644
--- a/Ketenprocessen/BFG.yaml
+++ b/Ketenprocessen/BFG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Financiele Gegevens
- description: API-specificatie van ketenproces 'Beheer Financiele Gegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Financiele Gegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bfg.vera.io:{port}/{basePath}
description: Productieserver
@@ -29,7 +29,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -45,7 +45,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Ophalen van Boekingen
+ summary: Ophalen van Boekingen
operationId: listBoekingen
parameters:
- name: params
@@ -95,7 +95,7 @@ paths:
post:
tags:
- 'Boekingen'
- description: Voegt een nieuw(e) Boeking toe.
+ summary: Voegt een nieuw(e) Boeking toe.
operationId: createBoeking
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -135,7 +135,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: |
+ summary: |
Vervangen van een Boeking op basis van overeenkomstige sleutelvelden.
operationId: replaceBoeking
parameters:
@@ -170,7 +170,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boeking. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoeking
@@ -207,7 +207,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Retourneert een Boeking met de gegeven identifier
+ summary: Retourneert een Boeking met de gegeven identifier
operationId: readBoekingById
parameters:
- name: id
@@ -244,7 +244,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: Vervangen van een Boeking
+ summary: Vervangen van een Boeking
operationId: replaceBoekingById
parameters:
- name: 'id'
@@ -282,7 +282,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: Wijzigen van een Boeking
+ summary: Wijzigen van een Boeking
operationId: updateBoekingById
parameters:
- name: 'id'
@@ -321,7 +321,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Ophalen van Debiteuren
+ summary: Ophalen van Debiteuren
operationId: listDebiteuren
parameters:
- name: params
@@ -371,7 +371,7 @@ paths:
post:
tags:
- 'Debiteuren'
- description: Voegt een nieuw(e) Debiteur toe.
+ summary: Voegt een nieuw(e) Debiteur toe.
operationId: createDebiteur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -411,7 +411,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Vervangen van een Debiteur op basis van overeenkomstige sleutelvelden.
operationId: replaceDebiteur
parameters:
@@ -446,7 +446,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Debiteur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDebiteur
@@ -483,7 +483,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Retourneert een Debiteur met de gegeven identifier
+ summary: Retourneert een Debiteur met de gegeven identifier
operationId: readDebiteurById
parameters:
- name: id
@@ -520,7 +520,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: Vervangen van een Debiteur
+ summary: Vervangen van een Debiteur
operationId: replaceDebiteurById
parameters:
- name: 'id'
@@ -558,7 +558,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: Wijzigen van een Debiteur
+ summary: Wijzigen van een Debiteur
operationId: updateDebiteurById
parameters:
- name: 'id'
@@ -630,10 +630,20 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BFG.All.Read: alleen lezen van alle resources
+ BFG.All.ReadWrite: lezen en schrijven van alle resources
+ BFG.Boekingen.Read: alleen lezen van Boekingen
+ BFG.Boekingen.ReadWrite: lezen en schrijven van Boekingen
+ BFG.Debiteuren.Read: alleen lezen van Debiteuren
+ BFG.Debiteuren.ReadWrite: lezen en schrijven van Debiteuren
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BFG.All.Read: alleen lezen van alle resources
BFG.All.ReadWrite: lezen en schrijven van alle resources
@@ -771,40 +781,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -1032,8 +1019,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Boekingen-Boekingdetail:
type: object
properties:
diff --git a/Ketenprocessen/BOG.yaml b/Ketenprocessen/BOG.yaml
index df96736..408baec 100644
--- a/Ketenprocessen/BOG.yaml
+++ b/Ketenprocessen/BOG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Overeenkomstgegevens
- description: API-specificatie van ketenproces 'Beheer Overeenkomstgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Overeenkomstgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bog.vera.io:{port}/{basePath}
description: Productieserver
@@ -29,7 +29,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -45,7 +45,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Ophalen van Overeenkomsten
+ summary: Ophalen van Overeenkomsten
operationId: listOvereenkomsten
parameters:
- name: params
@@ -95,7 +95,7 @@ paths:
post:
tags:
- 'Overeenkomsten'
- description: Voegt een nieuw(e) Overeenkomst toe.
+ summary: Voegt een nieuw(e) Overeenkomst toe.
operationId: createOvereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -135,7 +135,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Vervangen van een Overeenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomst
parameters:
@@ -170,7 +170,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomst
@@ -207,7 +207,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Retourneert een Overeenkomst met de gegeven identifier
+ summary: Retourneert een Overeenkomst met de gegeven identifier
operationId: readOvereenkomstById
parameters:
- name: id
@@ -244,7 +244,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: Vervangen van een Overeenkomst
+ summary: Vervangen van een Overeenkomst
operationId: replaceOvereenkomstById
parameters:
- name: 'id'
@@ -282,7 +282,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: Wijzigen van een Overeenkomst
+ summary: Wijzigen van een Overeenkomst
operationId: updateOvereenkomstById
parameters:
- name: 'id'
@@ -321,7 +321,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Ophalen van Prijscomponenten
+ summary: Ophalen van Prijscomponenten
operationId: listPrijscomponenten
parameters:
- name: params
@@ -371,7 +371,7 @@ paths:
post:
tags:
- 'Prijscomponenten'
- description: Voegt een nieuw(e) Prijscomponent toe.
+ summary: Voegt een nieuw(e) Prijscomponent toe.
operationId: createPrijscomponent
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -411,7 +411,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Vervangen van een Prijscomponent op basis van overeenkomstige sleutelvelden.
operationId: replacePrijscomponent
parameters:
@@ -446,7 +446,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Prijscomponent. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePrijscomponent
@@ -483,7 +483,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Retourneert een Prijscomponent met de gegeven identifier
+ summary: Retourneert een Prijscomponent met de gegeven identifier
operationId: readPrijscomponentById
parameters:
- name: id
@@ -520,7 +520,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: Vervangen van een Prijscomponent
+ summary: Vervangen van een Prijscomponent
operationId: replacePrijscomponentById
parameters:
- name: 'id'
@@ -558,7 +558,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: Wijzigen van een Prijscomponent
+ summary: Wijzigen van een Prijscomponent
operationId: updatePrijscomponentById
parameters:
- name: 'id'
@@ -630,10 +630,20 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BOG.All.Read: alleen lezen van alle resources
+ BOG.All.ReadWrite: lezen en schrijven van alle resources
+ BOG.Overeenkomsten.Read: alleen lezen van Overeenkomsten
+ BOG.Overeenkomsten.ReadWrite: lezen en schrijven van Overeenkomsten
+ BOG.Prijscomponenten.Read: alleen lezen van Prijscomponenten
+ BOG.Prijscomponenten.ReadWrite: lezen en schrijven van Prijscomponenten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BOG.All.Read: alleen lezen van alle resources
BOG.All.ReadWrite: lezen en schrijven van alle resources
@@ -767,40 +777,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -1329,8 +1316,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Contactmoment-sleutels:
type: object
properties:
@@ -1352,8 +1339,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
Eenheid-sleutels:
type: object
properties:
diff --git a/Ketenprocessen/BRG.yaml b/Ketenprocessen/BRG.yaml
index 2e98a02..f1b90d2 100644
--- a/Ketenprocessen/BRG.yaml
+++ b/Ketenprocessen/BRG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Relatiegegevens
- description: API-specificatie van ketenproces 'Beheer Relatiegegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Relatiegegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://brg.vera.io:{port}/{basePath}
description: Productieserver
@@ -33,7 +33,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -49,7 +49,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Ophalen van Betaalgegevens
+ summary: Ophalen van Betaalgegevens
operationId: listBetaalgegevens
parameters:
- name: params
@@ -99,7 +99,7 @@ paths:
post:
tags:
- 'Betaalgegevens'
- description: Voegt een nieuw(e) Betaalgegeven toe.
+ summary: Voegt een nieuw(e) Betaalgegeven toe.
operationId: createBetaalgegeven
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -139,7 +139,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Vervangen van een Betaalgegeven op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalgegeven
parameters:
@@ -174,7 +174,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalgegeven. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalgegeven
@@ -211,7 +211,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Retourneert een Betaalgegeven met de gegeven identifier
+ summary: Retourneert een Betaalgegeven met de gegeven identifier
operationId: readBetaalgegevenById
parameters:
- name: id
@@ -248,7 +248,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: Vervangen van een Betaalgegeven
+ summary: Vervangen van een Betaalgegeven
operationId: replaceBetaalgegevenById
parameters:
- name: 'id'
@@ -286,7 +286,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: Wijzigen van een Betaalgegeven
+ summary: Wijzigen van een Betaalgegeven
operationId: updateBetaalgegevenById
parameters:
- name: 'id'
@@ -325,7 +325,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Ophalen van Contactmomenten
+ summary: Ophalen van Contactmomenten
operationId: listContactmomenten
parameters:
- name: params
@@ -375,7 +375,7 @@ paths:
post:
tags:
- 'Contactmomenten'
- description: Voegt een nieuw(e) Contactmoment toe.
+ summary: Voegt een nieuw(e) Contactmoment toe.
operationId: createContactmoment
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -415,7 +415,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Vervangen van een Contactmoment op basis van overeenkomstige sleutelvelden.
operationId: replaceContactmoment
parameters:
@@ -450,7 +450,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Contactmoment. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateContactmoment
@@ -487,7 +487,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Retourneert een Contactmoment met de gegeven identifier
+ summary: Retourneert een Contactmoment met de gegeven identifier
operationId: readContactmomentById
parameters:
- name: id
@@ -524,7 +524,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: Vervangen van een Contactmoment
+ summary: Vervangen van een Contactmoment
operationId: replaceContactmomentById
parameters:
- name: 'id'
@@ -562,7 +562,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: Wijzigen van een Contactmoment
+ summary: Wijzigen van een Contactmoment
operationId: updateContactmomentById
parameters:
- name: 'id'
@@ -601,7 +601,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Ophalen van Relaties
+ summary: Ophalen van Relaties
operationId: listRelaties
parameters:
- name: params
@@ -651,7 +651,7 @@ paths:
post:
tags:
- 'Relaties'
- description: Voegt een nieuw(e) Relatie toe.
+ summary: Voegt een nieuw(e) Relatie toe.
operationId: createRelatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -691,7 +691,7 @@ paths:
put:
tags:
- 'Relaties'
- description: |
+ summary: |
Vervangen van een Relatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatie
parameters:
@@ -726,7 +726,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatie
@@ -763,7 +763,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Retourneert een Relatie met de gegeven identifier
+ summary: Retourneert een Relatie met de gegeven identifier
operationId: readRelatieById
parameters:
- name: id
@@ -800,7 +800,7 @@ paths:
put:
tags:
- 'Relaties'
- description: Vervangen van een Relatie
+ summary: Vervangen van een Relatie
operationId: replaceRelatieById
parameters:
- name: 'id'
@@ -838,7 +838,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: Wijzigen van een Relatie
+ summary: Wijzigen van een Relatie
operationId: updateRelatieById
parameters:
- name: 'id'
@@ -877,7 +877,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Ophalen van Signaleringen
+ summary: Ophalen van Signaleringen
operationId: listSignaleringen
parameters:
- name: params
@@ -927,7 +927,7 @@ paths:
post:
tags:
- 'Signaleringen'
- description: Voegt een nieuw(e) Signalering toe.
+ summary: Voegt een nieuw(e) Signalering toe.
operationId: createSignalering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -967,7 +967,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Vervangen van een Signalering op basis van overeenkomstige sleutelvelden.
operationId: replaceSignalering
parameters:
@@ -1002,7 +1002,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Signalering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSignalering
@@ -1039,7 +1039,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Retourneert een Signalering met de gegeven identifier
+ summary: Retourneert een Signalering met de gegeven identifier
operationId: readSignaleringById
parameters:
- name: id
@@ -1076,7 +1076,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: Vervangen van een Signalering
+ summary: Vervangen van een Signalering
operationId: replaceSignaleringById
parameters:
- name: 'id'
@@ -1114,7 +1114,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: Wijzigen van een Signalering
+ summary: Wijzigen van een Signalering
operationId: updateSignaleringById
parameters:
- name: 'id'
@@ -1186,10 +1186,24 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BRG.All.Read: alleen lezen van alle resources
+ BRG.All.ReadWrite: lezen en schrijven van alle resources
+ BRG.Betaalgegevens.Read: alleen lezen van Betaalgegevens
+ BRG.Betaalgegevens.ReadWrite: lezen en schrijven van Betaalgegevens
+ BRG.Contactmomenten.Read: alleen lezen van Contactmomenten
+ BRG.Contactmomenten.ReadWrite: lezen en schrijven van Contactmomenten
+ BRG.Relaties.Read: alleen lezen van Relaties
+ BRG.Relaties.ReadWrite: lezen en schrijven van Relaties
+ BRG.Signaleringen.Read: alleen lezen van Signaleringen
+ BRG.Signaleringen.ReadWrite: lezen en schrijven van Signaleringen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BRG.All.Read: alleen lezen van alle resources
BRG.All.ReadWrite: lezen en schrijven van alle resources
@@ -1328,10 +1342,6 @@ components:
type: string
format: any
description: Het nummer van de machtiging
- rekening:
- allOf:
- - $ref: '#/components/schemas/Betaalgegevens-Betaalgegeven'
- description: De BIC kode van de bank van de debiteur
Betaalgegevens-Overeenkomst:
type: object
properties:
@@ -1395,31 +1405,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Betaalwijze-sleutels:
type: object
properties:
@@ -2465,12 +2452,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
diff --git a/Ketenprocessen/BVG.yaml b/Ketenprocessen/BVG.yaml
index bdb1a11..d248dfa 100644
--- a/Ketenprocessen/BVG.yaml
+++ b/Ketenprocessen/BVG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Vastgoedgegevens
- description: API-specificatie van ketenproces 'Beheer Vastgoedgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Vastgoedgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bvg.vera.io:{port}/{basePath}
description: Productieserver
@@ -27,7 +27,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -43,7 +43,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Ophalen van WoningwaarderingResultaten
+ summary: Ophalen van WoningwaarderingResultaten
operationId: listWoningwaarderingResultaten
parameters:
- name: params
@@ -93,7 +93,7 @@ paths:
post:
tags:
- 'WoningwaarderingResultaten'
- description: Voegt een nieuw(e) WoningwaarderingResultaat toe.
+ summary: Voegt een nieuw(e) WoningwaarderingResultaat toe.
operationId: createWoningwaarderingResultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -133,7 +133,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Vervangen van een WoningwaarderingResultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingResultaat
parameters:
@@ -168,7 +168,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingResultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingResultaat
@@ -205,7 +205,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Retourneert een WoningwaarderingResultaat met de gegeven identifier
+ summary: Retourneert een WoningwaarderingResultaat met de gegeven identifier
operationId: readWoningwaarderingResultaatById
parameters:
- name: id
@@ -242,7 +242,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: Vervangen van een WoningwaarderingResultaat
+ summary: Vervangen van een WoningwaarderingResultaat
operationId: replaceWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -280,7 +280,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: Wijzigen van een WoningwaarderingResultaat
+ summary: Wijzigen van een WoningwaarderingResultaat
operationId: updateWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -352,10 +352,18 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BVG.All.Read: alleen lezen van alle resources
+ BVG.All.ReadWrite: lezen en schrijven van alle resources
+ BVG.WoningwaarderingResultaten.Read: alleen lezen van WoningwaarderingResultaten
+ BVG.WoningwaarderingResultaten.ReadWrite: lezen en schrijven van WoningwaarderingResultaten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BVG.All.Read: alleen lezen van alle resources
BVG.All.ReadWrite: lezen en schrijven van alle resources
@@ -817,40 +825,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
diff --git a/Ketenprocessen/INC.yaml b/Ketenprocessen/INC.yaml
index d8fdeee..74e1056 100644
--- a/Ketenprocessen/INC.yaml
+++ b/Ketenprocessen/INC.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Incasso
- description: API-specificatie van ketenproces 'Incasso'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Incasso'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://inc.vera.io:{port}/{basePath}
description: Productieserver
@@ -29,7 +29,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -45,7 +45,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Ophalen van Betalingsregelingen
+ summary: Ophalen van Betalingsregelingen
operationId: listBetalingsregelingen
parameters:
- name: params
@@ -95,7 +95,7 @@ paths:
post:
tags:
- 'Betalingsregelingen'
- description: Voegt een nieuw(e) Betalingsregeling toe.
+ summary: Voegt een nieuw(e) Betalingsregeling toe.
operationId: createBetalingsregeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -135,7 +135,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Vervangen van een Betalingsregeling op basis van overeenkomstige sleutelvelden.
operationId: replaceBetalingsregeling
parameters:
@@ -170,7 +170,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betalingsregeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetalingsregeling
@@ -207,7 +207,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Retourneert een Betalingsregeling met de gegeven identifier
+ summary: Retourneert een Betalingsregeling met de gegeven identifier
operationId: readBetalingsregelingById
parameters:
- name: id
@@ -244,7 +244,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: Vervangen van een Betalingsregeling
+ summary: Vervangen van een Betalingsregeling
operationId: replaceBetalingsregelingById
parameters:
- name: 'id'
@@ -282,7 +282,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: Wijzigen van een Betalingsregeling
+ summary: Wijzigen van een Betalingsregeling
operationId: updateBetalingsregelingById
parameters:
- name: 'id'
@@ -321,7 +321,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Ophalen van ExterneIncassos
+ summary: Ophalen van ExterneIncassos
operationId: listExterneIncassos
parameters:
- name: params
@@ -371,7 +371,7 @@ paths:
post:
tags:
- 'ExterneIncassos'
- description: Voegt een nieuw(e) ExterneIncasso toe.
+ summary: Voegt een nieuw(e) ExterneIncasso toe.
operationId: createExterneIncasso
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -411,7 +411,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Vervangen van een ExterneIncasso op basis van overeenkomstige sleutelvelden.
operationId: replaceExterneIncasso
parameters:
@@ -446,7 +446,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExterneIncasso. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExterneIncasso
@@ -483,7 +483,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Retourneert een ExterneIncasso met de gegeven identifier
+ summary: Retourneert een ExterneIncasso met de gegeven identifier
operationId: readExterneIncassoById
parameters:
- name: id
@@ -520,7 +520,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: Vervangen van een ExterneIncasso
+ summary: Vervangen van een ExterneIncasso
operationId: replaceExterneIncassoById
parameters:
- name: 'id'
@@ -558,7 +558,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: Wijzigen van een ExterneIncasso
+ summary: Wijzigen van een ExterneIncasso
operationId: updateExterneIncassoById
parameters:
- name: 'id'
@@ -630,10 +630,20 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ INC.All.Read: alleen lezen van alle resources
+ INC.All.ReadWrite: lezen en schrijven van alle resources
+ INC.Betalingsregelingen.Read: alleen lezen van Betalingsregelingen
+ INC.Betalingsregelingen.ReadWrite: lezen en schrijven van Betalingsregelingen
+ INC.ExterneIncassos.Read: alleen lezen van ExterneIncassos
+ INC.ExterneIncassos.ReadWrite: lezen en schrijven van ExterneIncassos
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
INC.All.Read: alleen lezen van alle resources
INC.All.ReadWrite: lezen en schrijven van alle resources
@@ -767,40 +777,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -857,31 +844,12 @@ components:
description: Het betaalgegeven waarmee de betalingsregeling wordt betaald. Dit kan bijvoorbeeld het rekeningnummer zijn van de relatie.
incassomachtiging:
allOf:
- - $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ - $ref: '#/components/schemas/Betalingsregelingen-Incassomachtiging'
description: De digitale machtiging voor het uitvoeren van de incassoopdrachten. SEPA.
incassomoment:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het moment waarop de incasso wordt gedaan. Referentiedatasoort INCASSOMOMENT.
- Incassomachtiging-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
Betalingsregelingen-Betalingsregelingbericht:
allOf:
- $ref: '#/components/schemas/Betalingsregelingen-Betalingsregeling'
@@ -1018,8 +986,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Betalingsregelingen-BetalingsregelingTermijn:
type: object
properties:
diff --git a/Ketenprocessen/KMT.yaml b/Ketenprocessen/KMT.yaml
index ac9720d..4b137f0 100644
--- a/Ketenprocessen/KMT.yaml
+++ b/Ketenprocessen/KMT.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Kwaliteitsmeting
- description: API-specificatie van ketenproces 'Kwaliteitsmeting'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Kwaliteitsmeting'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://kmt.vera.io:{port}/{basePath}
description: Productieserver
@@ -33,7 +33,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -49,7 +49,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Ophalen van Kwaliteitsmetingsresultaten
+ summary: Ophalen van Kwaliteitsmetingsresultaten
operationId: listKwaliteitsmetingsresultaten
parameters:
- name: params
@@ -99,7 +99,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
operationId: createKwaliteitsmetingsresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -139,7 +139,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsresultaat
parameters:
@@ -174,7 +174,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsresultaat
@@ -211,7 +211,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
operationId: readKwaliteitsmetingsresultaatById
parameters:
- name: id
@@ -248,7 +248,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Vervangen van een Kwaliteitsmetingsresultaat
+ summary: Vervangen van een Kwaliteitsmetingsresultaat
operationId: replaceKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -286,7 +286,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Wijzigen van een Kwaliteitsmetingsresultaat
+ summary: Wijzigen van een Kwaliteitsmetingsresultaat
operationId: updateKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -325,7 +325,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Ophalen van Kwaliteitsmetingsverzoeken
+ summary: Ophalen van Kwaliteitsmetingsverzoeken
operationId: listKwaliteitsmetingsverzoeken
parameters:
- name: params
@@ -375,7 +375,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
operationId: createKwaliteitsmetingsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -415,7 +415,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsverzoek
parameters:
@@ -450,7 +450,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsverzoek
@@ -487,7 +487,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
operationId: readKwaliteitsmetingsverzoekById
parameters:
- name: id
@@ -524,7 +524,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Vervangen van een Kwaliteitsmetingsverzoek
+ summary: Vervangen van een Kwaliteitsmetingsverzoek
operationId: replaceKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -562,7 +562,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Wijzigen van een Kwaliteitsmetingsverzoek
+ summary: Wijzigen van een Kwaliteitsmetingsverzoek
operationId: updateKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -601,7 +601,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Ophalen van Onderzoeksopdrachten
+ summary: Ophalen van Onderzoeksopdrachten
operationId: listOnderzoeksopdrachten
parameters:
- name: params
@@ -651,7 +651,7 @@ paths:
post:
tags:
- 'Onderzoeksopdrachten'
- description: Voegt een nieuw(e) Onderzoeksopdracht toe.
+ summary: Voegt een nieuw(e) Onderzoeksopdracht toe.
operationId: createOnderzoeksopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -691,7 +691,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Vervangen van een Onderzoeksopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksopdracht
parameters:
@@ -726,7 +726,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksopdracht
@@ -763,7 +763,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Retourneert een Onderzoeksopdracht met de gegeven identifier
+ summary: Retourneert een Onderzoeksopdracht met de gegeven identifier
operationId: readOnderzoeksopdrachtById
parameters:
- name: id
@@ -800,7 +800,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: Vervangen van een Onderzoeksopdracht
+ summary: Vervangen van een Onderzoeksopdracht
operationId: replaceOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -838,7 +838,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: Wijzigen van een Onderzoeksopdracht
+ summary: Wijzigen van een Onderzoeksopdracht
operationId: updateOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -877,7 +877,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Ophalen van Onderzoeksresultaten
+ summary: Ophalen van Onderzoeksresultaten
operationId: listOnderzoeksresultaten
parameters:
- name: params
@@ -927,7 +927,7 @@ paths:
post:
tags:
- 'Onderzoeksresultaten'
- description: Voegt een nieuw(e) Onderzoeksresultaat toe.
+ summary: Voegt een nieuw(e) Onderzoeksresultaat toe.
operationId: createOnderzoeksresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -967,7 +967,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Vervangen van een Onderzoeksresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksresultaat
parameters:
@@ -1002,7 +1002,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksresultaat
@@ -1039,7 +1039,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Retourneert een Onderzoeksresultaat met de gegeven identifier
+ summary: Retourneert een Onderzoeksresultaat met de gegeven identifier
operationId: readOnderzoeksresultaatById
parameters:
- name: id
@@ -1076,7 +1076,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: Vervangen van een Onderzoeksresultaat
+ summary: Vervangen van een Onderzoeksresultaat
operationId: replaceOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1114,7 +1114,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: Wijzigen van een Onderzoeksresultaat
+ summary: Wijzigen van een Onderzoeksresultaat
operationId: updateOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1186,10 +1186,24 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ KMT.All.Read: alleen lezen van alle resources
+ KMT.All.ReadWrite: lezen en schrijven van alle resources
+ KMT.Kwaliteitsmetingsresultaten.Read: alleen lezen van Kwaliteitsmetingsresultaten
+ KMT.Kwaliteitsmetingsresultaten.ReadWrite: lezen en schrijven van Kwaliteitsmetingsresultaten
+ KMT.Kwaliteitsmetingsverzoeken.Read: alleen lezen van Kwaliteitsmetingsverzoeken
+ KMT.Kwaliteitsmetingsverzoeken.ReadWrite: lezen en schrijven van Kwaliteitsmetingsverzoeken
+ KMT.Onderzoeksopdrachten.Read: alleen lezen van Onderzoeksopdrachten
+ KMT.Onderzoeksopdrachten.ReadWrite: lezen en schrijven van Onderzoeksopdrachten
+ KMT.Onderzoeksresultaten.Read: alleen lezen van Onderzoeksresultaten
+ KMT.Onderzoeksresultaten.ReadWrite: lezen en schrijven van Onderzoeksresultaten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
KMT.All.Read: alleen lezen van alle resources
KMT.All.ReadWrite: lezen en schrijven van alle resources
@@ -1445,40 +1459,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -1831,8 +1822,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Kwaliteitsmetingsverzoeken-Overeenkomst:
oneOf:
- $ref: '#/components/schemas/Kwaliteitsmetingsverzoeken-Huurovereenkomst'
diff --git a/Ketenprocessen/OHD.yaml b/Ketenprocessen/OHD.yaml
index a112e9a..625601c 100644
--- a/Ketenprocessen/OHD.yaml
+++ b/Ketenprocessen/OHD.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Onderhoud
- description: API-specificatie van ketenproces 'Onderhoud'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Onderhoud'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '2.1.0+230422.8'
+ version: '2.1.1+230512.44'
servers:
- url: https://ohd.vera.io:{port}/{basePath}
description: Productieserver
@@ -43,7 +43,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -59,7 +59,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Ophalen van AfspraakOpties
+ summary: Ophalen van AfspraakOpties
operationId: listAfspraakOpties
parameters:
- name: params
@@ -109,7 +109,7 @@ paths:
post:
tags:
- 'AfspraakOpties'
- description: Voegt een nieuw(e) AfspraakOptie toe.
+ summary: Voegt een nieuw(e) AfspraakOptie toe.
operationId: createAfspraakOptie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -149,7 +149,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Vervangen van een AfspraakOptie op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraakOptie
parameters:
@@ -184,7 +184,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een AfspraakOptie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraakOptie
@@ -221,7 +221,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Retourneert een AfspraakOptie met de gegeven identifier
+ summary: Retourneert een AfspraakOptie met de gegeven identifier
operationId: readAfspraakOptieById
parameters:
- name: id
@@ -258,7 +258,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: Vervangen van een AfspraakOptie
+ summary: Vervangen van een AfspraakOptie
operationId: replaceAfspraakOptieById
parameters:
- name: 'id'
@@ -296,7 +296,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: Wijzigen van een AfspraakOptie
+ summary: Wijzigen van een AfspraakOptie
operationId: updateAfspraakOptieById
parameters:
- name: 'id'
@@ -335,7 +335,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Ophalen van Afspraken
+ summary: Ophalen van Afspraken
operationId: listAfspraken
parameters:
- name: params
@@ -385,7 +385,7 @@ paths:
post:
tags:
- 'Afspraken'
- description: Voegt een nieuw(e) Afspraak toe.
+ summary: Voegt een nieuw(e) Afspraak toe.
operationId: createAfspraak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -425,7 +425,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: |
+ summary: |
Vervangen van een Afspraak op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraak
parameters:
@@ -460,7 +460,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Afspraak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraak
@@ -497,7 +497,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Retourneert een Afspraak met de gegeven identifier
+ summary: Retourneert een Afspraak met de gegeven identifier
operationId: readAfspraakById
parameters:
- name: id
@@ -534,7 +534,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: Vervangen van een Afspraak
+ summary: Vervangen van een Afspraak
operationId: replaceAfspraakById
parameters:
- name: 'id'
@@ -572,7 +572,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: Wijzigen van een Afspraak
+ summary: Wijzigen van een Afspraak
operationId: updateAfspraakById
parameters:
- name: 'id'
@@ -611,7 +611,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Ophalen van BouwkundigElementen
+ summary: Ophalen van BouwkundigElementen
operationId: listBouwkundigElementen
parameters:
- name: params
@@ -661,7 +661,7 @@ paths:
post:
tags:
- 'BouwkundigElementen'
- description: Voegt een nieuw(e) BouwkundigElement toe.
+ summary: Voegt een nieuw(e) BouwkundigElement toe.
operationId: createBouwkundigElement
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -701,7 +701,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Vervangen van een BouwkundigElement op basis van overeenkomstige sleutelvelden.
operationId: replaceBouwkundigElement
parameters:
@@ -736,7 +736,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BouwkundigElement. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBouwkundigElement
@@ -773,7 +773,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Retourneert een BouwkundigElement met de gegeven identifier
+ summary: Retourneert een BouwkundigElement met de gegeven identifier
operationId: readBouwkundigElementById
parameters:
- name: id
@@ -810,7 +810,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: Vervangen van een BouwkundigElement
+ summary: Vervangen van een BouwkundigElement
operationId: replaceBouwkundigElementById
parameters:
- name: 'id'
@@ -848,7 +848,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: Wijzigen van een BouwkundigElement
+ summary: Wijzigen van een BouwkundigElement
operationId: updateBouwkundigElementById
parameters:
- name: 'id'
@@ -887,7 +887,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Ophalen van CollectiefObjecten
+ summary: Ophalen van CollectiefObjecten
operationId: listCollectiefObjecten
parameters:
- name: params
@@ -937,7 +937,7 @@ paths:
post:
tags:
- 'CollectiefObjecten'
- description: Voegt een nieuw(e) CollectiefObject toe.
+ summary: Voegt een nieuw(e) CollectiefObject toe.
operationId: createCollectiefObject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -977,7 +977,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Vervangen van een CollectiefObject op basis van overeenkomstige sleutelvelden.
operationId: replaceCollectiefObject
parameters:
@@ -1012,7 +1012,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een CollectiefObject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCollectiefObject
@@ -1049,7 +1049,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Retourneert een CollectiefObject met de gegeven identifier
+ summary: Retourneert een CollectiefObject met de gegeven identifier
operationId: readCollectiefObjectById
parameters:
- name: id
@@ -1086,7 +1086,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: Vervangen van een CollectiefObject
+ summary: Vervangen van een CollectiefObject
operationId: replaceCollectiefObjectById
parameters:
- name: 'id'
@@ -1124,7 +1124,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: Wijzigen van een CollectiefObject
+ summary: Wijzigen van een CollectiefObject
operationId: updateCollectiefObjectById
parameters:
- name: 'id'
@@ -1163,7 +1163,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Ophalen van Inkoopfacturen
+ summary: Ophalen van Inkoopfacturen
operationId: listInkoopfacturen
parameters:
- name: params
@@ -1213,7 +1213,7 @@ paths:
post:
tags:
- 'Inkoopfacturen'
- description: Voegt een nieuw(e) Inkoopfactuur toe.
+ summary: Voegt een nieuw(e) Inkoopfactuur toe.
operationId: createInkoopfactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1253,7 +1253,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Vervangen van een Inkoopfactuur op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopfactuur
parameters:
@@ -1288,7 +1288,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkoopfactuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopfactuur
@@ -1325,7 +1325,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Retourneert een Inkoopfactuur met de gegeven identifier
+ summary: Retourneert een Inkoopfactuur met de gegeven identifier
operationId: readInkoopfactuurById
parameters:
- name: id
@@ -1362,7 +1362,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: Vervangen van een Inkoopfactuur
+ summary: Vervangen van een Inkoopfactuur
operationId: replaceInkoopfactuurById
parameters:
- name: 'id'
@@ -1400,7 +1400,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: Wijzigen van een Inkoopfactuur
+ summary: Wijzigen van een Inkoopfactuur
operationId: updateInkoopfactuurById
parameters:
- name: 'id'
@@ -1439,7 +1439,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Ophalen van Inspectierapporten
+ summary: Ophalen van Inspectierapporten
operationId: listInspectierapporten
parameters:
- name: params
@@ -1489,7 +1489,7 @@ paths:
post:
tags:
- 'Inspectierapporten'
- description: Voegt een nieuw(e) Inspectierapport toe.
+ summary: Voegt een nieuw(e) Inspectierapport toe.
operationId: createInspectierapport
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1529,7 +1529,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Vervangen van een Inspectierapport op basis van overeenkomstige sleutelvelden.
operationId: replaceInspectierapport
parameters:
@@ -1564,7 +1564,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inspectierapport. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInspectierapport
@@ -1601,7 +1601,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Retourneert een Inspectierapport met de gegeven identifier
+ summary: Retourneert een Inspectierapport met de gegeven identifier
operationId: readInspectierapportById
parameters:
- name: id
@@ -1638,7 +1638,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: Vervangen van een Inspectierapport
+ summary: Vervangen van een Inspectierapport
operationId: replaceInspectierapportById
parameters:
- name: 'id'
@@ -1676,7 +1676,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: Wijzigen van een Inspectierapport
+ summary: Wijzigen van een Inspectierapport
operationId: updateInspectierapportById
parameters:
- name: 'id'
@@ -1715,7 +1715,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Ophalen van Offertes
+ summary: Ophalen van Offertes
operationId: listOffertes
parameters:
- name: params
@@ -1765,7 +1765,7 @@ paths:
post:
tags:
- 'Offertes'
- description: Voegt een nieuw(e) Offerte toe.
+ summary: Voegt een nieuw(e) Offerte toe.
operationId: createOfferte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1805,7 +1805,7 @@ paths:
put:
tags:
- 'Offertes'
- description: |
+ summary: |
Vervangen van een Offerte op basis van overeenkomstige sleutelvelden.
operationId: replaceOfferte
parameters:
@@ -1840,7 +1840,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Offerte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOfferte
@@ -1877,7 +1877,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Retourneert een Offerte met de gegeven identifier
+ summary: Retourneert een Offerte met de gegeven identifier
operationId: readOfferteById
parameters:
- name: id
@@ -1914,7 +1914,7 @@ paths:
put:
tags:
- 'Offertes'
- description: Vervangen van een Offerte
+ summary: Vervangen van een Offerte
operationId: replaceOfferteById
parameters:
- name: 'id'
@@ -1952,7 +1952,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: Wijzigen van een Offerte
+ summary: Wijzigen van een Offerte
operationId: updateOfferteById
parameters:
- name: 'id'
@@ -1991,7 +1991,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Ophalen van Onderhoudsorders
+ summary: Ophalen van Onderhoudsorders
operationId: listOnderhoudsorders
parameters:
- name: params
@@ -2041,7 +2041,7 @@ paths:
post:
tags:
- 'Onderhoudsorders'
- description: Voegt een nieuw(e) Onderhoudsorder toe.
+ summary: Voegt een nieuw(e) Onderhoudsorder toe.
operationId: createOnderhoudsorder
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2081,7 +2081,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Vervangen van een Onderhoudsorder op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsorder
parameters:
@@ -2116,7 +2116,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsorder. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsorder
@@ -2153,7 +2153,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Retourneert een Onderhoudsorder met de gegeven identifier
+ summary: Retourneert een Onderhoudsorder met de gegeven identifier
operationId: readOnderhoudsorderById
parameters:
- name: id
@@ -2190,7 +2190,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: Vervangen van een Onderhoudsorder
+ summary: Vervangen van een Onderhoudsorder
operationId: replaceOnderhoudsorderById
parameters:
- name: 'id'
@@ -2228,7 +2228,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: Wijzigen van een Onderhoudsorder
+ summary: Wijzigen van een Onderhoudsorder
operationId: updateOnderhoudsorderById
parameters:
- name: 'id'
@@ -2267,7 +2267,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Ophalen van Onderhoudsverzoeken
+ summary: Ophalen van Onderhoudsverzoeken
operationId: listOnderhoudsverzoeken
parameters:
- name: params
@@ -2317,7 +2317,7 @@ paths:
post:
tags:
- 'Onderhoudsverzoeken'
- description: Voegt een nieuw(e) Onderhoudsverzoek toe.
+ summary: Voegt een nieuw(e) Onderhoudsverzoek toe.
operationId: createOnderhoudsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2357,7 +2357,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Vervangen van een Onderhoudsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsverzoek
parameters:
@@ -2392,7 +2392,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsverzoek
@@ -2429,7 +2429,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Retourneert een Onderhoudsverzoek met de gegeven identifier
+ summary: Retourneert een Onderhoudsverzoek met de gegeven identifier
operationId: readOnderhoudsverzoekById
parameters:
- name: id
@@ -2466,7 +2466,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: Vervangen van een Onderhoudsverzoek
+ summary: Vervangen van een Onderhoudsverzoek
operationId: replaceOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -2504,7 +2504,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: Wijzigen van een Onderhoudsverzoek
+ summary: Wijzigen van een Onderhoudsverzoek
operationId: updateOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -2576,10 +2576,34 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ OHD.All.Read: alleen lezen van alle resources
+ OHD.All.ReadWrite: lezen en schrijven van alle resources
+ OHD.AfspraakOpties.Read: alleen lezen van AfspraakOpties
+ OHD.AfspraakOpties.ReadWrite: lezen en schrijven van AfspraakOpties
+ OHD.Afspraken.Read: alleen lezen van Afspraken
+ OHD.Afspraken.ReadWrite: lezen en schrijven van Afspraken
+ OHD.BouwkundigElementen.Read: alleen lezen van BouwkundigElementen
+ OHD.BouwkundigElementen.ReadWrite: lezen en schrijven van BouwkundigElementen
+ OHD.CollectiefObjecten.Read: alleen lezen van CollectiefObjecten
+ OHD.CollectiefObjecten.ReadWrite: lezen en schrijven van CollectiefObjecten
+ OHD.Inkoopfacturen.Read: alleen lezen van Inkoopfacturen
+ OHD.Inkoopfacturen.ReadWrite: lezen en schrijven van Inkoopfacturen
+ OHD.Inspectierapporten.Read: alleen lezen van Inspectierapporten
+ OHD.Inspectierapporten.ReadWrite: lezen en schrijven van Inspectierapporten
+ OHD.Offertes.Read: alleen lezen van Offertes
+ OHD.Offertes.ReadWrite: lezen en schrijven van Offertes
+ OHD.Onderhoudsorders.Read: alleen lezen van Onderhoudsorders
+ OHD.Onderhoudsorders.ReadWrite: lezen en schrijven van Onderhoudsorders
+ OHD.Onderhoudsverzoeken.Read: alleen lezen van Onderhoudsverzoeken
+ OHD.Onderhoudsverzoeken.ReadWrite: lezen en schrijven van Onderhoudsverzoeken
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
OHD.All.Read: alleen lezen van alle resources
OHD.All.ReadWrite: lezen en schrijven van alle resources
@@ -2710,6 +2734,10 @@ components:
type: string
format: date-time
description: De datum en tijd die het eind van een blok markeert waarbinnen de afspraak bij voorkeur start.
+ adres:
+ allOf:
+ - $ref: '#/components/schemas/AfspraakOpties-Adres'
+ description: De locatie waar de afspraak moet plaatsvindt.
afspraak:
allOf:
- $ref: '#/components/schemas/Afspraak-sleutels'
@@ -2721,7 +2749,8 @@ components:
locatie:
allOf:
- $ref: '#/components/schemas/AfspraakOpties-Adres'
- description: De locatie waar de afspraak moet plaatsvindt.
+ description: De locatie waar de afspraak moet plaatsvindt. OBSOLETE
+ deprecated: true
onderhoudsorder:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
@@ -3450,9 +3479,41 @@ components:
type: array
items:
$ref: '#/components/schemas/Afspraken-Contactgegeven'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Afspraken-Relatierol'
Afspraken-Relatie:
oneOf:
- $ref: '#/components/schemas/Afspraken-NatuurlijkPersoon'
+ Afspraken-Relatierol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort rol van de relatie. Bijvoorbeeld Klant, Prospect, Leverancier, Medewerker, Team etc. Referentiedatasoort RELATIEROLSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van de relatie rol.
Afspraken-Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Afspraken-Contactgegeven-basis'
@@ -3670,31 +3731,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
BouwkundigElementen-Garantie:
type: object
properties:
@@ -3790,12 +3828,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -3882,12 +3920,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
status:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
BouwkundigElementen-Relatie:
oneOf:
- $ref: '#/components/schemas/BouwkundigElementen-Rechtspersoon'
@@ -4304,10 +4342,11 @@ components:
format: any
description: Extern factuurnummer van de factuur.
factuurregels:
- description: De factuurregels behorende bij deze factuur.
+ description: De factuurregels behorende bij deze factuur. OBSOLETE
type: array
items:
$ref: '#/components/schemas/Inkoopfacturen-Factuurregel'
+ deprecated: true
gRekeningbedrag:
type: number
format: float
@@ -4325,6 +4364,11 @@ components:
type: number
format: float
description: Bedrag dat nog openstaat op de factuur.
+ regels:
+ description: De factuurregels behorende bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfacturen-Factuurregel'
toeslag:
allOf:
- $ref: '#/components/schemas/Inkoopfacturen-Prijsaanpassing'
@@ -4835,14 +4879,20 @@ components:
format: date
description: Datum waarop de offerte is uitgebracht
offerteregels:
- description: De offerte regels van de offerte.
+ description: De offerte regels van de offerte. OBSOLETE
type: array
items:
$ref: '#/components/schemas/Offertes-Offerteregel'
+ deprecated: true
Onderhoudsorder:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: De onderhoudsorder waarvoor de offerte is opgesteld.
+ regels:
+ description: De offerte regels van de offerte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Offertes-Offerteregel'
relaties:
description: Betrokken relaties bij de offerte. Bijv. de opdrachtgever of de opdrachtnemer.
type: array
@@ -5265,8 +5315,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'soort Geometrie: punt of omtrek'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
Onderhoudsorders-NatuurlijkPersoon:
allOf:
- $ref: '#/components/schemas/Onderhoudsorders-Relatie-basis'
diff --git a/Ketenprocessen/VHE.yaml b/Ketenprocessen/VHE.yaml
index 2dd558a..6316480 100644
--- a/Ketenprocessen/VHE.yaml
+++ b/Ketenprocessen/VHE.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Verhuren Eenheden
- description: API-specificatie van ketenproces 'Verhuren Eenheden'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Verhuren Eenheden'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://vhe.vera.io:{port}/{basePath}
description: Productieserver
@@ -31,7 +31,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -47,7 +47,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Ophalen van Clusters
+ summary: Ophalen van Clusters
operationId: listClusters
parameters:
- name: params
@@ -97,7 +97,7 @@ paths:
post:
tags:
- 'Clusters'
- description: Voegt een nieuw(e) Cluster toe.
+ summary: Voegt een nieuw(e) Cluster toe.
operationId: createCluster
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
put:
tags:
- 'Clusters'
- description: |
+ summary: |
Vervangen van een Cluster op basis van overeenkomstige sleutelvelden.
operationId: replaceCluster
parameters:
@@ -172,7 +172,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Cluster. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCluster
@@ -209,7 +209,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Retourneert een Cluster met de gegeven identifier
+ summary: Retourneert een Cluster met de gegeven identifier
operationId: readClusterById
parameters:
- name: id
@@ -246,7 +246,7 @@ paths:
put:
tags:
- 'Clusters'
- description: Vervangen van een Cluster
+ summary: Vervangen van een Cluster
operationId: replaceClusterById
parameters:
- name: 'id'
@@ -284,7 +284,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: Wijzigen van een Cluster
+ summary: Wijzigen van een Cluster
operationId: updateClusterById
parameters:
- name: 'id'
@@ -323,7 +323,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Ophalen van Eenheden
+ summary: Ophalen van Eenheden
operationId: listEenheden
parameters:
- name: params
@@ -373,7 +373,7 @@ paths:
post:
tags:
- 'Eenheden'
- description: Voegt een nieuw(e) Eenheid toe.
+ summary: Voegt een nieuw(e) Eenheid toe.
operationId: createEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: |
+ summary: |
Vervangen van een Eenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheid
parameters:
@@ -448,7 +448,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheid
@@ -485,7 +485,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Retourneert een Eenheid met de gegeven identifier
+ summary: Retourneert een Eenheid met de gegeven identifier
operationId: readEenheidById
parameters:
- name: id
@@ -522,7 +522,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: Vervangen van een Eenheid
+ summary: Vervangen van een Eenheid
operationId: replaceEenheidById
parameters:
- name: 'id'
@@ -560,7 +560,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: Wijzigen van een Eenheid
+ summary: Wijzigen van een Eenheid
operationId: updateEenheidById
parameters:
- name: 'id'
@@ -599,7 +599,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Ophalen van Huuropzeggingen
+ summary: Ophalen van Huuropzeggingen
operationId: listHuuropzeggingen
parameters:
- name: params
@@ -649,7 +649,7 @@ paths:
post:
tags:
- 'Huuropzeggingen'
- description: Voegt een nieuw(e) Huuropzegging toe.
+ summary: Voegt een nieuw(e) Huuropzegging toe.
operationId: createHuuropzegging
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Vervangen van een Huuropzegging op basis van overeenkomstige sleutelvelden.
operationId: replaceHuuropzegging
parameters:
@@ -724,7 +724,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huuropzegging. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuuropzegging
@@ -761,7 +761,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Retourneert een Huuropzegging met de gegeven identifier
+ summary: Retourneert een Huuropzegging met de gegeven identifier
operationId: readHuuropzeggingById
parameters:
- name: id
@@ -798,7 +798,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: Vervangen van een Huuropzegging
+ summary: Vervangen van een Huuropzegging
operationId: replaceHuuropzeggingById
parameters:
- name: 'id'
@@ -836,7 +836,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: Wijzigen van een Huuropzegging
+ summary: Wijzigen van een Huuropzegging
operationId: updateHuuropzeggingById
parameters:
- name: 'id'
@@ -908,10 +908,22 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ VHE.All.Read: alleen lezen van alle resources
+ VHE.All.ReadWrite: lezen en schrijven van alle resources
+ VHE.Clusters.Read: alleen lezen van Clusters
+ VHE.Clusters.ReadWrite: lezen en schrijven van Clusters
+ VHE.Eenheden.Read: alleen lezen van Eenheden
+ VHE.Eenheden.ReadWrite: lezen en schrijven van Eenheden
+ VHE.Huuropzeggingen.Read: alleen lezen van Huuropzeggingen
+ VHE.Huuropzeggingen.ReadWrite: lezen en schrijven van Huuropzeggingen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
VHE.All.Read: alleen lezen van alle resources
VHE.All.ReadWrite: lezen en schrijven van alle resources
@@ -1069,31 +1081,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Relatie-sleutels:
type: object
properties:
@@ -1115,12 +1104,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -1486,10 +1475,11 @@ components:
format: float
description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
clusters:
description: De clusters waar de eenheid onderdeel van uitmaakt.
type: array
@@ -1569,15 +1559,17 @@ components:
items:
$ref: '#/components/schemas/Referentiedata'
liggingBuitenruimten:
- description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
+ description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. OBSOLETE Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -1618,6 +1610,11 @@ components:
type: array
items:
$ref: '#/components/schemas/Eenheden-Relatie'
+ ruimten:
+ description: De verschillende ruimtes behorend bij de eenheid Bij. 'Achtertuin' of 'Woonkamer'.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheden-Ruimte'
sanitair:
description: Sanitaire voorzieningen Referentiedatasoort EENHEIDSANITAIR.
type: array
@@ -1630,7 +1627,7 @@ components:
toegankelijkheidslabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKSHEIDSLABEL.
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
totaleOppervlakte:
type: number
format: float
@@ -1643,10 +1640,11 @@ components:
type: boolean
description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
vertrekken:
- description: De ruimten behorend bij de eenheid.
+ description: De ruimten behorend bij de eenheid. OBSOLETE
type: array
items:
$ref: '#/components/schemas/Eenheden-Vertrek'
+ deprecated: true
vertrekkenAantal:
type: integer
format: int32
@@ -1655,6 +1653,10 @@ components:
type: integer
format: int32
description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
volgnummer:
type: string
format: any
@@ -2042,6 +2044,49 @@ components:
type: string
format: any
description: De naam van de relatie rol.
+ Eenheden-Ruimte:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort ruimte. Ruimtes worden verdeeld in vertrekken die meetellen voor de woningwaardering, buitenruimtes en overige ruimtes. Referentiedatasoort RUIMTESOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het detailsoort van de ruimte. Bijv. Slaapkamer, Dakteras, Tuin etc. Referentiedatasoort RUIMTEDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De omschrijving van de ruimte.
+ inhoud:
+ type: number
+ format: float
+ description: De inhoud van de ruimte in m3.
+ ligging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
+ oppervlakte:
+ type: number
+ format: float
+ description: De oppervlakte van de ruimte
Eenheden-Stadsdeel:
type: object
properties:
diff --git a/Ketenprocessen/WRV.yaml b/Ketenprocessen/WRV.yaml
index 6fb2b41..ce06189 100644
--- a/Ketenprocessen/WRV.yaml
+++ b/Ketenprocessen/WRV.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Woonruimteverdeling
- description: API-specificatie van ketenproces 'Woonruimteverdeling'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Woonruimteverdeling'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '3.1.0+230422.8'
+ version: '3.1.1+230512.44'
servers:
- url: https://wrv.vera.io:{port}/{basePath}
description: Productieserver
@@ -51,7 +51,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -67,7 +67,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Ophalen van Aanbiedingen
+ summary: Ophalen van Aanbiedingen
operationId: listAanbiedingen
parameters:
- name: params
@@ -117,7 +117,7 @@ paths:
post:
tags:
- 'Aanbiedingen'
- description: Voegt een nieuw(e) Aanbieding toe.
+ summary: Voegt een nieuw(e) Aanbieding toe.
operationId: createAanbieding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -157,7 +157,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Vervangen van een Aanbieding op basis van overeenkomstige sleutelvelden.
operationId: replaceAanbieding
parameters:
@@ -192,7 +192,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aanbieding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAanbieding
@@ -229,7 +229,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Retourneert een Aanbieding met de gegeven identifier
+ summary: Retourneert een Aanbieding met de gegeven identifier
operationId: readAanbiedingById
parameters:
- name: id
@@ -266,7 +266,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: Vervangen van een Aanbieding
+ summary: Vervangen van een Aanbieding
operationId: replaceAanbiedingById
parameters:
- name: 'id'
@@ -304,7 +304,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: Wijzigen van een Aanbieding
+ summary: Wijzigen van een Aanbieding
operationId: updateAanbiedingById
parameters:
- name: 'id'
@@ -343,7 +343,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Ophalen van Eenheden
+ summary: Ophalen van Eenheden
operationId: listEenheden
parameters:
- name: params
@@ -393,7 +393,7 @@ paths:
post:
tags:
- 'Eenheden'
- description: Voegt een nieuw(e) Eenheid toe.
+ summary: Voegt een nieuw(e) Eenheid toe.
operationId: createEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -433,7 +433,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: |
+ summary: |
Vervangen van een Eenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheid
parameters:
@@ -468,7 +468,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheid
@@ -505,7 +505,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Retourneert een Eenheid met de gegeven identifier
+ summary: Retourneert een Eenheid met de gegeven identifier
operationId: readEenheidById
parameters:
- name: id
@@ -542,7 +542,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: Vervangen van een Eenheid
+ summary: Vervangen van een Eenheid
operationId: replaceEenheidById
parameters:
- name: 'id'
@@ -580,7 +580,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: Wijzigen van een Eenheid
+ summary: Wijzigen van een Eenheid
operationId: updateEenheidById
parameters:
- name: 'id'
@@ -619,7 +619,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Ophalen van Gebeurtenissen
+ summary: Ophalen van Gebeurtenissen
operationId: listGebeurtenissen
parameters:
- name: params
@@ -669,7 +669,7 @@ paths:
post:
tags:
- 'Gebeurtenissen'
- description: Voegt een nieuw(e) Gebeurtenis toe.
+ summary: Voegt een nieuw(e) Gebeurtenis toe.
operationId: createGebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -709,7 +709,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Vervangen van een Gebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replaceGebeurtenis
parameters:
@@ -744,7 +744,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGebeurtenis
@@ -781,7 +781,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Retourneert een Gebeurtenis met de gegeven identifier
+ summary: Retourneert een Gebeurtenis met de gegeven identifier
operationId: readGebeurtenisById
parameters:
- name: id
@@ -818,7 +818,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: Vervangen van een Gebeurtenis
+ summary: Vervangen van een Gebeurtenis
operationId: replaceGebeurtenisById
parameters:
- name: 'id'
@@ -856,7 +856,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: Wijzigen van een Gebeurtenis
+ summary: Wijzigen van een Gebeurtenis
operationId: updateGebeurtenisById
parameters:
- name: 'id'
@@ -895,7 +895,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Ophalen van Kandidaten
+ summary: Ophalen van Kandidaten
operationId: listKandidaten
parameters:
- name: params
@@ -945,7 +945,7 @@ paths:
post:
tags:
- 'Kandidaten'
- description: Voegt een nieuw(e) Kandidaat toe.
+ summary: Voegt een nieuw(e) Kandidaat toe.
operationId: createKandidaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -985,7 +985,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Vervangen van een Kandidaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKandidaat
parameters:
@@ -1020,7 +1020,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kandidaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKandidaat
@@ -1057,7 +1057,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Retourneert een Kandidaat met de gegeven identifier
+ summary: Retourneert een Kandidaat met de gegeven identifier
operationId: readKandidaatById
parameters:
- name: id
@@ -1094,7 +1094,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: Vervangen van een Kandidaat
+ summary: Vervangen van een Kandidaat
operationId: replaceKandidaatById
parameters:
- name: 'id'
@@ -1132,7 +1132,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: Wijzigen van een Kandidaat
+ summary: Wijzigen van een Kandidaat
operationId: updateKandidaatById
parameters:
- name: 'id'
@@ -1171,7 +1171,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Ophalen van Overeenkomsten
+ summary: Ophalen van Overeenkomsten
operationId: listOvereenkomsten
parameters:
- name: params
@@ -1221,7 +1221,7 @@ paths:
post:
tags:
- 'Overeenkomsten'
- description: Voegt een nieuw(e) Overeenkomst toe.
+ summary: Voegt een nieuw(e) Overeenkomst toe.
operationId: createOvereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1261,7 +1261,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Vervangen van een Overeenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomst
parameters:
@@ -1296,7 +1296,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomst
@@ -1333,7 +1333,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Retourneert een Overeenkomst met de gegeven identifier
+ summary: Retourneert een Overeenkomst met de gegeven identifier
operationId: readOvereenkomstById
parameters:
- name: id
@@ -1370,7 +1370,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: Vervangen van een Overeenkomst
+ summary: Vervangen van een Overeenkomst
operationId: replaceOvereenkomstById
parameters:
- name: 'id'
@@ -1408,7 +1408,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: Wijzigen van een Overeenkomst
+ summary: Wijzigen van een Overeenkomst
operationId: updateOvereenkomstById
parameters:
- name: 'id'
@@ -1447,7 +1447,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Ophalen van Overeenkomstkoppelingen
+ summary: Ophalen van Overeenkomstkoppelingen
operationId: listOvereenkomstkoppelingen
parameters:
- name: params
@@ -1497,7 +1497,7 @@ paths:
post:
tags:
- 'Overeenkomstkoppelingen'
- description: Voegt een nieuw(e) Overeenkomstkoppeling toe.
+ summary: Voegt een nieuw(e) Overeenkomstkoppeling toe.
operationId: createOvereenkomstkoppeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1537,7 +1537,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Vervangen van een Overeenkomstkoppeling op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomstkoppeling
parameters:
@@ -1572,7 +1572,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomstkoppeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomstkoppeling
@@ -1609,7 +1609,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Retourneert een Overeenkomstkoppeling met de gegeven identifier
+ summary: Retourneert een Overeenkomstkoppeling met de gegeven identifier
operationId: readOvereenkomstkoppelingById
parameters:
- name: id
@@ -1646,7 +1646,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: Vervangen van een Overeenkomstkoppeling
+ summary: Vervangen van een Overeenkomstkoppeling
operationId: replaceOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -1684,7 +1684,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: Wijzigen van een Overeenkomstkoppeling
+ summary: Wijzigen van een Overeenkomstkoppeling
operationId: updateOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -1723,7 +1723,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Ophalen van Publicaties
+ summary: Ophalen van Publicaties
operationId: listPublicaties
parameters:
- name: params
@@ -1773,7 +1773,7 @@ paths:
post:
tags:
- 'Publicaties'
- description: Voegt een nieuw(e) Publicatie toe.
+ summary: Voegt een nieuw(e) Publicatie toe.
operationId: createPublicatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1813,7 +1813,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: |
+ summary: |
Vervangen van een Publicatie op basis van overeenkomstige sleutelvelden.
operationId: replacePublicatie
parameters:
@@ -1848,7 +1848,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Publicatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePublicatie
@@ -1885,7 +1885,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Retourneert een Publicatie met de gegeven identifier
+ summary: Retourneert een Publicatie met de gegeven identifier
operationId: readPublicatieById
parameters:
- name: id
@@ -1922,7 +1922,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: Vervangen van een Publicatie
+ summary: Vervangen van een Publicatie
operationId: replacePublicatieById
parameters:
- name: 'id'
@@ -1960,7 +1960,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: Wijzigen van een Publicatie
+ summary: Wijzigen van een Publicatie
operationId: updatePublicatieById
parameters:
- name: 'id'
@@ -1999,7 +1999,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Ophalen van Puntenberekeningen
+ summary: Ophalen van Puntenberekeningen
operationId: listPuntenberekeningen
parameters:
- name: params
@@ -2049,7 +2049,7 @@ paths:
post:
tags:
- 'Puntenberekeningen'
- description: Voegt een nieuw(e) Puntenberekening toe.
+ summary: Voegt een nieuw(e) Puntenberekening toe.
operationId: createPuntenberekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2089,7 +2089,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Vervangen van een Puntenberekening op basis van overeenkomstige sleutelvelden.
operationId: replacePuntenberekening
parameters:
@@ -2124,7 +2124,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntenberekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntenberekening
@@ -2161,7 +2161,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Retourneert een Puntenberekening met de gegeven identifier
+ summary: Retourneert een Puntenberekening met de gegeven identifier
operationId: readPuntenberekeningById
parameters:
- name: id
@@ -2198,7 +2198,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: Vervangen van een Puntenberekening
+ summary: Vervangen van een Puntenberekening
operationId: replacePuntenberekeningById
parameters:
- name: 'id'
@@ -2236,7 +2236,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: Wijzigen van een Puntenberekening
+ summary: Wijzigen van een Puntenberekening
operationId: updatePuntenberekeningById
parameters:
- name: 'id'
@@ -2275,7 +2275,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Ophalen van Puntengebeurtenissen
+ summary: Ophalen van Puntengebeurtenissen
operationId: listPuntengebeurtenissen
parameters:
- name: params
@@ -2325,7 +2325,7 @@ paths:
post:
tags:
- 'Puntengebeurtenissen'
- description: Voegt een nieuw(e) Puntengebeurtenis toe.
+ summary: Voegt een nieuw(e) Puntengebeurtenis toe.
operationId: createPuntengebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2365,7 +2365,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Vervangen van een Puntengebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replacePuntengebeurtenis
parameters:
@@ -2400,7 +2400,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntengebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntengebeurtenis
@@ -2437,7 +2437,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Retourneert een Puntengebeurtenis met de gegeven identifier
+ summary: Retourneert een Puntengebeurtenis met de gegeven identifier
operationId: readPuntengebeurtenisById
parameters:
- name: id
@@ -2474,7 +2474,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: Vervangen van een Puntengebeurtenis
+ summary: Vervangen van een Puntengebeurtenis
operationId: replacePuntengebeurtenisById
parameters:
- name: 'id'
@@ -2512,7 +2512,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: Wijzigen van een Puntengebeurtenis
+ summary: Wijzigen van een Puntengebeurtenis
operationId: updatePuntengebeurtenisById
parameters:
- name: 'id'
@@ -2551,7 +2551,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Ophalen van Reclamaties
+ summary: Ophalen van Reclamaties
operationId: listReclamaties
parameters:
- name: params
@@ -2601,7 +2601,7 @@ paths:
post:
tags:
- 'Reclamaties'
- description: Voegt een nieuw(e) Reclamatie toe.
+ summary: Voegt een nieuw(e) Reclamatie toe.
operationId: createReclamatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2641,7 +2641,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Vervangen van een Reclamatie op basis van overeenkomstige sleutelvelden.
operationId: replaceReclamatie
parameters:
@@ -2676,7 +2676,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Reclamatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReclamatie
@@ -2713,7 +2713,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Retourneert een Reclamatie met de gegeven identifier
+ summary: Retourneert een Reclamatie met de gegeven identifier
operationId: readReclamatieById
parameters:
- name: id
@@ -2750,7 +2750,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: Vervangen van een Reclamatie
+ summary: Vervangen van een Reclamatie
operationId: replaceReclamatieById
parameters:
- name: 'id'
@@ -2788,7 +2788,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: Wijzigen van een Reclamatie
+ summary: Wijzigen van een Reclamatie
operationId: updateReclamatieById
parameters:
- name: 'id'
@@ -2827,7 +2827,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Ophalen van Relaties
+ summary: Ophalen van Relaties
operationId: listRelaties
parameters:
- name: params
@@ -2877,7 +2877,7 @@ paths:
post:
tags:
- 'Relaties'
- description: Voegt een nieuw(e) Relatie toe.
+ summary: Voegt een nieuw(e) Relatie toe.
operationId: createRelatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2917,7 +2917,7 @@ paths:
put:
tags:
- 'Relaties'
- description: |
+ summary: |
Vervangen van een Relatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatie
parameters:
@@ -2952,7 +2952,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatie
@@ -2989,7 +2989,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Retourneert een Relatie met de gegeven identifier
+ summary: Retourneert een Relatie met de gegeven identifier
operationId: readRelatieById
parameters:
- name: id
@@ -3026,7 +3026,7 @@ paths:
put:
tags:
- 'Relaties'
- description: Vervangen van een Relatie
+ summary: Vervangen van een Relatie
operationId: replaceRelatieById
parameters:
- name: 'id'
@@ -3064,7 +3064,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: Wijzigen van een Relatie
+ summary: Wijzigen van een Relatie
operationId: updateRelatieById
parameters:
- name: 'id'
@@ -3103,7 +3103,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Ophalen van Sancties
+ summary: Ophalen van Sancties
operationId: listSancties
parameters:
- name: params
@@ -3153,7 +3153,7 @@ paths:
post:
tags:
- 'Sancties'
- description: Voegt een nieuw(e) Sanctie toe.
+ summary: Voegt een nieuw(e) Sanctie toe.
operationId: createSanctie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3193,7 +3193,7 @@ paths:
put:
tags:
- 'Sancties'
- description: |
+ summary: |
Vervangen van een Sanctie op basis van overeenkomstige sleutelvelden.
operationId: replaceSanctie
parameters:
@@ -3228,7 +3228,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Sanctie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSanctie
@@ -3265,7 +3265,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Retourneert een Sanctie met de gegeven identifier
+ summary: Retourneert een Sanctie met de gegeven identifier
operationId: readSanctieById
parameters:
- name: id
@@ -3302,7 +3302,7 @@ paths:
put:
tags:
- 'Sancties'
- description: Vervangen van een Sanctie
+ summary: Vervangen van een Sanctie
operationId: replaceSanctieById
parameters:
- name: 'id'
@@ -3340,7 +3340,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: Wijzigen van een Sanctie
+ summary: Wijzigen van een Sanctie
operationId: updateSanctieById
parameters:
- name: 'id'
@@ -3379,7 +3379,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Ophalen van Toewijzingen
+ summary: Ophalen van Toewijzingen
operationId: listToewijzingen
parameters:
- name: params
@@ -3429,7 +3429,7 @@ paths:
post:
tags:
- 'Toewijzingen'
- description: Voegt een nieuw(e) Toewijzing toe.
+ summary: Voegt een nieuw(e) Toewijzing toe.
operationId: createToewijzing
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3469,7 +3469,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Vervangen van een Toewijzing op basis van overeenkomstige sleutelvelden.
operationId: replaceToewijzing
parameters:
@@ -3504,7 +3504,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Toewijzing. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateToewijzing
@@ -3541,7 +3541,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Retourneert een Toewijzing met de gegeven identifier
+ summary: Retourneert een Toewijzing met de gegeven identifier
operationId: readToewijzingById
parameters:
- name: id
@@ -3578,7 +3578,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: Vervangen van een Toewijzing
+ summary: Vervangen van een Toewijzing
operationId: replaceToewijzingById
parameters:
- name: 'id'
@@ -3616,7 +3616,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: Wijzigen van een Toewijzing
+ summary: Wijzigen van een Toewijzing
operationId: updateToewijzingById
parameters:
- name: 'id'
@@ -3688,10 +3688,42 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ WRV.All.Read: alleen lezen van alle resources
+ WRV.All.ReadWrite: lezen en schrijven van alle resources
+ WRV.Aanbiedingen.Read: alleen lezen van Aanbiedingen
+ WRV.Aanbiedingen.ReadWrite: lezen en schrijven van Aanbiedingen
+ WRV.Eenheden.Read: alleen lezen van Eenheden
+ WRV.Eenheden.ReadWrite: lezen en schrijven van Eenheden
+ WRV.Gebeurtenissen.Read: alleen lezen van Gebeurtenissen
+ WRV.Gebeurtenissen.ReadWrite: lezen en schrijven van Gebeurtenissen
+ WRV.Kandidaten.Read: alleen lezen van Kandidaten
+ WRV.Kandidaten.ReadWrite: lezen en schrijven van Kandidaten
+ WRV.Overeenkomsten.Read: alleen lezen van Overeenkomsten
+ WRV.Overeenkomsten.ReadWrite: lezen en schrijven van Overeenkomsten
+ WRV.Overeenkomstkoppelingen.Read: alleen lezen van Overeenkomstkoppelingen
+ WRV.Overeenkomstkoppelingen.ReadWrite: lezen en schrijven van Overeenkomstkoppelingen
+ WRV.Publicaties.Read: alleen lezen van Publicaties
+ WRV.Publicaties.ReadWrite: lezen en schrijven van Publicaties
+ WRV.Puntenberekeningen.Read: alleen lezen van Puntenberekeningen
+ WRV.Puntenberekeningen.ReadWrite: lezen en schrijven van Puntenberekeningen
+ WRV.Puntengebeurtenissen.Read: alleen lezen van Puntengebeurtenissen
+ WRV.Puntengebeurtenissen.ReadWrite: lezen en schrijven van Puntengebeurtenissen
+ WRV.Reclamaties.Read: alleen lezen van Reclamaties
+ WRV.Reclamaties.ReadWrite: lezen en schrijven van Reclamaties
+ WRV.Relaties.Read: alleen lezen van Relaties
+ WRV.Relaties.ReadWrite: lezen en schrijven van Relaties
+ WRV.Sancties.Read: alleen lezen van Sancties
+ WRV.Sancties.ReadWrite: lezen en schrijven van Sancties
+ WRV.Toewijzingen.Read: alleen lezen van Toewijzingen
+ WRV.Toewijzingen.ReadWrite: lezen en schrijven van Toewijzingen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
WRV.All.Read: alleen lezen van alle resources
WRV.All.ReadWrite: lezen en schrijven van alle resources
@@ -3771,7 +3803,7 @@ components:
description: De publicatie naar aanleiding waarvan de aanbieding is gedaan.
relatie:
allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
+ - $ref: '#/components/schemas/Aanbiedingen-Relatie'
description: Het huishouden behorend bij de aanbieding.
Referentiedata:
type: object
@@ -3803,7 +3835,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Relatie-sleutels:
+ Aanbiedingen-Contactgegeven:
type: object
properties:
id:
@@ -3824,41 +3856,42 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
- rollen:
- description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
- type: array
- items:
- $ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
+ omschrijving:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
+ description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij het contactgegeven. OBSOLETE
+ deprecated: true
+ relatierol:
+ allOf:
+ - $ref: '#/components/schemas/Aanbiedingen-Relatierol'
+ description: De relatie rol van de relatie behorend bij het contactgegeven.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
+ voorkeur:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
+ waarde:
type: string
format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Relatierol-sleutels:
+ description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
+ Relatie-sleutels:
type: object
properties:
id:
@@ -3877,7 +3910,20 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Aanbiedingen-Contactgegeven:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ Relatierol-sleutels:
type: object
properties:
id:
@@ -3896,42 +3942,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
- omschrijving:
- type: string
- format: any
- description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
- relatie:
- allOf:
- - $ref: '#/components/schemas/Aanbiedingen-Relatie'
- description: De relatie behorend bij het contactgegeven.
- relatierol:
- allOf:
- - $ref: '#/components/schemas/Aanbiedingen-Relatierol'
- description: De relatie rol van de relatie behorend bij het contactgegeven.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
- voorkeur:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
- waarde:
- type: string
- format: any
- description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
Aanbiedingen-Contactmoment:
type: object
properties:
@@ -4323,10 +4333,11 @@ components:
format: float
description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
clusters:
description: De clusters waar de eenheid onderdeel van uitmaakt.
type: array
@@ -4393,15 +4404,17 @@ components:
items:
$ref: '#/components/schemas/Referentiedata'
liggingBuitenruimten:
- description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
+ description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc. OBSOLETE Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4432,7 +4445,7 @@ components:
publicatieLabel:
type: string
format: any
- description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning etc.
+ description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning, Appartement etc.
rekenhuur:
type: number
format: float
@@ -4467,7 +4480,7 @@ components:
toegankelijkheidslabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKSHEIDSLABEL.
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
totaalInhoud:
type: number
format: float
@@ -4497,6 +4510,10 @@ components:
type: integer
format: int32
description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
voorwaarden:
allOf:
- $ref: '#/components/schemas/Eenheden-EenheidVoorwaarden'
@@ -4530,6 +4547,14 @@ components:
- $ref: '#/components/schemas/Eenheden-Adres-basis'
- type: object
properties:
+ buurt:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Buurt'
+ description: De buurt behorend bij het adres.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Gemeente'
+ description: De gemeente behorend bij het adres.
geometrie:
allOf:
- $ref: '#/components/schemas/Eenheden-Geometrie'
@@ -4538,6 +4563,18 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ provincie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De provincie behorend bij het adres. Referentiedatasoort PROVINCIE.
+ stadsdeel:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Stadsdeel'
+ description: Het stadsdeel behorend bij het adres.
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Wijk'
+ description: De wijk behorend bij het adres.
woonplaats:
allOf:
- $ref: '#/components/schemas/Eenheden-Woonplaats'
@@ -4565,6 +4602,10 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het soort criterium op basis waarvan de woning passend is of waarop men voorang kan krijgen. Referentiedatasoort EENHEIDCRITERIUMDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van het criterium.
aantalBovengrens:
type: number
format: float
@@ -4879,10 +4920,6 @@ components:
type: string
format: any
description: De omschrijving van de ruimte.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheden-Eenheid'
- description: De eenheid behorend bij de ruimte.
inhoud:
type: number
format: float
@@ -4890,11 +4927,22 @@ components:
ligging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De ligging van de ruimte. Referentiedatasoort EENHEIDLIGGINGRUIMTE.
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
oppervlakte:
type: number
format: float
description: De oppervlakte van de ruimte
+ Eenheden-Stadsdeel:
+ type: object
+ properties:
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van het stadsdeel.
Eenheden-Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Eenheden-Contactgegeven-basis'
@@ -5074,8 +5122,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'soort Geometrie: punt of omtrek'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
Woonplaats-sleutels:
type: object
properties:
@@ -5291,6 +5339,37 @@ components:
- $ref: '#/components/schemas/Kandidaten-Eenheidadres'
- $ref: '#/components/schemas/Kandidaten-Postadres'
- $ref: '#/components/schemas/Kandidaten-Adres-basis'
+ Kandidaten-AuthentiekGegeven:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft het gegevens type aan. Bijvoorbeeld geregistreerde inkomens, actueel inkomen, woongeschiedenis, naw. Referentiedatasoort AUTHENTIEKGEGEVENSOORT.
+ bron:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft de bron van het gegeven aan. Bijv. MijnOverheid, Qii, IRF etc. Referentiedatasoort AUTHENTIEKGEGEVENBRONSOORT.
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor de gegevens geldig zijn.
+ token:
+ type: string
+ format: any
+ description: Een eigen validatietoken op de gegevens.
Kandidaten-BuitenlandsAdres:
allOf:
- $ref: '#/components/schemas/Kandidaten-Adres-basis'
@@ -5445,14 +5524,22 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- nettoMaandinkomen:
- type: number
- format: float
- description: Het netto maandinkomen in euro's van de natuurlijk persoon.
- brutoMaandinkomen:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort inkomen. Bijv. netto of bruto maand of jaarinkomen. Referentiedatasoort INKOMENSSOORT.
+ controledatum:
+ type: string
+ format: date-time
+ description: De datum en tijd waarop de inkomensgegevens zijn gecontroleerd.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
+ bedrag:
type: number
format: float
- description: Het bruto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het bedrag van het inkomen.
bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5460,15 +5547,27 @@ components:
brutoJaarinkomen:
type: number
format: float
- description: Het bruto jaarinkomen in euro's van de natuurlijk persoon.
- controledatum:
- type: string
- format: date-time
- description: De datum en tijd waarop de inkomensgegevens zijn gecontroleerd.
+ description: Het bruto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
+ brutoMaandinkomen:
+ type: number
+ format: float
+ description: Het bruto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor het inkomen geldig is.
nettoJaarinkomen:
type: number
format: float
- description: Het netto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het netto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
+ nettoMaandinkomen:
+ type: number
+ format: float
+ description: Het netto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
Kandidaten-Inschrijving:
allOf:
- $ref: '#/components/schemas/Kandidaten-Overeenkomst-basis'
@@ -5625,6 +5724,10 @@ components:
type: string
format: any
description: De tussenvoegsels behorende bij de naam.
+ voorrangsregelingen:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-Voorrangsregeling'
+ description: 'De voorrangsregels waar de natuurlijk persoon gebruik van maakt. Bijvoorbeeld: Bindingen, indicaties, urgenties en overige voorrangsregelingen. De klasse voorrangsregeling bevindt zich in het woonruimteverdeling domein.'
woonsituatie:
allOf:
- $ref: '#/components/schemas/Kandidaten-Woonsituatie'
@@ -5656,6 +5759,10 @@ components:
type: string
format: date
description: De einddatum waarop de studie is beëindigd.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
instelling:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5907,6 +6014,226 @@ components:
type: string
format: date-time
description: De einddatum van de signalering.
+ Kandidaten-Voorrangsregeling:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort voorrang. Bijvoorbeeld: Urgentie, binding, indicatie of groep. Referentiedatasoort VOORRANGSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail soort voorrang. Bijvoorbeeld: medisch, financieel, economisch, relationeel, huisvesting, gezinssituatie of student. Referentiedatasoort VOORRANGDETAILSOORT.'
+ naam:
+ type: string
+ format: any
+ description: De naam van de specifieke voorrangsregeling
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum die aangeeft vanaf wanneer men deze voorrang heeft.
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum tot wanneer men deze voorrang heeft.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
+ profiel:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-VoorrangsregelingProfiel'
+ description: Het profiel waarop de voorrang van toepassing is.
+ Kandidaten-VoorrangsregelingProfiel:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ buurten:
+ description: De buurten waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Buurt-sleutels'
+ eenheidSoorten:
+ description: De eenheid soorten waar het voorrangsregeling profiel voor geldt. Referentiedatasoort VOORRANGEENHEIDSOORT.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ gemeenten:
+ description: De gemeenten waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Gemeente-sleutels'
+ huidigeOppervlakte:
+ type: integer
+ format: int32
+ description: De voorrang die wordt gegeven op basis van huidige woonoppervlakte in m2.
+ huidigeVerdieping:
+ type: integer
+ format: int32
+ description: De voorrang die wordt gegeven op basis van huidige verdieping.
+ huurInkomenTabel:
+ type: boolean
+ description: De aanduiding die aangeeft dat er sprake is van voorrang voor eenheden die voldoen aan de huur inkomen tabel.
+ maximumBrutoHuur:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar de bruto huur aan het maximum voldoet.
+ maximumKamers:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar het aantal kamers aan het maximum voldoet.
+ minimumBrutoHuur:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar de bruto huur aan het minimum voldoet.
+ minimumKamers:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar het aantal kamers aan het minimum voldoet.
+ minimumOppervlakte:
+ type: integer
+ format: int32
+ description: De aanduiding die aangeeft dat er is sprake op voorrang voor eenheden die minimaal voldoen aan de aangegeven woonoppervlakte in m2.
+ stadsdelen:
+ description: De stadsdelen waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Stadsdeel-sleutels'
+ toegankelijkheidslabels:
+ description: De toegankelijkheidslabels waar het voorrangsregeling profiel voor geldt. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ wijken:
+ description: De wijken waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Wijk-sleutels'
+ woonplaatsen:
+ description: De woonplaatsen waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Woonplaats-sleutels'
+ Buurt-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de buurt.
+ Gemeente-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de gemeente.
+ Stadsdeel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Wijk-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de wijk.
Kandidaten-Woonplaats:
type: object
properties:
@@ -5949,6 +6276,10 @@ components:
type: string
format: date
description: De einddatum waarop de woonsituatie is beëindigd.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
eenheid:
allOf:
- $ref: '#/components/schemas/Kandidaten-Eenheid'
@@ -6374,15 +6705,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- buurt:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Buurt'
- gemeente:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Gemeente'
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Geometrie'
huisletter:
type: string
format: any
@@ -6403,12 +6725,6 @@ components:
type: string
format: any
description: De straatnaam behorend bij het adres.
- wijk:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Wijk'
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Woonplaats'
Publicaties-Adres:
oneOf:
- $ref: '#/components/schemas/Publicaties-Eenheidadres'
@@ -6579,10 +6895,11 @@ components:
format: float
description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
clusters:
description: De clusters waar de eenheid onderdeel van uitmaakt.
type: array
@@ -6619,11 +6936,13 @@ components:
inExploitatiedatum:
type: string
format: date
- description: De datum waarop de eenheid in exploitatie is gegaan. We spreken over exploitatie als de eenheid in beheer is met als doel dat er resultaat wordt behaald.
+ description: OBSOLETE
+ deprecated: true
inExploitatieReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het in exploitatie nemen van een eenheid. Bijvoorbeeld: verhuur of beheer namens andere eigenaren. Referentiedatasoort INEXPLOITATIEREDEN.'
+ description: OBSOLETE Referentiedatasoort INEXPLOITATIEREDEN.
+ deprecated: true
interieur:
description: Binnenruimte van de woning zoals gemeubileerd en vloerbedekking in de woonkamer. Referentiedatasoort EENHEIDINTERIEUR.
type: array
@@ -6658,16 +6977,17 @@ components:
items:
$ref: '#/components/schemas/Referentiedata'
liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort de eenheid tot de DAEB-tak of tot de niet-DAEB-tak. Het label op de eenheid kan afwijken van het maatschappelijk label van de huurovereenkomst. Hiermee kan worden aangegeven dat een eenheid die behoort tot de niet-DAEB tak als DAEB-verhuring verantwoord moet worden. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
monumenten:
- description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort MONUMENT.
+ description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort EENHEIDMONUMENT.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
@@ -6692,7 +7012,7 @@ components:
publicatieLabel:
type: string
format: any
- description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning etc.
+ description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning, Appartement etc.
rayon:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -6731,7 +7051,7 @@ components:
toegankelijkheidslabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKSHEIDSLABEL.
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
totaalInhoud:
type: number
format: float
@@ -6743,11 +7063,13 @@ components:
uitExploitatiedatum:
type: string
format: date
- description: De datum waarop de eenheid uit exploitatie is gegaan, zowel het beheer als andere activiteiten stoppen.
+ description: OBSOLETE
+ deprecated: true
uitExploitatieReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het uit exploitatie nemen van een eenheid. Voorbeeld: sloop. Referentiedatasoort UITEXPLOITATIEREDEN.'
+ description: OBSOLETE Referentiedatasoort UITEXPLOITATIEREDEN.
+ deprecated: true
verkoop:
type: boolean
description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
@@ -6765,6 +7087,10 @@ components:
type: integer
format: int32
description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
voorwaarden:
allOf:
- $ref: '#/components/schemas/Publicaties-EenheidVoorwaarden'
@@ -6798,6 +7124,14 @@ components:
- $ref: '#/components/schemas/Publicaties-Adres-basis'
- type: object
properties:
+ buurt:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Buurt'
+ description: De buurt behorend bij het adres.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Gemeente'
+ description: De gemeente behorend bij het adres.
geometrie:
allOf:
- $ref: '#/components/schemas/Publicaties-Geometrie'
@@ -6806,6 +7140,14 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ stadsdeel:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Stadsdeel'
+ description: Het stadsdeel behorend bij het adres.
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Wijk'
+ description: De wijk behorend bij het adres.
woonplaats:
allOf:
- $ref: '#/components/schemas/Publicaties-Woonplaats'
@@ -7112,6 +7454,11 @@ components:
format: any
description: De primaire URL waarop de advertentie is te vinden.
cluster:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Cluster'
+ description: Het cluster behorend bij de publicatie. OBSOLETE
+ deprecated: true
+ clusters:
allOf:
- $ref: '#/components/schemas/Publicaties-Cluster'
description: Het cluster behorend bij de publicatie.
@@ -7303,10 +7650,6 @@ components:
type: string
format: any
description: De omschrijving van de ruimte.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Eenheid'
- description: De eenheid behorend bij de ruimte.
inhoud:
type: number
format: float
@@ -7314,11 +7657,22 @@ components:
ligging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De ligging van de ruimte. Referentiedatasoort EENHEIDLIGGINGRUIMTE.
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
oppervlakte:
type: number
format: float
description: De oppervlakte van de ruimte
+ Publicaties-Stadsdeel:
+ type: object
+ properties:
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van het stadsdeel.
Publicaties-Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Publicaties-Contactgegeven-basis'
@@ -7520,8 +7874,8 @@ components:
deprecated: true
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
deprecated: true
Puntenberekeningen-Inschrijving:
allOf:
@@ -8156,8 +8510,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Reclamaties-Reclamatiebericht:
allOf:
- $ref: '#/components/schemas/Reclamaties-Reclamatie'
@@ -8834,12 +9188,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -8953,8 +9307,9 @@ components:
$ref: '#/components/schemas/Relaties-RelatieAdres'
rolRelatie:
allOf:
- - $ref: '#/components/schemas/Relaties-Relatie'
- description: De relatie die aangeeft waar de relatie en rol koppeling van toepassing is. Dit attribuut geeft aan dat de aangegeven relatie de rol binnen bijvoorbeeld een relatiegroep heeft. Het attribuut relatie is dan bijvoorbeeld een persoon uit een huishouden en de rolRelatie is dan bijvoorbeeld de relatiegroep die het huishouden voorstelt.
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: OBSOLETE.
+ deprecated: true
Relaties-Woonplaats:
type: object
properties:
@@ -9259,7 +9614,7 @@ components:
- $ref: '#/components/schemas/Sancties-Overeenkomst'
description: De inschrijving waarop de sacntie van toepassing is.
puntengebeurtenissen:
- description: De geberutenissen die hebben geleid tot de sanctie.
+ description: De gebeurtenissen die hebben geleid tot de sanctie.
type: array
items:
$ref: '#/components/schemas/Sancties-Puntengebeurtenis'
@@ -9296,11 +9651,13 @@ components:
nettoMaandinkomen:
type: number
format: float
- description: Het netto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het netto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
brutoMaandinkomen:
type: number
format: float
- description: Het bruto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -9308,7 +9665,8 @@ components:
brutoJaarinkomen:
type: number
format: float
- description: Het bruto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
controledatum:
type: string
format: date-time
@@ -9316,7 +9674,8 @@ components:
nettoJaarinkomen:
type: number
format: float
- description: Het netto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het netto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
Toewijzingen-Kandidaat:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Algemeen.yaml b/docs/Informatiedomeinen/Algemeen.yaml
index d1f3b5f..52f6a4d 100644
--- a/docs/Informatiedomeinen/Algemeen.yaml
+++ b/docs/Informatiedomeinen/Algemeen.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://algemeen.vera.io:{port}/{basePath}
description: Productieserver
@@ -31,7 +31,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -47,7 +47,7 @@ paths:
get:
tags:
- 'ExtraAttributen'
- description: Ophalen van ExtraAttributen
+ summary: Ophalen van ExtraAttributen
operationId: listExtraAttributen
parameters:
- name: params
@@ -97,7 +97,7 @@ paths:
post:
tags:
- 'ExtraAttributen'
- description: Voegt een nieuw(e) ExtraAttribuut toe.
+ summary: Voegt een nieuw(e) ExtraAttribuut toe.
operationId: createExtraAttribuut
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
put:
tags:
- 'ExtraAttributen'
- description: |
+ summary: |
Vervangen van een ExtraAttribuut op basis van overeenkomstige sleutelvelden.
operationId: replaceExtraAttribuut
parameters:
@@ -172,7 +172,7 @@ paths:
patch:
tags:
- 'ExtraAttributen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExtraAttribuut. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExtraAttribuut
@@ -209,7 +209,7 @@ paths:
get:
tags:
- 'ExtraAttributen'
- description: Retourneert een ExtraAttribuut met de gegeven identifier
+ summary: Retourneert een ExtraAttribuut met de gegeven identifier
operationId: readExtraAttribuutById
parameters:
- name: id
@@ -246,7 +246,7 @@ paths:
put:
tags:
- 'ExtraAttributen'
- description: Vervangen van een ExtraAttribuut
+ summary: Vervangen van een ExtraAttribuut
operationId: replaceExtraAttribuutById
parameters:
- name: 'id'
@@ -284,7 +284,7 @@ paths:
patch:
tags:
- 'ExtraAttributen'
- description: Wijzigen van een ExtraAttribuut
+ summary: Wijzigen van een ExtraAttribuut
operationId: updateExtraAttribuutById
parameters:
- name: 'id'
@@ -323,7 +323,7 @@ paths:
get:
tags:
- 'Referentiedata'
- description: Ophalen van Referentiedata
+ summary: Ophalen van Referentiedata
operationId: listReferentiedata
parameters:
- name: params
@@ -373,7 +373,7 @@ paths:
post:
tags:
- 'Referentiedata'
- description: Voegt een nieuw(e) Referentiedata toe.
+ summary: Voegt een nieuw(e) Referentiedata toe.
operationId: createReferentiedata
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
put:
tags:
- 'Referentiedata'
- description: |
+ summary: |
Vervangen van een Referentiedata op basis van overeenkomstige sleutelvelden.
operationId: replaceReferentiedata
parameters:
@@ -448,7 +448,7 @@ paths:
patch:
tags:
- 'Referentiedata'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Referentiedata. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReferentiedata
@@ -485,7 +485,7 @@ paths:
get:
tags:
- 'Referentiedata'
- description: Retourneert een Referentiedata met de gegeven identifier
+ summary: Retourneert een Referentiedata met de gegeven identifier
operationId: readReferentiedataById
parameters:
- name: id
@@ -522,7 +522,7 @@ paths:
put:
tags:
- 'Referentiedata'
- description: Vervangen van een Referentiedata
+ summary: Vervangen van een Referentiedata
operationId: replaceReferentiedataById
parameters:
- name: 'id'
@@ -560,7 +560,7 @@ paths:
patch:
tags:
- 'Referentiedata'
- description: Wijzigen van een Referentiedata
+ summary: Wijzigen van een Referentiedata
operationId: updateReferentiedataById
parameters:
- name: 'id'
@@ -599,7 +599,7 @@ paths:
get:
tags:
- 'Sturingslabels'
- description: Ophalen van Sturingslabels
+ summary: Ophalen van Sturingslabels
operationId: listSturingslabels
parameters:
- name: params
@@ -649,7 +649,7 @@ paths:
post:
tags:
- 'Sturingslabels'
- description: Voegt een nieuw(e) Sturingslabel toe.
+ summary: Voegt een nieuw(e) Sturingslabel toe.
operationId: createSturingslabel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
put:
tags:
- 'Sturingslabels'
- description: |
+ summary: |
Vervangen van een Sturingslabel op basis van overeenkomstige sleutelvelden.
operationId: replaceSturingslabel
parameters:
@@ -724,7 +724,7 @@ paths:
patch:
tags:
- 'Sturingslabels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Sturingslabel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSturingslabel
@@ -761,7 +761,7 @@ paths:
get:
tags:
- 'Sturingslabels'
- description: Retourneert een Sturingslabel met de gegeven identifier
+ summary: Retourneert een Sturingslabel met de gegeven identifier
operationId: readSturingslabelById
parameters:
- name: id
@@ -798,7 +798,7 @@ paths:
put:
tags:
- 'Sturingslabels'
- description: Vervangen van een Sturingslabel
+ summary: Vervangen van een Sturingslabel
operationId: replaceSturingslabelById
parameters:
- name: 'id'
@@ -836,7 +836,7 @@ paths:
patch:
tags:
- 'Sturingslabels'
- description: Wijzigen van een Sturingslabel
+ summary: Wijzigen van een Sturingslabel
operationId: updateSturingslabelById
parameters:
- name: 'id'
@@ -908,10 +908,22 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Algemeen.All.Read: alleen lezen van alle resources
+ Algemeen.All.ReadWrite: lezen en schrijven van alle resources
+ Algemeen.ExtraAttributen.Read: alleen lezen van ExtraAttributen
+ Algemeen.ExtraAttributen.ReadWrite: lezen en schrijven van ExtraAttributen
+ Algemeen.Referentiedata.Read: alleen lezen van Referentiedata
+ Algemeen.Referentiedata.ReadWrite: lezen en schrijven van Referentiedata
+ Algemeen.Sturingslabels.Read: alleen lezen van Sturingslabels
+ Algemeen.Sturingslabels.ReadWrite: lezen en schrijven van Sturingslabels
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Algemeen.All.Read: alleen lezen van alle resources
Algemeen.All.ReadWrite: lezen en schrijven van alle resources
@@ -970,7 +982,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -982,7 +994,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
diff --git a/docs/Informatiedomeinen/Dossier.yaml b/docs/Informatiedomeinen/Dossier.yaml
index 38d95dd..1aefd32 100644
--- a/docs/Informatiedomeinen/Dossier.yaml
+++ b/docs/Informatiedomeinen/Dossier.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://dossier.vera.io:{port}/{basePath}
description: Productieserver
@@ -22,6 +22,8 @@ servers:
basePath:
default: v4
tags:
+- name: AuthentiekeGegevens
+ description: Operaties met betrekking tot een AuthentiekGegeven
- name: Dossiers
description: Operaties met betrekking tot een Dossier
- name: Informatieobjecten
@@ -49,7 +51,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -61,11 +63,287 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Foutbericht'
+ /authentieke-gegevens:
+ get:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Ophalen van AuthentiekeGegevens
+ operationId: listAuthentiekeGegevens
+ parameters:
+ - name: params
+ in: query
+ style: form
+ explode: true
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ - $ref: '#/components/parameters/Cursor'
+ - $ref: '#/components/parameters/Pagina'
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ - $ref: '#/components/parameters/ParametersPeiltijdstipMaterieel'
+ - $ref: '#/components/parameters/ParametersAantalPerPagina'
+ responses:
+ '200':
+ description: OK
+ content:
+ 'application/json':
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ headers:
+ X-Parameters-Aantal:
+ $ref: '#/components/headers/X-Parameters-Aantal'
+ X-Parameters-AantalPerPagina:
+ $ref: '#/components/headers/X-Parameters-AantalPerPagina'
+ X-Parameters-Pagina:
+ $ref: '#/components/headers/X-Parameters-Pagina'
+ X-Parameters-Cursor:
+ $ref: '#/components/headers/X-Parameters-Cursor'
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ default:
+ description: Onverwachte fout
+ content:
+ 'application/json':
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.Read
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ post:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Voegt een nieuw(e) AuthentiekGegeven toe.
+ operationId: createAuthentiekGegeven
+ parameters:
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '201':
+ description: Created
+ headers:
+ Location:
+ schema:
+ type: string
+ format: uri
+ description: URL waar de resource leeft.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ put:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: |
+ Vervangen van een AuthentiekGegeven op basis van overeenkomstige sleutelvelden.
+ operationId: replaceAuthentiekGegeven
+ parameters:
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '200':
+ description: OK
+ '400':
+ description: Bad Request
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ patch:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: |
+ Wijzigen van afzonderlijke attributen van een AuthentiekGegeven. In de meegestuurde entiteit moeten
+ sleutelvelden aanwezig zijn.
+ operationId: updateAuthentiekGegeven
+ parameters:
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '200':
+ description: OK
+ '400':
+ description: Bad Request
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ /authentieke-gegevens/{id}:
+ get:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Retourneert een AuthentiekGegeven met de gegeven identifier
+ operationId: readAuthentiekGegevenById
+ parameters:
+ - name: id
+ in: path
+ description: Id van AuthentiekGegeven om op te halen
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.Read
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ put:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Vervangen van een AuthentiekGegeven
+ operationId: replaceAuthentiekGegevenById
+ parameters:
+ - name: 'id'
+ in: 'path'
+ description: Id van AuthentiekGegeven om te vervangen
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
+ responses:
+ '200':
+ description: OK
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ patch:
+ tags:
+ - 'AuthentiekeGegevens'
+ summary: Wijzigen van een AuthentiekGegeven
+ operationId: updateAuthentiekGegevenById
+ parameters:
+ - name: 'id'
+ in: 'path'
+ description: Id van AuthentiekGegeven om te wijzigen
+ required: true
+ schema:
+ type: integer
+ - $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
+ - $ref: '#/components/parameters/StuurgegevensZenderAdministratie'
+ - $ref: '#/components/parameters/StuurgegevensTijdstipBericht'
+ - $ref: '#/components/parameters/StuurgegevensReferentienummer'
+ requestBody:
+ description: Entiteit AuthentiekGegeven
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthentiekGegevenbericht'
+ responses:
+ '200':
+ description: OK
+ '401':
+ $ref: '#/components/responses/NietGeautoriseerd'
+ '404':
+ description: Not Found
+ default:
+ description: Onverwachte fout
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Foutbericht'
+ security:
+ - OAuth2:
+ - Dossier.AuthentiekeGegevens.ReadWrite
/dossiers:
get:
tags:
- 'Dossiers'
- description: Ophalen van Dossiers
+ summary: Ophalen van Dossiers
operationId: listDossiers
parameters:
- name: params
@@ -115,7 +393,7 @@ paths:
post:
tags:
- 'Dossiers'
- description: Voegt een nieuw(e) Dossier toe.
+ summary: Voegt een nieuw(e) Dossier toe.
operationId: createDossier
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -155,7 +433,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: |
+ summary: |
Vervangen van een Dossier op basis van overeenkomstige sleutelvelden.
operationId: replaceDossier
parameters:
@@ -190,7 +468,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Dossier. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDossier
@@ -227,7 +505,7 @@ paths:
get:
tags:
- 'Dossiers'
- description: Retourneert een Dossier met de gegeven identifier
+ summary: Retourneert een Dossier met de gegeven identifier
operationId: readDossierById
parameters:
- name: id
@@ -264,7 +542,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: Vervangen van een Dossier
+ summary: Vervangen van een Dossier
operationId: replaceDossierById
parameters:
- name: 'id'
@@ -302,7 +580,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: Wijzigen van een Dossier
+ summary: Wijzigen van een Dossier
operationId: updateDossierById
parameters:
- name: 'id'
@@ -341,7 +619,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Ophalen van Informatieobjecten
+ summary: Ophalen van Informatieobjecten
operationId: listInformatieobjecten
parameters:
- name: params
@@ -391,7 +669,7 @@ paths:
post:
tags:
- 'Informatieobjecten'
- description: Voegt een nieuw(e) Informatieobject toe.
+ summary: Voegt een nieuw(e) Informatieobject toe.
operationId: createInformatieobject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -431,7 +709,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Vervangen van een Informatieobject op basis van overeenkomstige sleutelvelden.
operationId: replaceInformatieobject
parameters:
@@ -466,7 +744,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Informatieobject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInformatieobject
@@ -503,7 +781,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Retourneert een Informatieobject met de gegeven identifier
+ summary: Retourneert een Informatieobject met de gegeven identifier
operationId: readInformatieobjectById
parameters:
- name: id
@@ -540,7 +818,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: Vervangen van een Informatieobject
+ summary: Vervangen van een Informatieobject
operationId: replaceInformatieobjectById
parameters:
- name: 'id'
@@ -578,7 +856,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: Wijzigen van een Informatieobject
+ summary: Wijzigen van een Informatieobject
operationId: updateInformatieobjectById
parameters:
- name: 'id'
@@ -617,7 +895,7 @@ paths:
get:
tags:
- 'Informatieobjectkenmerken'
- description: Ophalen van Informatieobjectkenmerken
+ summary: Ophalen van Informatieobjectkenmerken
operationId: listInformatieobjectkenmerken
parameters:
- name: params
@@ -667,7 +945,7 @@ paths:
post:
tags:
- 'Informatieobjectkenmerken'
- description: Voegt een nieuw(e) Informatieobjectkenmerk toe.
+ summary: Voegt een nieuw(e) Informatieobjectkenmerk toe.
operationId: createInformatieobjectkenmerk
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -707,7 +985,7 @@ paths:
put:
tags:
- 'Informatieobjectkenmerken'
- description: |
+ summary: |
Vervangen van een Informatieobjectkenmerk op basis van overeenkomstige sleutelvelden.
operationId: replaceInformatieobjectkenmerk
parameters:
@@ -742,7 +1020,7 @@ paths:
patch:
tags:
- 'Informatieobjectkenmerken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Informatieobjectkenmerk. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInformatieobjectkenmerk
@@ -779,7 +1057,7 @@ paths:
get:
tags:
- 'Informatieobjectkenmerken'
- description: Retourneert een Informatieobjectkenmerk met de gegeven identifier
+ summary: Retourneert een Informatieobjectkenmerk met de gegeven identifier
operationId: readInformatieobjectkenmerkById
parameters:
- name: id
@@ -816,7 +1094,7 @@ paths:
put:
tags:
- 'Informatieobjectkenmerken'
- description: Vervangen van een Informatieobjectkenmerk
+ summary: Vervangen van een Informatieobjectkenmerk
operationId: replaceInformatieobjectkenmerkById
parameters:
- name: 'id'
@@ -854,7 +1132,7 @@ paths:
patch:
tags:
- 'Informatieobjectkenmerken'
- description: Wijzigen van een Informatieobjectkenmerk
+ summary: Wijzigen van een Informatieobjectkenmerk
operationId: updateInformatieobjectkenmerkById
parameters:
- name: 'id'
@@ -893,7 +1171,7 @@ paths:
get:
tags:
- 'Processen'
- description: Ophalen van Processen
+ summary: Ophalen van Processen
operationId: listProcessen
parameters:
- name: params
@@ -943,7 +1221,7 @@ paths:
post:
tags:
- 'Processen'
- description: Voegt een nieuw(e) Proces toe.
+ summary: Voegt een nieuw(e) Proces toe.
operationId: createProces
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -983,7 +1261,7 @@ paths:
put:
tags:
- 'Processen'
- description: |
+ summary: |
Vervangen van een Proces op basis van overeenkomstige sleutelvelden.
operationId: replaceProces
parameters:
@@ -1018,7 +1296,7 @@ paths:
patch:
tags:
- 'Processen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Proces. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProces
@@ -1055,7 +1333,7 @@ paths:
get:
tags:
- 'Processen'
- description: Retourneert een Proces met de gegeven identifier
+ summary: Retourneert een Proces met de gegeven identifier
operationId: readProcesById
parameters:
- name: id
@@ -1092,7 +1370,7 @@ paths:
put:
tags:
- 'Processen'
- description: Vervangen van een Proces
+ summary: Vervangen van een Proces
operationId: replaceProcesById
parameters:
- name: 'id'
@@ -1130,7 +1408,7 @@ paths:
patch:
tags:
- 'Processen'
- description: Wijzigen van een Proces
+ summary: Wijzigen van een Proces
operationId: updateProcesById
parameters:
- name: 'id'
@@ -1169,7 +1447,7 @@ paths:
get:
tags:
- 'Procesrollen'
- description: Ophalen van Procesrollen
+ summary: Ophalen van Procesrollen
operationId: listProcesrollen
parameters:
- name: params
@@ -1219,7 +1497,7 @@ paths:
post:
tags:
- 'Procesrollen'
- description: Voegt een nieuw(e) Procesrol toe.
+ summary: Voegt een nieuw(e) Procesrol toe.
operationId: createProcesrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1259,7 +1537,7 @@ paths:
put:
tags:
- 'Procesrollen'
- description: |
+ summary: |
Vervangen van een Procesrol op basis van overeenkomstige sleutelvelden.
operationId: replaceProcesrol
parameters:
@@ -1294,7 +1572,7 @@ paths:
patch:
tags:
- 'Procesrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Procesrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProcesrol
@@ -1331,7 +1609,7 @@ paths:
get:
tags:
- 'Procesrollen'
- description: Retourneert een Procesrol met de gegeven identifier
+ summary: Retourneert een Procesrol met de gegeven identifier
operationId: readProcesrolById
parameters:
- name: id
@@ -1368,7 +1646,7 @@ paths:
put:
tags:
- 'Procesrollen'
- description: Vervangen van een Procesrol
+ summary: Vervangen van een Procesrol
operationId: replaceProcesrolById
parameters:
- name: 'id'
@@ -1406,7 +1684,7 @@ paths:
patch:
tags:
- 'Procesrollen'
- description: Wijzigen van een Procesrol
+ summary: Wijzigen van een Procesrol
operationId: updateProcesrolById
parameters:
- name: 'id'
@@ -1445,7 +1723,7 @@ paths:
get:
tags:
- 'Processtappen'
- description: Ophalen van Processtappen
+ summary: Ophalen van Processtappen
operationId: listProcesstappen
parameters:
- name: params
@@ -1495,7 +1773,7 @@ paths:
post:
tags:
- 'Processtappen'
- description: Voegt een nieuw(e) Processtap toe.
+ summary: Voegt een nieuw(e) Processtap toe.
operationId: createProcesstap
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1535,7 +1813,7 @@ paths:
put:
tags:
- 'Processtappen'
- description: |
+ summary: |
Vervangen van een Processtap op basis van overeenkomstige sleutelvelden.
operationId: replaceProcesstap
parameters:
@@ -1570,7 +1848,7 @@ paths:
patch:
tags:
- 'Processtappen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Processtap. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProcesstap
@@ -1607,7 +1885,7 @@ paths:
get:
tags:
- 'Processtappen'
- description: Retourneert een Processtap met de gegeven identifier
+ summary: Retourneert een Processtap met de gegeven identifier
operationId: readProcesstapById
parameters:
- name: id
@@ -1644,7 +1922,7 @@ paths:
put:
tags:
- 'Processtappen'
- description: Vervangen van een Processtap
+ summary: Vervangen van een Processtap
operationId: replaceProcesstapById
parameters:
- name: 'id'
@@ -1682,7 +1960,7 @@ paths:
patch:
tags:
- 'Processtappen'
- description: Wijzigen van een Processtap
+ summary: Wijzigen van een Processtap
operationId: updateProcesstapById
parameters:
- name: 'id'
@@ -1721,7 +1999,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Ophalen van Zaken
+ summary: Ophalen van Zaken
operationId: listZaken
parameters:
- name: params
@@ -1771,7 +2049,7 @@ paths:
post:
tags:
- 'Zaken'
- description: Voegt een nieuw(e) Zaak toe.
+ summary: Voegt een nieuw(e) Zaak toe.
operationId: createZaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1811,7 +2089,7 @@ paths:
put:
tags:
- 'Zaken'
- description: |
+ summary: |
Vervangen van een Zaak op basis van overeenkomstige sleutelvelden.
operationId: replaceZaak
parameters:
@@ -1846,7 +2124,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaak
@@ -1883,7 +2161,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Retourneert een Zaak met de gegeven identifier
+ summary: Retourneert een Zaak met de gegeven identifier
operationId: readZaakById
parameters:
- name: id
@@ -1920,7 +2198,7 @@ paths:
put:
tags:
- 'Zaken'
- description: Vervangen van een Zaak
+ summary: Vervangen van een Zaak
operationId: replaceZaakById
parameters:
- name: 'id'
@@ -1958,7 +2236,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: Wijzigen van een Zaak
+ summary: Wijzigen van een Zaak
operationId: updateZaakById
parameters:
- name: 'id'
@@ -1997,7 +2275,7 @@ paths:
get:
tags:
- 'Zaakkenmerken'
- description: Ophalen van Zaakkenmerken
+ summary: Ophalen van Zaakkenmerken
operationId: listZaakkenmerken
parameters:
- name: params
@@ -2047,7 +2325,7 @@ paths:
post:
tags:
- 'Zaakkenmerken'
- description: Voegt een nieuw(e) Zaakkenmerk toe.
+ summary: Voegt een nieuw(e) Zaakkenmerk toe.
operationId: createZaakkenmerk
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2087,7 +2365,7 @@ paths:
put:
tags:
- 'Zaakkenmerken'
- description: |
+ summary: |
Vervangen van een Zaakkenmerk op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakkenmerk
parameters:
@@ -2122,7 +2400,7 @@ paths:
patch:
tags:
- 'Zaakkenmerken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakkenmerk. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakkenmerk
@@ -2159,7 +2437,7 @@ paths:
get:
tags:
- 'Zaakkenmerken'
- description: Retourneert een Zaakkenmerk met de gegeven identifier
+ summary: Retourneert een Zaakkenmerk met de gegeven identifier
operationId: readZaakkenmerkById
parameters:
- name: id
@@ -2196,7 +2474,7 @@ paths:
put:
tags:
- 'Zaakkenmerken'
- description: Vervangen van een Zaakkenmerk
+ summary: Vervangen van een Zaakkenmerk
operationId: replaceZaakkenmerkById
parameters:
- name: 'id'
@@ -2234,7 +2512,7 @@ paths:
patch:
tags:
- 'Zaakkenmerken'
- description: Wijzigen van een Zaakkenmerk
+ summary: Wijzigen van een Zaakkenmerk
operationId: updateZaakkenmerkById
parameters:
- name: 'id'
@@ -2273,7 +2551,7 @@ paths:
get:
tags:
- 'Zaakobjecten'
- description: Ophalen van Zaakobjecten
+ summary: Ophalen van Zaakobjecten
operationId: listZaakobjecten
parameters:
- name: params
@@ -2323,7 +2601,7 @@ paths:
post:
tags:
- 'Zaakobjecten'
- description: Voegt een nieuw(e) Zaakobject toe.
+ summary: Voegt een nieuw(e) Zaakobject toe.
operationId: createZaakobject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2363,7 +2641,7 @@ paths:
put:
tags:
- 'Zaakobjecten'
- description: |
+ summary: |
Vervangen van een Zaakobject op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakobject
parameters:
@@ -2398,7 +2676,7 @@ paths:
patch:
tags:
- 'Zaakobjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakobject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakobject
@@ -2435,7 +2713,7 @@ paths:
get:
tags:
- 'Zaakobjecten'
- description: Retourneert een Zaakobject met de gegeven identifier
+ summary: Retourneert een Zaakobject met de gegeven identifier
operationId: readZaakobjectById
parameters:
- name: id
@@ -2472,7 +2750,7 @@ paths:
put:
tags:
- 'Zaakobjecten'
- description: Vervangen van een Zaakobject
+ summary: Vervangen van een Zaakobject
operationId: replaceZaakobjectById
parameters:
- name: 'id'
@@ -2510,7 +2788,7 @@ paths:
patch:
tags:
- 'Zaakobjecten'
- description: Wijzigen van een Zaakobject
+ summary: Wijzigen van een Zaakobject
operationId: updateZaakobjectById
parameters:
- name: 'id'
@@ -2549,7 +2827,7 @@ paths:
get:
tags:
- 'Zaakrollen'
- description: Ophalen van Zaakrollen
+ summary: Ophalen van Zaakrollen
operationId: listZaakrollen
parameters:
- name: params
@@ -2599,7 +2877,7 @@ paths:
post:
tags:
- 'Zaakrollen'
- description: Voegt een nieuw(e) Zaakrol toe.
+ summary: Voegt een nieuw(e) Zaakrol toe.
operationId: createZaakrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2639,7 +2917,7 @@ paths:
put:
tags:
- 'Zaakrollen'
- description: |
+ summary: |
Vervangen van een Zaakrol op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakrol
parameters:
@@ -2674,7 +2952,7 @@ paths:
patch:
tags:
- 'Zaakrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakrol
@@ -2711,7 +2989,7 @@ paths:
get:
tags:
- 'Zaakrollen'
- description: Retourneert een Zaakrol met de gegeven identifier
+ summary: Retourneert een Zaakrol met de gegeven identifier
operationId: readZaakrolById
parameters:
- name: id
@@ -2748,7 +3026,7 @@ paths:
put:
tags:
- 'Zaakrollen'
- description: Vervangen van een Zaakrol
+ summary: Vervangen van een Zaakrol
operationId: replaceZaakrolById
parameters:
- name: 'id'
@@ -2786,7 +3064,7 @@ paths:
patch:
tags:
- 'Zaakrollen'
- description: Wijzigen van een Zaakrol
+ summary: Wijzigen van een Zaakrol
operationId: updateZaakrolById
parameters:
- name: 'id'
@@ -2825,7 +3103,7 @@ paths:
get:
tags:
- 'Zaakstatussen'
- description: Ophalen van Zaakstatussen
+ summary: Ophalen van Zaakstatussen
operationId: listZaakstatussen
parameters:
- name: params
@@ -2875,7 +3153,7 @@ paths:
post:
tags:
- 'Zaakstatussen'
- description: Voegt een nieuw(e) Zaakstatus toe.
+ summary: Voegt een nieuw(e) Zaakstatus toe.
operationId: createZaakstatus
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2915,7 +3193,7 @@ paths:
put:
tags:
- 'Zaakstatussen'
- description: |
+ summary: |
Vervangen van een Zaakstatus op basis van overeenkomstige sleutelvelden.
operationId: replaceZaakstatus
parameters:
@@ -2950,7 +3228,7 @@ paths:
patch:
tags:
- 'Zaakstatussen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaakstatus. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaakstatus
@@ -2987,7 +3265,7 @@ paths:
get:
tags:
- 'Zaakstatussen'
- description: Retourneert een Zaakstatus met de gegeven identifier
+ summary: Retourneert een Zaakstatus met de gegeven identifier
operationId: readZaakstatusById
parameters:
- name: id
@@ -3024,7 +3302,7 @@ paths:
put:
tags:
- 'Zaakstatussen'
- description: Vervangen van een Zaakstatus
+ summary: Vervangen van een Zaakstatus
operationId: replaceZaakstatusById
parameters:
- name: 'id'
@@ -3062,7 +3340,7 @@ paths:
patch:
tags:
- 'Zaakstatussen'
- description: Wijzigen van een Zaakstatus
+ summary: Wijzigen van een Zaakstatus
operationId: updateZaakstatusById
parameters:
- name: 'id'
@@ -3101,7 +3379,7 @@ paths:
get:
tags:
- 'Zaaktypen'
- description: Ophalen van Zaaktypen
+ summary: Ophalen van Zaaktypen
operationId: listZaaktypen
parameters:
- name: params
@@ -3151,7 +3429,7 @@ paths:
post:
tags:
- 'Zaaktypen'
- description: Voegt een nieuw(e) Zaaktype toe.
+ summary: Voegt een nieuw(e) Zaaktype toe.
operationId: createZaaktype
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3191,7 +3469,7 @@ paths:
put:
tags:
- 'Zaaktypen'
- description: |
+ summary: |
Vervangen van een Zaaktype op basis van overeenkomstige sleutelvelden.
operationId: replaceZaaktype
parameters:
@@ -3226,7 +3504,7 @@ paths:
patch:
tags:
- 'Zaaktypen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaaktype. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaaktype
@@ -3263,7 +3541,7 @@ paths:
get:
tags:
- 'Zaaktypen'
- description: Retourneert een Zaaktype met de gegeven identifier
+ summary: Retourneert een Zaaktype met de gegeven identifier
operationId: readZaaktypeById
parameters:
- name: id
@@ -3300,7 +3578,7 @@ paths:
put:
tags:
- 'Zaaktypen'
- description: Vervangen van een Zaaktype
+ summary: Vervangen van een Zaaktype
operationId: replaceZaaktypeById
parameters:
- name: 'id'
@@ -3338,7 +3616,7 @@ paths:
patch:
tags:
- 'Zaaktypen'
- description: Wijzigen van een Zaaktype
+ summary: Wijzigen van een Zaaktype
operationId: updateZaaktypeById
parameters:
- name: 'id'
@@ -3410,13 +3688,16 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
scopes:
Dossier.All.Read: alleen lezen van alle resources
Dossier.All.ReadWrite: lezen en schrijven van alle resources
+ Dossier.AuthentiekeGegevens.Read: alleen lezen van AuthentiekeGegevens
+ Dossier.AuthentiekeGegevens.ReadWrite: lezen en schrijven van AuthentiekeGegevens
Dossier.Dossiers.Read: alleen lezen van Dossiers
Dossier.Dossiers.ReadWrite: lezen en schrijven van Dossiers
Dossier.Informatieobjecten.Read: alleen lezen van Informatieobjecten
@@ -3441,19 +3722,50 @@ components:
Dossier.Zaakstatussen.ReadWrite: lezen en schrijven van Zaakstatussen
Dossier.Zaaktypen.Read: alleen lezen van Zaaktypen
Dossier.Zaaktypen.ReadWrite: lezen en schrijven van Zaaktypen
- responses:
- NietGeautoriseerd:
- description: Unauthorized
- headers:
- X-API-KEY:
- schema:
+ clientCredentials:
+ tokenUrl: /oauth/token
+ scopes:
+ Dossier.All.Read: alleen lezen van alle resources
+ Dossier.All.ReadWrite: lezen en schrijven van alle resources
+ Dossier.AuthentiekeGegevens.Read: alleen lezen van AuthentiekeGegevens
+ Dossier.AuthentiekeGegevens.ReadWrite: lezen en schrijven van AuthentiekeGegevens
+ Dossier.Dossiers.Read: alleen lezen van Dossiers
+ Dossier.Dossiers.ReadWrite: lezen en schrijven van Dossiers
+ Dossier.Informatieobjecten.Read: alleen lezen van Informatieobjecten
+ Dossier.Informatieobjecten.ReadWrite: lezen en schrijven van Informatieobjecten
+ Dossier.Informatieobjectkenmerken.Read: alleen lezen van Informatieobjectkenmerken
+ Dossier.Informatieobjectkenmerken.ReadWrite: lezen en schrijven van Informatieobjectkenmerken
+ Dossier.Processen.Read: alleen lezen van Processen
+ Dossier.Processen.ReadWrite: lezen en schrijven van Processen
+ Dossier.Procesrollen.Read: alleen lezen van Procesrollen
+ Dossier.Procesrollen.ReadWrite: lezen en schrijven van Procesrollen
+ Dossier.Processtappen.Read: alleen lezen van Processtappen
+ Dossier.Processtappen.ReadWrite: lezen en schrijven van Processtappen
+ Dossier.Zaken.Read: alleen lezen van Zaken
+ Dossier.Zaken.ReadWrite: lezen en schrijven van Zaken
+ Dossier.Zaakkenmerken.Read: alleen lezen van Zaakkenmerken
+ Dossier.Zaakkenmerken.ReadWrite: lezen en schrijven van Zaakkenmerken
+ Dossier.Zaakobjecten.Read: alleen lezen van Zaakobjecten
+ Dossier.Zaakobjecten.ReadWrite: lezen en schrijven van Zaakobjecten
+ Dossier.Zaakrollen.Read: alleen lezen van Zaakrollen
+ Dossier.Zaakrollen.ReadWrite: lezen en schrijven van Zaakrollen
+ Dossier.Zaakstatussen.Read: alleen lezen van Zaakstatussen
+ Dossier.Zaakstatussen.ReadWrite: lezen en schrijven van Zaakstatussen
+ Dossier.Zaaktypen.Read: alleen lezen van Zaaktypen
+ Dossier.Zaaktypen.ReadWrite: lezen en schrijven van Zaaktypen
+ responses:
+ NietGeautoriseerd:
+ description: Unauthorized
+ headers:
+ X-API-KEY:
+ schema:
type: string
schemas:
- Dossierbericht:
+ AuthentiekGegevenbericht:
allOf:
- - $ref: '#/components/schemas/Dossier'
+ - $ref: '#/components/schemas/AuthentiekGegeven'
- $ref: '#/components/schemas/Bericht-basis'
- Dossier:
+ AuthentiekGegeven:
type: object
properties:
id:
@@ -3468,124 +3780,38 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Geeft het dossier type aan. Bijvoorbeeld mutatiedossier. Referentiedatasoort DOSSIERSOORT.
- detailSoort:
+ description: Geeft het gegevens type aan. Bijvoorbeeld geregistreerde inkomens, actueel inkomen, woongeschiedenis, naw. Referentiedatasoort AUTHENTIEKGEGEVENSOORT.
+ bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Geeft het dossier detail type aan. Referentiedatasoort DOSSIERDETAILSOORT.
- omschrijving:
- type: string
- format: any
- description: Beknopte omschrijving van het dossier.
- bovenliggendDossier:
- allOf:
- - $ref: '#/components/schemas/Dossier-sleutels'
- description: Het dossier waarin dit dossier is opgenomen.
+ description: Geeft de bron van het gegeven aan. Bijv. MijnOverheid, Qii, IRF etc. Referentiedatasoort AUTHENTIEKGEGEVENBRONSOORT.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt (Bijvoorbeeld 'Gearchiveerd'). Referentiedatasoort DOSSIERSTATUS.
+ description: De De status van het gegeven. Bijv. Gevalideerd, Vervallen. Referentiedatasoort AUTHENTIEKGEGEVENSTATUS.
begindatum:
type: string
format: date-time
- description: De datum waarop het dossier gevormd is.
+ description: De datum waarop de gevalideerde gegevens zijn vastgelegd.
einddatum:
type: string
format: date-time
- description: De datum waarop het dossier afgesloten is.
- archiefActiedatum:
+ description: De datum waarop gevalideerde gegevens verlopen of er nieuwe gegevens zijn ingegaan (gevalideerd of zelf ingevuld).
+ gegevens:
type: string
- format: date-time
- description: De datum waarop het dossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
- archiefnominatie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding of de informatieobjecten binnen het dossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
- clusters:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
- collectiefObjecten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
- contactmomenten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- deelDossiers:
- description: Het dossier bevat onderliggende dossier(s).
- type: array
- items:
- $ref: '#/components/schemas/Dossier-sleutels'
- detailStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Detaillering van de fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt. Referentiedatasoort DOSSIERDETAILSTATUS.
- eenheden:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
- inkoopfacturen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Factuur in informatiedomein Financien
- inkoopopdrachten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- objecten:
- description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
- type: array
- items:
- $ref: '#/components/schemas/Zaakobject'
- onderhoudsverzoeken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- processen:
- description: Het dossier is gekoppeld aan/heeft betrekking op proces(sen).
- type: array
- items:
- $ref: '#/components/schemas/Proces'
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- zaken:
- description: Zaken die gekoppeld zijn aan dit dossier.
- type: array
- items:
- $ref: '#/components/schemas/Zaak'
+ format: any
+ description: De ruwe gegevens zoals ze uit de bron zijn opgehaald.
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor de gegevens geldig zijn.
+ token:
+ type: string
+ format: any
+ description: Een eigen validatietoken op de gegevens.
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -3612,7 +3838,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -3624,7 +3850,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -3660,49 +3886,11 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Dossier-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Zaakobjectbericht:
- allOf:
- - $ref: '#/components/schemas/Zaakobject'
- - $ref: '#/components/schemas/Bericht-basis'
- Zaakobject:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort gegevensobject. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc. Referentiedatasoort ZAAKOBJECTSOORT.
- Procesbericht:
+ Dossierbericht:
allOf:
- - $ref: '#/components/schemas/Proces'
+ - $ref: '#/components/schemas/Dossier'
- $ref: '#/components/schemas/Bericht-basis'
- Proces:
+ Dossier:
type: object
properties:
id:
@@ -3724,114 +3912,118 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De omschrijving en definitie van het proces (bijvoorbeeld aanbieden woning). Referentiedatasoort PROCESSOORT.
- bovenliggendProces:
+ description: Geeft het dossier type aan. Bijvoorbeeld mutatiedossier. Referentiedatasoort DOSSIERSOORT.
+ detailSoort:
allOf:
- - $ref: '#/components/schemas/Proces-sleutels'
- description: Specificeert het bijbehorende hoofdproces.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft het dossier detail type aan. Referentiedatasoort DOSSIERDETAILSOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: Beknopte omschrijving van het dossier.
+ bovenliggendDossier:
+ allOf:
+ - $ref: '#/components/schemas/Dossier-sleutels'
+ description: Het dossier waarin dit dossier is opgenomen.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De status van de proces. Bijvoorbeeld;In behandeling, Afgesloten. Referentiedatasoort PROCESSTATUS.
+ description: De fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt (Bijvoorbeeld 'Gearchiveerd'). Referentiedatasoort DOSSIERSTATUS.
begindatum:
type: string
format: date-time
- description: Datum en tijd waarop het proces gestart is.
+ description: De datum waarop het dossier gevormd is.
einddatum:
type: string
format: date-time
- description: Datum en tijd waarop het proces afgesloten is.
- verloopdatum:
+ description: De datum waarop het dossier afgesloten is.
+ archiefActiedatum:
type: string
format: date-time
- description: Datum en tijd waarop het proces afgerond zou moeten zijn.
+ description: De datum waarop het dossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
+ archiefnominatie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Aanduiding of de informatieobjecten binnen het dossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObjecten:
type: array
items:
type: string
format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
- deelprocessen:
- description: Specificeert de bijbehorende deelprocessen.
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
+ contactmomenten:
type: array
items:
- $ref: '#/components/schemas/Proces-sleutels'
- dossiers:
- description: Het proces is gekoppeld aan/heeft betrekking op dossier(s).
+ type: string
+ format: uri
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ deelDossiers:
+ description: Het dossier bevat onderliggende dossier(s).
type: array
items:
$ref: '#/components/schemas/Dossier-sleutels'
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detaillering van de fase waarin het dossier zich vanuit het perspectief van afhandeling en archivering bevindt. Referentiedatasoort DOSSIERDETAILSTATUS.
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
inkoopfacturen:
type: array
items:
type: string
format: uri
- description: Referenties naar Factuur in informatiedomein Financien
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
inkoopopdrachten:
type: array
items:
type: string
format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- niveau:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Specificeert het niveau van het proces. Bijvoorbeeld ketenproces, bedrijfsproces en werkproces. Referentiedatasoort PROCESNIVEAU.
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
objecten:
description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
type: array
items:
- $ref: '#/components/schemas/Zaakobject'
+ $ref: '#/components/schemas/Zaakobject-sleutels'
onderhoudsverzoeken:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- prioriteit:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Prioriteit van het proces. Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
- processtappen:
- description: De taken/stappen die behoren bij het proces.
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ processen:
+ description: Het dossier is gekoppeld aan/heeft betrekking op proces(sen).
type: array
items:
- $ref: '#/components/schemas/Processtap'
+ $ref: '#/components/schemas/Proces-sleutels'
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- rollen:
- description: De rol(len) die een relatie uitoefent ten opzichte van het proces.
- type: array
- items:
- $ref: '#/components/schemas/Procesrol'
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
zaken:
- description: Het proces is gekoppeld aan/heeft betrekking op zaak(-en).
+ description: Zaken die gekoppeld zijn aan dit dossier.
type: array
items:
- $ref: '#/components/schemas/Zaak'
- Proces-sleutels:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Dossier-sleutels:
type: object
properties:
id:
@@ -3850,80 +4042,18 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Processtapbericht:
- allOf:
- - $ref: '#/components/schemas/Processtap'
- - $ref: '#/components/schemas/Bericht-basis'
- Processtap:
+ Zaakobject-sleutels:
type: object
properties:
id:
type: string
format: any
description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De omschrijving en definitie van de processtap. Bijvoorbeeld keur inkoopfactuur goed of controleer huuropzegging. Referentiedatasoort PROCESSTAPSOORT.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de processtap. Bijvoorbeeld;In behandeling, Wachtstand, Afgerond. Referentiedatasoort PROCESSTAPSTATUS.
- begindatum:
- type: string
- format: date-time
- description: Datum en tijd waarop de processtap gestart is.
- einddatum:
- type: string
- format: date-time
- description: Datum en tijd waarop de processtap afgesloten is.
- verloopdatum:
- type: string
- format: date-time
- description: Datum en tijd waarop de processtap afgerond zou moeten zijn.
- actie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Actie die is uitgevoerd. Bijvoorbeeld;Doorsturen, Toewijzen, Stoppen. Referentiedatasoort PROCESSTAPACTIE.
- positie:
- type: integer
- format: int32
- description: De positie van de processtap binnen het proces ten opzichte van andere processtappen.
- prioriteit:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Prioriteit van de processtap Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
- proces:
- allOf:
- - $ref: '#/components/schemas/Proces-sleutels'
- description: Het proces waar de processtap onderdeel van is.
- rollen:
- description: De rol(-len) die een relatie uitoefent ten opzichte van de processtap.
- type: array
- items:
- $ref: '#/components/schemas/Procesrol'
- vorigeProcesstappen:
- description: De processtap(-en) die deze processtap geïnitieerd heeft.
- type: array
- items:
- $ref: '#/components/schemas/Processtap-sleutels'
- Procesrolbericht:
- allOf:
- - $ref: '#/components/schemas/Procesrol'
- - $ref: '#/components/schemas/Bericht-basis'
- Procesrol:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Proces-sleutels:
type: object
properties:
id:
@@ -3942,37 +4072,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
- type: string
- format: any
- description: Een beknopte omschrijving van de aard van de rol.
- begindatum:
- type: string
- format: date-time
- description: Geeft de startdatum van de geldigheid van de rol aan.
- einddatum:
- type: string
- format: date-time
- description: Geeft de einddatum van de geldigheid van de rol aan.
- processen:
- description: De proces(-sen) waar de rol betrekking op heeft.
- type: array
- items:
- $ref: '#/components/schemas/Proces-sleutels'
- processtappen:
- description: De processtap(-pen) waar de rol betrekking op heeft.
- type: array
- items:
- $ref: '#/components/schemas/Processtap-sleutels'
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- toelichtingRol:
- type: string
- format: any
- description: Schriftelijke toelichting bij de rol.
- Processtap-sleutels:
+ Zaak-sleutels:
type: object
properties:
id:
@@ -3991,11 +4091,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Zaakbericht:
+ Informatieobjectbericht:
allOf:
- - $ref: '#/components/schemas/Zaak'
+ - $ref: '#/components/schemas/Informatieobject'
- $ref: '#/components/schemas/Bericht-basis'
- Zaak:
+ Informatieobject:
type: object
properties:
id:
@@ -4014,128 +4114,162 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Specificatie van het documenttype. Bijvoorbeeld verslag, rapport etc. Referentiedatasoort INFORMATIEOBJECTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detail specificatie van het documenttype. Bijvoorbeeld notulen, adviesrapport etc. Referentiedatasoort INFORMATIEOBJECTDETAILSOORT.
+ onderwerp:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Onderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTONDERWERP.
+ subonderwerp:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Subonderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTSUBONDERWERP.
+ titel:
type: string
format: any
- description: Een beknopte omschrijving van de zaak.
- toelichting:
+ description: Titel van het informatieobject.
+ beschrijving:
type: string
format: any
- description: Een beknopte toelichting op de zaak.
- bovenliggendeZaak:
+ description: Beschrijving van het informatieobject.
+ status:
allOf:
- - $ref: '#/components/schemas/Zaak-sleutels'
- description: Specificeert de bijbehorende hoofdzaak.
- begindatum:
- type: string
- format: date-time
- description: De datum waarop met de uitvoering van de zaak gestart is.
- einddatum:
- type: string
- format: date-time
- description: De datum waarop de uitvoering van de zaak afgerond is.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTSTATUS.
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detaillering van de fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTDETAILSTATUS.
registratiedatum:
type: string
format: date-time
- description: De datum waarop de zaakbehandelende organisatie de zaak heeft geregistreerd.
- publicatiedatum:
- type: string
- format: date-time
- description: Datum waarop (het starten van) de zaak gepubliceerd is.
- geplandeEinddatum:
+ description: Registratiedatum van het informatieobject.
+ ontvangstdatum:
type: string
format: date-time
- description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt.
- uiterlijkeEinddatum:
+ description: Ontvangstdatum van het informatieobject.
+ publicatiedatum:
type: string
format: date-time
- description: De datum waarop de zaak uiterlijk dient afgehandeld te zijn.
- archiefstatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De fase waarin het zaakdossier zich vanuit het perspectief van archivering bevindt. Referentiedatasoort ARCHIEFSTATUS.
+ description: Publicatiedatum of verzenddatum van het informatieobject.
archiefActiedatum:
type: string
format: date-time
- description: De datum waarop het gearchiveerde zaakdossier vernietigd dient te worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
+ description: De datum waarop het gearchiveerde informatieobject vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
archiefnominatie:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
+ description: Aanduiding of het informatieobject blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
+ auteur:
+ type: string
+ format: any
+ description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het informatieobject.
+ bestand:
+ type: string
+ format: byte
+ description: De binaire representatie van het informatieobject.
+ bestandsgrootte:
+ type: integer
+ format: int32
+ description: Omvang van het bestand in bytes.
+ bestandslocatie:
+ type: string
+ format: uri
+ description: Een link (URI) naar de binaire representatie van het informatieobject.
+ bestandsnaam:
+ type: string
+ format: any
+ description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd.
+ bijlagen:
+ description: De bijlagen behorend bij het informatieobject.
+ type: array
+ items:
+ $ref: '#/components/schemas/Informatieobject-sleutels'
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObjecten:
type: array
items:
type: string
format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- deelzaken:
- description: Specificeert de bijbehorende deelzaken.
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ dossiers:
+ description: Het informatieobject is gekoppeld aan/heeft betrekking op dossier(s).
type: array
items:
- $ref: '#/components/schemas/Zaak-sleutels'
- dossier:
- allOf:
- - $ref: '#/components/schemas/Dossier-sleutels'
- description: Het dossier dat aan de zaak gekoppeld is.
+ $ref: '#/components/schemas/Dossier-sleutels'
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
- gerelateerdeZaken:
- description: Heeft één of meerdere gerelateerde interne of externe zaken.
- type: array
- items:
- $ref: '#/components/schemas/Zaak-sleutels'
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ externePublicatie:
+ type: boolean
+ description: Aanduiding of dit informatieobject extern gepubliceerd dient te worden.
+ externePublicatietekst:
+ type: string
+ format: any
+ description: Tekstuele omschrijving ten behoeve van externe publicatie van dit informatieobject.
+ formaat:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het digitale formaat (IANA media type) van het informatieobject. Referentiedatasoort INFORMATIEOBJECTFORMAAT.
+ gebruiksrechten:
+ type: string
+ format: any
+ description: Informatie omtrent rechten die geassocieerd zijn met het informatieobject zoals intellectueel eigendom.
inkoopfacturen:
type: array
items:
type: string
format: uri
- description: Referenties naar Factuur in informatiedomein Financien
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
inkoopopdrachten:
type: array
items:
type: string
format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- kenmerken:
- description: Dit zijn eigenschappen behorend bij de zaak.
- type: array
- items:
- $ref: '#/components/schemas/Zaakkenmerk'
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
+ isBijlageVan:
+ allOf:
+ - $ref: '#/components/schemas/Informatieobject-sleutels'
+ description: Geeft aan dat het informatieobject een bijlage is van een ander informatieobject.
objecten:
description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
type: array
items:
- $ref: '#/components/schemas/Zaakobject'
+ $ref: '#/components/schemas/Zaakobject-sleutels'
onderhoudsverzoeken:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
processen:
- description: De zaak is gekoppeld aan/heeft betrekking op proces(sen).
+ description: Het informatieobject is gekoppeld aan/heeft betrekking op proces(sen).
type: array
items:
$ref: '#/components/schemas/Proces-sleutels'
@@ -4144,34 +4278,29 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- resultaatOmschrijving:
- type: string
- format: any
- description: Een beknopte omschrijving van het resultaat van de zaak.
- resultaatToelichting:
- type: string
- format: any
- description: Een beknopte toelichting op het resultaat van de zaak.
- rollen:
- description: De rollen op basis waarvan relaties betrokken zijn bij de zaak.
- type: array
- items:
- $ref: '#/components/schemas/Zaakrol'
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ taal:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De taal waarin het informatieobject is opgesteld. Referentiedatasoort TAAL.
verantwoordelijkeOrganisatie:
type: string
format: any
- description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor de behandeling van de gerelateerde zaak.
- zaakstatussen:
- description: De statussen die bereikt zijn gedurende de behandeling van de zaak.
+ description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor het informatieobject.
+ versie:
+ type: number
+ format: float
+ description: Het versienummer van het informatieobject.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De classificatie van het vertrouwelijkheidsniveau van het informatieobject. Referentiedatasoort VERTROUWELIJKHEID.
+ zaken:
+ description: Het informatieobject is gekoppeld aan/heeft betrekking op zaak(-en).
type: array
items:
- $ref: '#/components/schemas/Zaakstatus'
- zaaktype:
- allOf:
- - $ref: '#/components/schemas/Zaaktype'
- description: Zaaktype duidt de aard van de zaak aan en definieert daarmee de zaak.
- Zaak-sleutels:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Informatieobject-sleutels:
type: object
properties:
id:
@@ -4190,11 +4319,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Zaakkenmerkbericht:
+ Informatieobjectkenmerkbericht:
allOf:
- - $ref: '#/components/schemas/Zaakkenmerk'
+ - $ref: '#/components/schemas/Informatieobjectkenmerk'
- $ref: '#/components/schemas/Bericht-basis'
- Zaakkenmerk:
+ Informatieobjectkenmerk:
type: object
properties:
id:
@@ -4216,11 +4345,11 @@ components:
omschrijving:
type: string
format: any
- description: De omschrijving van het zaakkenmerk.
+ description: De omschrijving van het informatieobject kenmerk.
waarde:
type: string
format: any
- description: De waarde van het zaakkenmerk.
+ description: De waarde van het informatieobject kenmerk.
datatype:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4228,17 +4357,12 @@ components:
groep:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De groep van kenmerken behorend bij het zaakkenmerk. Referentiedatasoort ZAAKKENMERKGROEP.
- zaken:
- description: De zaken behorende bij het zaakkenmerk.
- type: array
- items:
- $ref: '#/components/schemas/Zaak-sleutels'
- Zaakrolbericht:
+ description: De groep van kenmerken behorend bij het informatieobject kenmerk. Referentiedatasoort INFORMATIEOBJECTGROEP.
+ Procesbericht:
allOf:
- - $ref: '#/components/schemas/Zaakrol'
+ - $ref: '#/components/schemas/Proces'
- $ref: '#/components/schemas/Bericht-basis'
- Zaakrol:
+ Proces:
type: object
properties:
id:
@@ -4256,53 +4380,118 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Algemeen gehanteerde benaming van de aard van de rol. Referentiedatasoort ZAAKROL.
- omschrijving:
- type: string
- format: any
- description: Een beknopte omschrijving van de aard van de rol.
+ description: De omschrijving en definitie van het proces (bijvoorbeeld aanbieden woning). Referentiedatasoort PROCESSOORT.
+ bovenliggendProces:
+ allOf:
+ - $ref: '#/components/schemas/Proces-sleutels'
+ description: Specificeert het bijbehorende hoofdproces.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de proces. Bijvoorbeeld;In behandeling, Afgesloten. Referentiedatasoort PROCESSTATUS.
begindatum:
type: string
format: date-time
- description: Geeft de startdatum van de geldigheid van de rol aan.
+ description: Datum en tijd waarop het proces gestart is.
einddatum:
type: string
format: date-time
- description: Geeft de einddatum van de geldigheid van de rol aan.
- afwijkendContactgegegeven:
- type: string
- format: uri
- description: Referentie naar Contactgegeven in informatiedomein Relaties
- indicatieGemachtigde:
- type: boolean
- description: Indicatie of de betrokkene in de rol bij de zaak optreedt als gemachtigde van een andere betrokkene bij die zaak.
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- toelichtingRol:
+ description: Datum en tijd waarop het proces afgesloten is.
+ verloopdatum:
type: string
- format: any
- description: Schriftelijke toelichting bij de rol.
- zaak:
- description: De zaak(-en) waarop de rol betrekking heeft.
+ format: date-time
+ description: Datum en tijd waarop het proces afgerond zou moeten zijn.
+ clusters:
type: array
items:
- $ref: '#/components/schemas/Zaak-sleutels'
- zaakstatussen:
- description: De zaak(-en) statussen waarop de rol betrekking heeft.
+ type: string
+ format: uri
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
+ collectiefObjecten:
type: array
items:
- $ref: '#/components/schemas/Zaakstatus'
- Zaakstatusbericht:
- allOf:
- - $ref: '#/components/schemas/Zaakstatus'
- - $ref: '#/components/schemas/Bericht-basis'
- Zaakstatus:
+ type: string
+ format: uri
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
+ deelprocessen:
+ description: Specificeert de bijbehorende deelprocessen.
+ type: array
+ items:
+ $ref: '#/components/schemas/Proces-sleutels'
+ dossiers:
+ description: Het proces is gekoppeld aan/heeft betrekking op dossier(s).
+ type: array
+ items:
+ $ref: '#/components/schemas/Dossier-sleutels'
+ eenheden:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ inkoopfacturen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
+ inkoopopdrachten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
+ niveau:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Specificeert het niveau van het proces. Bijvoorbeeld ketenproces, bedrijfsproces en werkproces. Referentiedatasoort PROCESNIVEAU.
+ objecten:
+ description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakobject-sleutels'
+ onderhoudsverzoeken:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ prioriteit:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Prioriteit van het proces. Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
+ processtappen:
+ description: De taken/stappen die behoren bij het proces.
+ type: array
+ items:
+ $ref: '#/components/schemas/Processtap-sleutels'
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ rollen:
+ description: De rol(len) die een relatie uitoefent ten opzichte van het proces.
+ type: array
+ items:
+ $ref: '#/components/schemas/Procesrol-sleutels'
+ zaken:
+ description: Het proces is gekoppeld aan/heeft betrekking op zaak(-en).
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Processtap-sleutels:
type: object
properties:
id:
@@ -4321,31 +4510,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De aanduiding van de status middels een statustype. Referentiedatasoort ZAAKSTATUSSOORT.
- begindatum:
- type: string
- format: date-time
- description: Het moment waarop de status is bereikt.
- einddatum:
- type: string
- format: date-time
- description: Het moment waarop de status verlopen is.
- toelichting:
- type: string
- format: any
- description: Toelichting over de status.
- zaak:
- allOf:
- - $ref: '#/components/schemas/Zaak-sleutels'
- description: De zaak waar de status betrekking op heeft.
- zaakrol:
- allOf:
- - $ref: '#/components/schemas/Zaakrol-sleutels'
- description: De rol van de bijbehorende relatie die de zaakstatus gezet heeft.
- Zaakrol-sleutels:
+ Procesrol-sleutels:
type: object
properties:
id:
@@ -4363,12 +4528,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Zaaktypebericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Procesrolbericht:
allOf:
- - $ref: '#/components/schemas/Zaaktype'
+ - $ref: '#/components/schemas/Procesrol'
- $ref: '#/components/schemas/Bericht-basis'
- Zaaktype:
+ Procesrol:
type: object
properties:
id:
@@ -4387,88 +4552,41 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Categorisering van de aard van een zaak van dit zaaktype. Referentiedatasoort ZAAKTYPESOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Specificatie van de categorie ten aanzien van de aard van zaak van het zaaktype. Referentiedatasoort ZAAKTYPEDETAILSOORT.
- generiekeOmschrijving:
- type: string
- format: any
- description: Een beknopte generieke omschrijving van de aard van de zaak en van het zaaktype gerelateerd aan een sectorale ZTC.
omschrijving:
type: string
format: any
- description: Een beknopte omschrijving van de aard van de zaak en van het zaaktype.
+ description: Een beknopte omschrijving van de aard van de rol.
begindatum:
type: string
format: date-time
- description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype bestaat en toegepast kan worden.
+ description: Geeft de startdatum van de geldigheid van de rol aan.
einddatum:
type: string
format: date-time
- description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype niet meer bestaat en niet meer toegepast kan worden.
- aanleiding:
- type: string
- format: any
- description: Een omschrijving van de aanleiding die leidt tot het starten van een zaak van dit zaaktype.
- archiefcode:
- type: string
- format: any
- description: De systematische identificatie van zaakdossiers van dit zaaktype overeenkomstig logisch gestructureerde conventies, methoden en procedureregels.
- doel:
- type: string
- format: any
- description: Een omschrijving van het doel
- domein:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het domein waarbinnen het zaaktype is uitgewerkt. Referentiedatasoort ZAAKTYPEDOMEIN.
- doorlooptijd:
- type: integer
- format: int32
- description: De periode waarbinnen een zaak van dit zaaktype afgerond dient te zijn.
- externePublicatie:
- type: boolean
- description: Aanduiding of (het starten van) een zaak van dit zaaktype gepubliceerd moet worden.
- externePublicatietekst:
- type: string
- format: any
- description: De generieke tekst ten behoeve van de publicatie van een zaak van dit zaaktype.
+ description: Geeft de einddatum van de geldigheid van de rol aan.
+ processen:
+ description: De proces(-sen) waar de rol betrekking op heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Proces-sleutels'
+ processtappen:
+ description: De processtap(-pen) waar de rol betrekking op heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Processtap-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- servicenorm:
- type: integer
- format: int32
- description: De periode waarbinnen verwacht wordt dat een zaak van dit zaaktype afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie.
- trefwoord:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ toelichtingRol:
type: string
format: any
- description: Een trefwoord waarmee een zaak van dit zaaktype kan worden gekarakteriseerd.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding van de mate waarin zaakdossiers van een zaak van dit zaaktype voor de openbaarheid bestemd zijn. Referentiedatasoort VERTROUWELIJKHEID.
- zaakstatussen:
- description: De statussen die bereikt kunnen worden bij behandeling van een zaak van dit zaaktype.
- type: array
- items:
- $ref: '#/components/schemas/Zaakstatus'
- zaken:
- description: De aanwezige/betreffende zaken van dit zaaktype.
- type: array
- items:
- $ref: '#/components/schemas/Zaak-sleutels'
- Informatieobjectbericht:
+ description: Schriftelijke toelichting bij de rol.
+ Processtapbericht:
allOf:
- - $ref: '#/components/schemas/Informatieobject'
+ - $ref: '#/components/schemas/Processtap'
- $ref: '#/components/schemas/Bericht-basis'
- Informatieobject:
+ Processtap:
type: object
properties:
id:
@@ -4490,190 +4608,230 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Specificatie van het documenttype. Bijvoorbeeld verslag, rapport etc. Referentiedatasoort INFORMATIEOBJECTSOORT.
- detailSoort:
+ description: De omschrijving en definitie van de processtap. Bijvoorbeeld keur inkoopfactuur goed of controleer huuropzegging. Referentiedatasoort PROCESSTAPSOORT.
+ status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Detail specificatie van het documenttype. Bijvoorbeeld notulen, adviesrapport etc. Referentiedatasoort INFORMATIEOBJECTDETAILSOORT.
- onderwerp:
+ description: Status van de processtap. Bijvoorbeeld;In behandeling, Wachtstand, Afgerond. Referentiedatasoort PROCESSTAPSTATUS.
+ begindatum:
+ type: string
+ format: date-time
+ description: Datum en tijd waarop de processtap gestart is.
+ einddatum:
+ type: string
+ format: date-time
+ description: Datum en tijd waarop de processtap afgesloten is.
+ verloopdatum:
+ type: string
+ format: date-time
+ description: Datum en tijd waarop de processtap afgerond zou moeten zijn.
+ actie:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Onderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTONDERWERP.
- subonderwerp:
+ description: Actie die is uitgevoerd. Bijvoorbeeld;Doorsturen, Toewijzen, Stoppen. Referentiedatasoort PROCESSTAPACTIE.
+ positie:
+ type: integer
+ format: int32
+ description: De positie van de processtap binnen het proces ten opzichte van andere processtappen.
+ prioriteit:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Subonderwerp van het informatieobject. Referentiedatasoort INFORMATIEOBJECTSUBONDERWERP.
- titel:
+ description: Prioriteit van de processtap Bijvoorbeeld;Hoog, Middel, Laag. Referentiedatasoort PRIORITEIT.
+ proces:
+ allOf:
+ - $ref: '#/components/schemas/Proces-sleutels'
+ description: Het proces waar de processtap onderdeel van is.
+ rollen:
+ description: De rol(-len) die een relatie uitoefent ten opzichte van de processtap.
+ type: array
+ items:
+ $ref: '#/components/schemas/Procesrol-sleutels'
+ vorigeProcesstappen:
+ description: De processtap(-en) die deze processtap geïnitieerd heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Processtap-sleutels'
+ Zaakbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaak'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaak:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Titel van het informatieobject.
- beschrijving:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: Beschrijving van het informatieobject.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTSTATUS.
- detailStatus:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ omschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van de zaak.
+ toelichting:
+ type: string
+ format: any
+ description: Een beknopte toelichting op de zaak.
+ bovenliggendeZaak:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Detaillering van de fase waarin het informatieobject zich vanuit het perspectief van archivering bevindt. Referentiedatasoort INFORMATIEOBJECTDETAILSTATUS.
- registratiedatum:
+ - $ref: '#/components/schemas/Zaak-sleutels'
+ description: Specificeert de bijbehorende hoofdzaak.
+ begindatum:
type: string
format: date-time
- description: Registratiedatum van het informatieobject.
- ontvangstdatum:
+ description: De datum waarop met de uitvoering van de zaak gestart is.
+ einddatum:
type: string
format: date-time
- description: Ontvangstdatum van het informatieobject.
+ description: De datum waarop de uitvoering van de zaak afgerond is.
+ registratiedatum:
+ type: string
+ format: date-time
+ description: De datum waarop de zaakbehandelende organisatie de zaak heeft geregistreerd.
publicatiedatum:
type: string
format: date-time
- description: Publicatiedatum of verzenddatum van het informatieobject.
+ description: Datum waarop (het starten van) de zaak gepubliceerd is.
+ geplandeEinddatum:
+ type: string
+ format: date-time
+ description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt.
+ uiterlijkeEinddatum:
+ type: string
+ format: date-time
+ description: De datum waarop de zaak uiterlijk dient afgehandeld te zijn.
+ archiefstatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De fase waarin het zaakdossier zich vanuit het perspectief van archivering bevindt. Referentiedatasoort ARCHIEFSTATUS.
archiefActiedatum:
type: string
format: date-time
- description: De datum waarop het gearchiveerde informatieobject vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
+ description: De datum waarop het gearchiveerde zaakdossier vernietigd dient te worden dan wel overgebracht moet worden naar een archiefbewaarplaats.
archiefnominatie:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Aanduiding of het informatieobject blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
- auteur:
- type: string
- format: any
- description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het informatieobject.
- bestand:
- type: string
- format: byte
- description: De binaire representatie van het informatieobject.
- bestandsgrootte:
- type: integer
- format: int32
- description: Omvang van het bestand in bytes.
- bestandslocatie:
- type: string
- format: uri
- description: Een link (URI) naar de binaire representatie van het informatieobject.
- bestandsnaam:
- type: string
- format: any
- description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd.
- bijlagen:
- description: De bijlagen behorend bij het informatieobject.
- type: array
- items:
- $ref: '#/components/schemas/Informatieobject-sleutels'
+ description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Referentiedatasoort ARCHIEFNOMINATIE.
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObjecten:
type: array
items:
type: string
format: uri
- description: Referenties naar CollectiefObject in informatiedomein Vastgoed
+ description: Referenties naar CollectiefObject-sleutels in informatiedomein Vastgoed
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- dossiers:
- description: Het informatieobject is gekoppeld aan/heeft betrekking op dossier(s).
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ deelzaken:
+ description: Specificeert de bijbehorende deelzaken.
type: array
items:
- $ref: '#/components/schemas/Dossier'
+ $ref: '#/components/schemas/Zaak-sleutels'
+ dossier:
+ allOf:
+ - $ref: '#/components/schemas/Dossier-sleutels'
+ description: Het dossier dat aan de zaak gekoppeld is.
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
- externePublicatie:
- type: boolean
- description: Aanduiding of dit informatieobject extern gepubliceerd dient te worden.
- externePublicatietekst:
- type: string
- format: any
- description: Tekstuele omschrijving ten behoeve van externe publicatie van dit informatieobject.
- formaat:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het digitale formaat (IANA media type) van het informatieobject. Referentiedatasoort INFORMATIEOBJECTFORMAAT.
- gebruiksrechten:
- type: string
- format: any
- description: Informatie omtrent rechten die geassocieerd zijn met het informatieobject zoals intellectueel eigendom.
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ gerelateerdeZaken:
+ description: Heeft één of meerdere gerelateerde interne of externe zaken.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
inkoopfacturen:
type: array
items:
type: string
format: uri
- description: Referenties naar Factuur in informatiedomein Financien
+ description: Referenties naar Inkoopfactuur-sleutels in informatiedomein Financien
inkoopopdrachten:
type: array
items:
type: string
format: uri
- description: Referenties naar Inkoopopdracht in informatiedomein Financien
- isBijlageVan:
- allOf:
- - $ref: '#/components/schemas/Informatieobject-sleutels'
- description: Geeft aan dat het informatieobject een bijlage is van een ander informatieobject.
+ description: Referenties naar Inkoopopdracht-sleutels in informatiedomein Financien
+ kenmerken:
+ description: Dit zijn eigenschappen behorend bij de zaak.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakkenmerk-sleutels'
objecten:
description: De gegevensobjecten die bij de zaak horen. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc.
type: array
items:
- $ref: '#/components/schemas/Zaakobject'
+ $ref: '#/components/schemas/Zaakobject-sleutels'
onderhoudsverzoeken:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
processen:
- description: Het informatieobject is gekoppeld aan/heeft betrekking op proces(sen).
+ description: De zaak is gekoppeld aan/heeft betrekking op proces(sen).
type: array
items:
- $ref: '#/components/schemas/Proces'
+ $ref: '#/components/schemas/Proces-sleutels'
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- taal:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De taal waarin het informatieobject is opgesteld. Referentiedatasoort TAAL.
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ resultaatOmschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van het resultaat van de zaak.
+ resultaatToelichting:
+ type: string
+ format: any
+ description: Een beknopte toelichting op het resultaat van de zaak.
+ rollen:
+ description: De rollen op basis waarvan relaties betrokken zijn bij de zaak.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakrol-sleutels'
verantwoordelijkeOrganisatie:
type: string
format: any
- description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor het informatieobject.
- versie:
- type: number
- format: float
- description: Het versienummer van het informatieobject.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De classificatie van het vertrouwelijkheidsniveau van het informatieobject. Referentiedatasoort VERTROUWELIJKHEID.
- zaken:
- description: Het informatieobject is gekoppeld aan/heeft betrekking op zaak(-en).
+ description: Het RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) van de organisatie die verantwoordelijk is voor de behandeling van de gerelateerde zaak.
+ zaakstatussen:
+ description: De statussen die bereikt zijn gedurende de behandeling van de zaak.
type: array
items:
- $ref: '#/components/schemas/Zaak'
- Informatieobject-sleutels:
+ $ref: '#/components/schemas/Zaakstatus-sleutels'
+ zaaktype:
+ allOf:
+ - $ref: '#/components/schemas/Zaaktype-sleutels'
+ description: Zaaktype duidt de aard van de zaak aan en definieert daarmee de zaak.
+ Zaakkenmerk-sleutels:
type: object
properties:
id:
@@ -4692,11 +4850,68 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Informatieobjectkenmerkbericht:
+ Zaakrol-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Zaakstatus-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Zaaktype-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Zaakkenmerkbericht:
allOf:
- - $ref: '#/components/schemas/Informatieobjectkenmerk'
+ - $ref: '#/components/schemas/Zaakkenmerk'
- $ref: '#/components/schemas/Bericht-basis'
- Informatieobjectkenmerk:
+ Zaakkenmerk:
type: object
properties:
id:
@@ -4718,11 +4933,11 @@ components:
omschrijving:
type: string
format: any
- description: De omschrijving van het informatieobject kenmerk.
+ description: De omschrijving van het zaakkenmerk.
waarde:
type: string
format: any
- description: De waarde van het informatieobject kenmerk.
+ description: De waarde van het zaakkenmerk.
datatype:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4730,7 +4945,242 @@ components:
groep:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De groep van kenmerken behorend bij het informatieobject kenmerk. Referentiedatasoort INFORMATIEOBJECTGROEP.
+ description: De groep van kenmerken behorend bij het zaakkenmerk. Referentiedatasoort ZAAKKENMERKGROEP.
+ zaken:
+ description: De zaken behorende bij het zaakkenmerk.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ Zaakobjectbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaakobject'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaakobject:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort gegevensobject. Kan iedere klasse uit ons model zijn. Bijv. Overeenkomst, Onderhoudsverzoek etc. Referentiedatasoort ZAAKOBJECTSOORT.
+ Zaakrolbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaakrol'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaakrol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Algemeen gehanteerde benaming van de aard van de rol. Referentiedatasoort ZAAKROL.
+ omschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van de aard van de rol.
+ begindatum:
+ type: string
+ format: date-time
+ description: Geeft de startdatum van de geldigheid van de rol aan.
+ einddatum:
+ type: string
+ format: date-time
+ description: Geeft de einddatum van de geldigheid van de rol aan.
+ afwijkendContactgegegeven:
+ type: string
+ format: uri
+ description: Referentie naar Contactgegeven-sleutels in informatiedomein Relaties
+ indicatieGemachtigde:
+ type: boolean
+ description: Indicatie of de betrokkene in de rol bij de zaak optreedt als gemachtigde van een andere betrokkene bij die zaak.
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ toelichtingRol:
+ type: string
+ format: any
+ description: Schriftelijke toelichting bij de rol.
+ zaak:
+ description: De zaak(-en) waarop de rol betrekking heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
+ zaakstatussen:
+ description: De zaak(-en) statussen waarop de rol betrekking heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakstatus-sleutels'
+ Zaakstatusbericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaakstatus'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaakstatus:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De aanduiding van de status middels een statustype. Referentiedatasoort ZAAKSTATUSSOORT.
+ begindatum:
+ type: string
+ format: date-time
+ description: Het moment waarop de status is bereikt.
+ einddatum:
+ type: string
+ format: date-time
+ description: Het moment waarop de status verlopen is.
+ toelichting:
+ type: string
+ format: any
+ description: Toelichting over de status.
+ zaak:
+ allOf:
+ - $ref: '#/components/schemas/Zaak-sleutels'
+ description: De zaak waar de status betrekking op heeft.
+ zaakrol:
+ allOf:
+ - $ref: '#/components/schemas/Zaakrol-sleutels'
+ description: De rol van de bijbehorende relatie die de zaakstatus gezet heeft.
+ Zaaktypebericht:
+ allOf:
+ - $ref: '#/components/schemas/Zaaktype'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Zaaktype:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Categorisering van de aard van een zaak van dit zaaktype. Referentiedatasoort ZAAKTYPESOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Specificatie van de categorie ten aanzien van de aard van zaak van het zaaktype. Referentiedatasoort ZAAKTYPEDETAILSOORT.
+ generiekeOmschrijving:
+ type: string
+ format: any
+ description: Een beknopte generieke omschrijving van de aard van de zaak en van het zaaktype gerelateerd aan een sectorale ZTC.
+ omschrijving:
+ type: string
+ format: any
+ description: Een beknopte omschrijving van de aard van de zaak en van het zaaktype.
+ begindatum:
+ type: string
+ format: date-time
+ description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype bestaat en toegepast kan worden.
+ einddatum:
+ type: string
+ format: date-time
+ description: Met deze datum wordt aangegeven vanaf wanneer het zaaktype niet meer bestaat en niet meer toegepast kan worden.
+ aanleiding:
+ type: string
+ format: any
+ description: Een omschrijving van de aanleiding die leidt tot het starten van een zaak van dit zaaktype.
+ archiefcode:
+ type: string
+ format: any
+ description: De systematische identificatie van zaakdossiers van dit zaaktype overeenkomstig logisch gestructureerde conventies, methoden en procedureregels.
+ doel:
+ type: string
+ format: any
+ description: Een omschrijving van het doel
+ domein:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het domein waarbinnen het zaaktype is uitgewerkt. Referentiedatasoort ZAAKTYPEDOMEIN.
+ doorlooptijd:
+ type: integer
+ format: int32
+ description: De periode waarbinnen een zaak van dit zaaktype afgerond dient te zijn.
+ externePublicatie:
+ type: boolean
+ description: Aanduiding of (het starten van) een zaak van dit zaaktype gepubliceerd moet worden.
+ externePublicatietekst:
+ type: string
+ format: any
+ description: De generieke tekst ten behoeve van de publicatie van een zaak van dit zaaktype.
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ servicenorm:
+ type: integer
+ format: int32
+ description: De periode waarbinnen verwacht wordt dat een zaak van dit zaaktype afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie.
+ trefwoord:
+ type: string
+ format: any
+ description: Een trefwoord waarmee een zaak van dit zaaktype kan worden gekarakteriseerd.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Aanduiding van de mate waarin zaakdossiers van een zaak van dit zaaktype voor de openbaarheid bestemd zijn. Referentiedatasoort VERTROUWELIJKHEID.
+ zaakstatussen:
+ description: De statussen die bereikt kunnen worden bij behandeling van een zaak van dit zaaktype.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaakstatus-sleutels'
+ zaken:
+ description: De aanwezige/betreffende zaken van dit zaaktype.
+ type: array
+ items:
+ $ref: '#/components/schemas/Zaak-sleutels'
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Financien.yaml b/docs/Informatiedomeinen/Financien.yaml
index 34d9e57..403e877 100644
--- a/docs/Informatiedomeinen/Financien.yaml
+++ b/docs/Informatiedomeinen/Financien.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://financien.vera.io:{port}/{basePath}
description: Productieserver
@@ -103,7 +103,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -119,7 +119,7 @@ paths:
get:
tags:
- 'Aanbestedingen'
- description: Ophalen van Aanbestedingen
+ summary: Ophalen van Aanbestedingen
operationId: listAanbestedingen
parameters:
- name: params
@@ -169,7 +169,7 @@ paths:
post:
tags:
- 'Aanbestedingen'
- description: Voegt een nieuw(e) Aanbesteding toe.
+ summary: Voegt een nieuw(e) Aanbesteding toe.
operationId: createAanbesteding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -209,7 +209,7 @@ paths:
put:
tags:
- 'Aanbestedingen'
- description: |
+ summary: |
Vervangen van een Aanbesteding op basis van overeenkomstige sleutelvelden.
operationId: replaceAanbesteding
parameters:
@@ -244,7 +244,7 @@ paths:
patch:
tags:
- 'Aanbestedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aanbesteding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAanbesteding
@@ -281,7 +281,7 @@ paths:
get:
tags:
- 'Aanbestedingen'
- description: Retourneert een Aanbesteding met de gegeven identifier
+ summary: Retourneert een Aanbesteding met de gegeven identifier
operationId: readAanbestedingById
parameters:
- name: id
@@ -318,7 +318,7 @@ paths:
put:
tags:
- 'Aanbestedingen'
- description: Vervangen van een Aanbesteding
+ summary: Vervangen van een Aanbesteding
operationId: replaceAanbestedingById
parameters:
- name: 'id'
@@ -356,7 +356,7 @@ paths:
patch:
tags:
- 'Aanbestedingen'
- description: Wijzigen van een Aanbesteding
+ summary: Wijzigen van een Aanbesteding
operationId: updateAanbestedingById
parameters:
- name: 'id'
@@ -395,7 +395,7 @@ paths:
get:
tags:
- 'Afletteringen'
- description: Ophalen van Afletteringen
+ summary: Ophalen van Afletteringen
operationId: listAfletteringen
parameters:
- name: params
@@ -445,7 +445,7 @@ paths:
post:
tags:
- 'Afletteringen'
- description: Voegt een nieuw(e) Aflettering toe.
+ summary: Voegt een nieuw(e) Aflettering toe.
operationId: createAflettering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -485,7 +485,7 @@ paths:
put:
tags:
- 'Afletteringen'
- description: |
+ summary: |
Vervangen van een Aflettering op basis van overeenkomstige sleutelvelden.
operationId: replaceAflettering
parameters:
@@ -520,7 +520,7 @@ paths:
patch:
tags:
- 'Afletteringen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aflettering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAflettering
@@ -557,7 +557,7 @@ paths:
get:
tags:
- 'Afletteringen'
- description: Retourneert een Aflettering met de gegeven identifier
+ summary: Retourneert een Aflettering met de gegeven identifier
operationId: readAfletteringById
parameters:
- name: id
@@ -594,7 +594,7 @@ paths:
put:
tags:
- 'Afletteringen'
- description: Vervangen van een Aflettering
+ summary: Vervangen van een Aflettering
operationId: replaceAfletteringById
parameters:
- name: 'id'
@@ -632,7 +632,7 @@ paths:
patch:
tags:
- 'Afletteringen'
- description: Wijzigen van een Aflettering
+ summary: Wijzigen van een Aflettering
operationId: updateAfletteringById
parameters:
- name: 'id'
@@ -671,7 +671,7 @@ paths:
get:
tags:
- 'Bankafschriften'
- description: Ophalen van Bankafschriften
+ summary: Ophalen van Bankafschriften
operationId: listBankafschriften
parameters:
- name: params
@@ -721,7 +721,7 @@ paths:
post:
tags:
- 'Bankafschriften'
- description: Voegt een nieuw(e) Bankafschrift toe.
+ summary: Voegt een nieuw(e) Bankafschrift toe.
operationId: createBankafschrift
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -761,7 +761,7 @@ paths:
put:
tags:
- 'Bankafschriften'
- description: |
+ summary: |
Vervangen van een Bankafschrift op basis van overeenkomstige sleutelvelden.
operationId: replaceBankafschrift
parameters:
@@ -796,7 +796,7 @@ paths:
patch:
tags:
- 'Bankafschriften'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Bankafschrift. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBankafschrift
@@ -833,7 +833,7 @@ paths:
get:
tags:
- 'Bankafschriften'
- description: Retourneert een Bankafschrift met de gegeven identifier
+ summary: Retourneert een Bankafschrift met de gegeven identifier
operationId: readBankafschriftById
parameters:
- name: id
@@ -870,7 +870,7 @@ paths:
put:
tags:
- 'Bankafschriften'
- description: Vervangen van een Bankafschrift
+ summary: Vervangen van een Bankafschrift
operationId: replaceBankafschriftById
parameters:
- name: 'id'
@@ -908,7 +908,7 @@ paths:
patch:
tags:
- 'Bankafschriften'
- description: Wijzigen van een Bankafschrift
+ summary: Wijzigen van een Bankafschrift
operationId: updateBankafschriftById
parameters:
- name: 'id'
@@ -947,7 +947,7 @@ paths:
get:
tags:
- 'BankafschriftRegels'
- description: Ophalen van BankafschriftRegels
+ summary: Ophalen van BankafschriftRegels
operationId: listBankafschriftRegels
parameters:
- name: params
@@ -997,7 +997,7 @@ paths:
post:
tags:
- 'BankafschriftRegels'
- description: Voegt een nieuw(e) BankafschriftRegel toe.
+ summary: Voegt een nieuw(e) BankafschriftRegel toe.
operationId: createBankafschriftRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1037,7 +1037,7 @@ paths:
put:
tags:
- 'BankafschriftRegels'
- description: |
+ summary: |
Vervangen van een BankafschriftRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceBankafschriftRegel
parameters:
@@ -1072,7 +1072,7 @@ paths:
patch:
tags:
- 'BankafschriftRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BankafschriftRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBankafschriftRegel
@@ -1109,7 +1109,7 @@ paths:
get:
tags:
- 'BankafschriftRegels'
- description: Retourneert een BankafschriftRegel met de gegeven identifier
+ summary: Retourneert een BankafschriftRegel met de gegeven identifier
operationId: readBankafschriftRegelById
parameters:
- name: id
@@ -1146,7 +1146,7 @@ paths:
put:
tags:
- 'BankafschriftRegels'
- description: Vervangen van een BankafschriftRegel
+ summary: Vervangen van een BankafschriftRegel
operationId: replaceBankafschriftRegelById
parameters:
- name: 'id'
@@ -1184,7 +1184,7 @@ paths:
patch:
tags:
- 'BankafschriftRegels'
- description: Wijzigen van een BankafschriftRegel
+ summary: Wijzigen van een BankafschriftRegel
operationId: updateBankafschriftRegelById
parameters:
- name: 'id'
@@ -1223,7 +1223,7 @@ paths:
get:
tags:
- 'Begrotingen'
- description: Ophalen van Begrotingen
+ summary: Ophalen van Begrotingen
operationId: listBegrotingen
parameters:
- name: params
@@ -1273,7 +1273,7 @@ paths:
post:
tags:
- 'Begrotingen'
- description: Voegt een nieuw(e) Begroting toe.
+ summary: Voegt een nieuw(e) Begroting toe.
operationId: createBegroting
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1313,7 +1313,7 @@ paths:
put:
tags:
- 'Begrotingen'
- description: |
+ summary: |
Vervangen van een Begroting op basis van overeenkomstige sleutelvelden.
operationId: replaceBegroting
parameters:
@@ -1348,7 +1348,7 @@ paths:
patch:
tags:
- 'Begrotingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Begroting. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBegroting
@@ -1385,7 +1385,7 @@ paths:
get:
tags:
- 'Begrotingen'
- description: Retourneert een Begroting met de gegeven identifier
+ summary: Retourneert een Begroting met de gegeven identifier
operationId: readBegrotingById
parameters:
- name: id
@@ -1422,7 +1422,7 @@ paths:
put:
tags:
- 'Begrotingen'
- description: Vervangen van een Begroting
+ summary: Vervangen van een Begroting
operationId: replaceBegrotingById
parameters:
- name: 'id'
@@ -1460,7 +1460,7 @@ paths:
patch:
tags:
- 'Begrotingen'
- description: Wijzigen van een Begroting
+ summary: Wijzigen van een Begroting
operationId: updateBegrotingById
parameters:
- name: 'id'
@@ -1499,7 +1499,7 @@ paths:
get:
tags:
- 'Betaalopdrachten'
- description: Ophalen van Betaalopdrachten
+ summary: Ophalen van Betaalopdrachten
operationId: listBetaalopdrachten
parameters:
- name: params
@@ -1549,7 +1549,7 @@ paths:
post:
tags:
- 'Betaalopdrachten'
- description: Voegt een nieuw(e) Betaalopdracht toe.
+ summary: Voegt een nieuw(e) Betaalopdracht toe.
operationId: createBetaalopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1589,7 +1589,7 @@ paths:
put:
tags:
- 'Betaalopdrachten'
- description: |
+ summary: |
Vervangen van een Betaalopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalopdracht
parameters:
@@ -1624,7 +1624,7 @@ paths:
patch:
tags:
- 'Betaalopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalopdracht
@@ -1661,7 +1661,7 @@ paths:
get:
tags:
- 'Betaalopdrachten'
- description: Retourneert een Betaalopdracht met de gegeven identifier
+ summary: Retourneert een Betaalopdracht met de gegeven identifier
operationId: readBetaalopdrachtById
parameters:
- name: id
@@ -1698,7 +1698,7 @@ paths:
put:
tags:
- 'Betaalopdrachten'
- description: Vervangen van een Betaalopdracht
+ summary: Vervangen van een Betaalopdracht
operationId: replaceBetaalopdrachtById
parameters:
- name: 'id'
@@ -1736,7 +1736,7 @@ paths:
patch:
tags:
- 'Betaalopdrachten'
- description: Wijzigen van een Betaalopdracht
+ summary: Wijzigen van een Betaalopdracht
operationId: updateBetaalopdrachtById
parameters:
- name: 'id'
@@ -1775,7 +1775,7 @@ paths:
get:
tags:
- 'Betaalwijzen'
- description: Ophalen van Betaalwijzen
+ summary: Ophalen van Betaalwijzen
operationId: listBetaalwijzen
parameters:
- name: params
@@ -1825,7 +1825,7 @@ paths:
post:
tags:
- 'Betaalwijzen'
- description: Voegt een nieuw(e) Betaalwijze toe.
+ summary: Voegt een nieuw(e) Betaalwijze toe.
operationId: createBetaalwijze
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1865,7 +1865,7 @@ paths:
put:
tags:
- 'Betaalwijzen'
- description: |
+ summary: |
Vervangen van een Betaalwijze op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalwijze
parameters:
@@ -1900,7 +1900,7 @@ paths:
patch:
tags:
- 'Betaalwijzen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalwijze. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalwijze
@@ -1937,7 +1937,7 @@ paths:
get:
tags:
- 'Betaalwijzen'
- description: Retourneert een Betaalwijze met de gegeven identifier
+ summary: Retourneert een Betaalwijze met de gegeven identifier
operationId: readBetaalwijzeById
parameters:
- name: id
@@ -1974,7 +1974,7 @@ paths:
put:
tags:
- 'Betaalwijzen'
- description: Vervangen van een Betaalwijze
+ summary: Vervangen van een Betaalwijze
operationId: replaceBetaalwijzeById
parameters:
- name: 'id'
@@ -2012,7 +2012,7 @@ paths:
patch:
tags:
- 'Betaalwijzen'
- description: Wijzigen van een Betaalwijze
+ summary: Wijzigen van een Betaalwijze
operationId: updateBetaalwijzeById
parameters:
- name: 'id'
@@ -2051,7 +2051,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Ophalen van Betalingsregelingen
+ summary: Ophalen van Betalingsregelingen
operationId: listBetalingsregelingen
parameters:
- name: params
@@ -2101,7 +2101,7 @@ paths:
post:
tags:
- 'Betalingsregelingen'
- description: Voegt een nieuw(e) Betalingsregeling toe.
+ summary: Voegt een nieuw(e) Betalingsregeling toe.
operationId: createBetalingsregeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2141,7 +2141,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Vervangen van een Betalingsregeling op basis van overeenkomstige sleutelvelden.
operationId: replaceBetalingsregeling
parameters:
@@ -2176,7 +2176,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betalingsregeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetalingsregeling
@@ -2213,7 +2213,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Retourneert een Betalingsregeling met de gegeven identifier
+ summary: Retourneert een Betalingsregeling met de gegeven identifier
operationId: readBetalingsregelingById
parameters:
- name: id
@@ -2250,7 +2250,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: Vervangen van een Betalingsregeling
+ summary: Vervangen van een Betalingsregeling
operationId: replaceBetalingsregelingById
parameters:
- name: 'id'
@@ -2288,7 +2288,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: Wijzigen van een Betalingsregeling
+ summary: Wijzigen van een Betalingsregeling
operationId: updateBetalingsregelingById
parameters:
- name: 'id'
@@ -2327,7 +2327,7 @@ paths:
get:
tags:
- 'BetalingsregelingTermijnen'
- description: Ophalen van BetalingsregelingTermijnen
+ summary: Ophalen van BetalingsregelingTermijnen
operationId: listBetalingsregelingTermijnen
parameters:
- name: params
@@ -2377,7 +2377,7 @@ paths:
post:
tags:
- 'BetalingsregelingTermijnen'
- description: Voegt een nieuw(e) BetalingsregelingTermijn toe.
+ summary: Voegt een nieuw(e) BetalingsregelingTermijn toe.
operationId: createBetalingsregelingTermijn
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2417,7 +2417,7 @@ paths:
put:
tags:
- 'BetalingsregelingTermijnen'
- description: |
+ summary: |
Vervangen van een BetalingsregelingTermijn op basis van overeenkomstige sleutelvelden.
operationId: replaceBetalingsregelingTermijn
parameters:
@@ -2452,7 +2452,7 @@ paths:
patch:
tags:
- 'BetalingsregelingTermijnen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BetalingsregelingTermijn. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetalingsregelingTermijn
@@ -2489,7 +2489,7 @@ paths:
get:
tags:
- 'BetalingsregelingTermijnen'
- description: Retourneert een BetalingsregelingTermijn met de gegeven identifier
+ summary: Retourneert een BetalingsregelingTermijn met de gegeven identifier
operationId: readBetalingsregelingTermijnById
parameters:
- name: id
@@ -2526,7 +2526,7 @@ paths:
put:
tags:
- 'BetalingsregelingTermijnen'
- description: Vervangen van een BetalingsregelingTermijn
+ summary: Vervangen van een BetalingsregelingTermijn
operationId: replaceBetalingsregelingTermijnById
parameters:
- name: 'id'
@@ -2564,7 +2564,7 @@ paths:
patch:
tags:
- 'BetalingsregelingTermijnen'
- description: Wijzigen van een BetalingsregelingTermijn
+ summary: Wijzigen van een BetalingsregelingTermijn
operationId: updateBetalingsregelingTermijnById
parameters:
- name: 'id'
@@ -2603,7 +2603,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Ophalen van Boekingen
+ summary: Ophalen van Boekingen
operationId: listBoekingen
parameters:
- name: params
@@ -2653,7 +2653,7 @@ paths:
post:
tags:
- 'Boekingen'
- description: Voegt een nieuw(e) Boeking toe.
+ summary: Voegt een nieuw(e) Boeking toe.
operationId: createBoeking
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2693,7 +2693,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: |
+ summary: |
Vervangen van een Boeking op basis van overeenkomstige sleutelvelden.
operationId: replaceBoeking
parameters:
@@ -2728,7 +2728,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boeking. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoeking
@@ -2765,7 +2765,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Retourneert een Boeking met de gegeven identifier
+ summary: Retourneert een Boeking met de gegeven identifier
operationId: readBoekingById
parameters:
- name: id
@@ -2802,7 +2802,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: Vervangen van een Boeking
+ summary: Vervangen van een Boeking
operationId: replaceBoekingById
parameters:
- name: 'id'
@@ -2840,7 +2840,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: Wijzigen van een Boeking
+ summary: Wijzigen van een Boeking
operationId: updateBoekingById
parameters:
- name: 'id'
@@ -2879,7 +2879,7 @@ paths:
get:
tags:
- 'Boekingdetails'
- description: Ophalen van Boekingdetails
+ summary: Ophalen van Boekingdetails
operationId: listBoekingdetails
parameters:
- name: params
@@ -2929,7 +2929,7 @@ paths:
post:
tags:
- 'Boekingdetails'
- description: Voegt een nieuw(e) Boekingdetail toe.
+ summary: Voegt een nieuw(e) Boekingdetail toe.
operationId: createBoekingdetail
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2969,7 +2969,7 @@ paths:
put:
tags:
- 'Boekingdetails'
- description: |
+ summary: |
Vervangen van een Boekingdetail op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekingdetail
parameters:
@@ -3004,7 +3004,7 @@ paths:
patch:
tags:
- 'Boekingdetails'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boekingdetail. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekingdetail
@@ -3041,7 +3041,7 @@ paths:
get:
tags:
- 'Boekingdetails'
- description: Retourneert een Boekingdetail met de gegeven identifier
+ summary: Retourneert een Boekingdetail met de gegeven identifier
operationId: readBoekingdetailById
parameters:
- name: id
@@ -3078,7 +3078,7 @@ paths:
put:
tags:
- 'Boekingdetails'
- description: Vervangen van een Boekingdetail
+ summary: Vervangen van een Boekingdetail
operationId: replaceBoekingdetailById
parameters:
- name: 'id'
@@ -3116,7 +3116,7 @@ paths:
patch:
tags:
- 'Boekingdetails'
- description: Wijzigen van een Boekingdetail
+ summary: Wijzigen van een Boekingdetail
operationId: updateBoekingdetailById
parameters:
- name: 'id'
@@ -3155,7 +3155,7 @@ paths:
get:
tags:
- 'Boekjaren'
- description: Ophalen van Boekjaren
+ summary: Ophalen van Boekjaren
operationId: listBoekjaren
parameters:
- name: params
@@ -3205,7 +3205,7 @@ paths:
post:
tags:
- 'Boekjaren'
- description: Voegt een nieuw(e) Boekjaar toe.
+ summary: Voegt een nieuw(e) Boekjaar toe.
operationId: createBoekjaar
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3245,7 +3245,7 @@ paths:
put:
tags:
- 'Boekjaren'
- description: |
+ summary: |
Vervangen van een Boekjaar op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekjaar
parameters:
@@ -3280,7 +3280,7 @@ paths:
patch:
tags:
- 'Boekjaren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boekjaar. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekjaar
@@ -3317,7 +3317,7 @@ paths:
get:
tags:
- 'Boekjaren'
- description: Retourneert een Boekjaar met de gegeven identifier
+ summary: Retourneert een Boekjaar met de gegeven identifier
operationId: readBoekjaarById
parameters:
- name: id
@@ -3354,7 +3354,7 @@ paths:
put:
tags:
- 'Boekjaren'
- description: Vervangen van een Boekjaar
+ summary: Vervangen van een Boekjaar
operationId: replaceBoekjaarById
parameters:
- name: 'id'
@@ -3392,7 +3392,7 @@ paths:
patch:
tags:
- 'Boekjaren'
- description: Wijzigen van een Boekjaar
+ summary: Wijzigen van een Boekjaar
operationId: updateBoekjaarById
parameters:
- name: 'id'
@@ -3431,7 +3431,7 @@ paths:
get:
tags:
- 'BoekjaarPerioden'
- description: Ophalen van BoekjaarPerioden
+ summary: Ophalen van BoekjaarPerioden
operationId: listBoekjaarPerioden
parameters:
- name: params
@@ -3481,7 +3481,7 @@ paths:
post:
tags:
- 'BoekjaarPerioden'
- description: Voegt een nieuw(e) BoekjaarPeriode toe.
+ summary: Voegt een nieuw(e) BoekjaarPeriode toe.
operationId: createBoekjaarPeriode
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3521,7 +3521,7 @@ paths:
put:
tags:
- 'BoekjaarPerioden'
- description: |
+ summary: |
Vervangen van een BoekjaarPeriode op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekjaarPeriode
parameters:
@@ -3556,7 +3556,7 @@ paths:
patch:
tags:
- 'BoekjaarPerioden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BoekjaarPeriode. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekjaarPeriode
@@ -3593,7 +3593,7 @@ paths:
get:
tags:
- 'BoekjaarPerioden'
- description: Retourneert een BoekjaarPeriode met de gegeven identifier
+ summary: Retourneert een BoekjaarPeriode met de gegeven identifier
operationId: readBoekjaarPeriodeById
parameters:
- name: id
@@ -3630,7 +3630,7 @@ paths:
put:
tags:
- 'BoekjaarPerioden'
- description: Vervangen van een BoekjaarPeriode
+ summary: Vervangen van een BoekjaarPeriode
operationId: replaceBoekjaarPeriodeById
parameters:
- name: 'id'
@@ -3668,7 +3668,7 @@ paths:
patch:
tags:
- 'BoekjaarPerioden'
- description: Wijzigen van een BoekjaarPeriode
+ summary: Wijzigen van een BoekjaarPeriode
operationId: updateBoekjaarPeriodeById
parameters:
- name: 'id'
@@ -3707,7 +3707,7 @@ paths:
get:
tags:
- 'BoekjaarPeriodesaldos'
- description: Ophalen van BoekjaarPeriodesaldos
+ summary: Ophalen van BoekjaarPeriodesaldos
operationId: listBoekjaarPeriodesaldos
parameters:
- name: params
@@ -3757,7 +3757,7 @@ paths:
post:
tags:
- 'BoekjaarPeriodesaldos'
- description: Voegt een nieuw(e) BoekjaarPeriodesaldo toe.
+ summary: Voegt een nieuw(e) BoekjaarPeriodesaldo toe.
operationId: createBoekjaarPeriodesaldo
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3797,7 +3797,7 @@ paths:
put:
tags:
- 'BoekjaarPeriodesaldos'
- description: |
+ summary: |
Vervangen van een BoekjaarPeriodesaldo op basis van overeenkomstige sleutelvelden.
operationId: replaceBoekjaarPeriodesaldo
parameters:
@@ -3832,7 +3832,7 @@ paths:
patch:
tags:
- 'BoekjaarPeriodesaldos'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BoekjaarPeriodesaldo. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoekjaarPeriodesaldo
@@ -3869,7 +3869,7 @@ paths:
get:
tags:
- 'BoekjaarPeriodesaldos'
- description: Retourneert een BoekjaarPeriodesaldo met de gegeven identifier
+ summary: Retourneert een BoekjaarPeriodesaldo met de gegeven identifier
operationId: readBoekjaarPeriodesaldoById
parameters:
- name: id
@@ -3906,7 +3906,7 @@ paths:
put:
tags:
- 'BoekjaarPeriodesaldos'
- description: Vervangen van een BoekjaarPeriodesaldo
+ summary: Vervangen van een BoekjaarPeriodesaldo
operationId: replaceBoekjaarPeriodesaldoById
parameters:
- name: 'id'
@@ -3944,7 +3944,7 @@ paths:
patch:
tags:
- 'BoekjaarPeriodesaldos'
- description: Wijzigen van een BoekjaarPeriodesaldo
+ summary: Wijzigen van een BoekjaarPeriodesaldo
operationId: updateBoekjaarPeriodesaldoById
parameters:
- name: 'id'
@@ -3983,7 +3983,7 @@ paths:
get:
tags:
- 'BtwAangiften'
- description: Ophalen van BtwAangiften
+ summary: Ophalen van BtwAangiften
operationId: listBtwAangiften
parameters:
- name: params
@@ -4033,7 +4033,7 @@ paths:
post:
tags:
- 'BtwAangiften'
- description: Voegt een nieuw(e) BtwAangifte toe.
+ summary: Voegt een nieuw(e) BtwAangifte toe.
operationId: createBtwAangifte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4073,7 +4073,7 @@ paths:
put:
tags:
- 'BtwAangiften'
- description: |
+ summary: |
Vervangen van een BtwAangifte op basis van overeenkomstige sleutelvelden.
operationId: replaceBtwAangifte
parameters:
@@ -4108,7 +4108,7 @@ paths:
patch:
tags:
- 'BtwAangiften'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BtwAangifte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBtwAangifte
@@ -4145,7 +4145,7 @@ paths:
get:
tags:
- 'BtwAangiften'
- description: Retourneert een BtwAangifte met de gegeven identifier
+ summary: Retourneert een BtwAangifte met de gegeven identifier
operationId: readBtwAangifteById
parameters:
- name: id
@@ -4182,7 +4182,7 @@ paths:
put:
tags:
- 'BtwAangiften'
- description: Vervangen van een BtwAangifte
+ summary: Vervangen van een BtwAangifte
operationId: replaceBtwAangifteById
parameters:
- name: 'id'
@@ -4220,7 +4220,7 @@ paths:
patch:
tags:
- 'BtwAangiften'
- description: Wijzigen van een BtwAangifte
+ summary: Wijzigen van een BtwAangifte
operationId: updateBtwAangifteById
parameters:
- name: 'id'
@@ -4259,7 +4259,7 @@ paths:
get:
tags:
- 'BtwTarieven'
- description: Ophalen van BtwTarieven
+ summary: Ophalen van BtwTarieven
operationId: listBtwTarieven
parameters:
- name: params
@@ -4309,7 +4309,7 @@ paths:
post:
tags:
- 'BtwTarieven'
- description: Voegt een nieuw(e) BtwTarief toe.
+ summary: Voegt een nieuw(e) BtwTarief toe.
operationId: createBtwTarief
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4349,7 +4349,7 @@ paths:
put:
tags:
- 'BtwTarieven'
- description: |
+ summary: |
Vervangen van een BtwTarief op basis van overeenkomstige sleutelvelden.
operationId: replaceBtwTarief
parameters:
@@ -4384,7 +4384,7 @@ paths:
patch:
tags:
- 'BtwTarieven'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BtwTarief. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBtwTarief
@@ -4421,7 +4421,7 @@ paths:
get:
tags:
- 'BtwTarieven'
- description: Retourneert een BtwTarief met de gegeven identifier
+ summary: Retourneert een BtwTarief met de gegeven identifier
operationId: readBtwTariefById
parameters:
- name: id
@@ -4458,7 +4458,7 @@ paths:
put:
tags:
- 'BtwTarieven'
- description: Vervangen van een BtwTarief
+ summary: Vervangen van een BtwTarief
operationId: replaceBtwTariefById
parameters:
- name: 'id'
@@ -4496,7 +4496,7 @@ paths:
patch:
tags:
- 'BtwTarieven'
- description: Wijzigen van een BtwTarief
+ summary: Wijzigen van een BtwTarief
operationId: updateBtwTariefById
parameters:
- name: 'id'
@@ -4535,7 +4535,7 @@ paths:
get:
tags:
- 'Crediteuren'
- description: Ophalen van Crediteuren
+ summary: Ophalen van Crediteuren
operationId: listCrediteuren
parameters:
- name: params
@@ -4585,7 +4585,7 @@ paths:
post:
tags:
- 'Crediteuren'
- description: Voegt een nieuw(e) Crediteur toe.
+ summary: Voegt een nieuw(e) Crediteur toe.
operationId: createCrediteur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4625,7 +4625,7 @@ paths:
put:
tags:
- 'Crediteuren'
- description: |
+ summary: |
Vervangen van een Crediteur op basis van overeenkomstige sleutelvelden.
operationId: replaceCrediteur
parameters:
@@ -4660,7 +4660,7 @@ paths:
patch:
tags:
- 'Crediteuren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Crediteur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCrediteur
@@ -4697,7 +4697,7 @@ paths:
get:
tags:
- 'Crediteuren'
- description: Retourneert een Crediteur met de gegeven identifier
+ summary: Retourneert een Crediteur met de gegeven identifier
operationId: readCrediteurById
parameters:
- name: id
@@ -4734,7 +4734,7 @@ paths:
put:
tags:
- 'Crediteuren'
- description: Vervangen van een Crediteur
+ summary: Vervangen van een Crediteur
operationId: replaceCrediteurById
parameters:
- name: 'id'
@@ -4772,7 +4772,7 @@ paths:
patch:
tags:
- 'Crediteuren'
- description: Wijzigen van een Crediteur
+ summary: Wijzigen van een Crediteur
operationId: updateCrediteurById
parameters:
- name: 'id'
@@ -4811,7 +4811,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Ophalen van Debiteuren
+ summary: Ophalen van Debiteuren
operationId: listDebiteuren
parameters:
- name: params
@@ -4861,7 +4861,7 @@ paths:
post:
tags:
- 'Debiteuren'
- description: Voegt een nieuw(e) Debiteur toe.
+ summary: Voegt een nieuw(e) Debiteur toe.
operationId: createDebiteur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4901,7 +4901,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Vervangen van een Debiteur op basis van overeenkomstige sleutelvelden.
operationId: replaceDebiteur
parameters:
@@ -4936,7 +4936,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Debiteur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDebiteur
@@ -4973,7 +4973,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Retourneert een Debiteur met de gegeven identifier
+ summary: Retourneert een Debiteur met de gegeven identifier
operationId: readDebiteurById
parameters:
- name: id
@@ -5010,7 +5010,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: Vervangen van een Debiteur
+ summary: Vervangen van een Debiteur
operationId: replaceDebiteurById
parameters:
- name: 'id'
@@ -5048,7 +5048,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: Wijzigen van een Debiteur
+ summary: Wijzigen van een Debiteur
operationId: updateDebiteurById
parameters:
- name: 'id'
@@ -5087,7 +5087,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Ophalen van ExterneIncassos
+ summary: Ophalen van ExterneIncassos
operationId: listExterneIncassos
parameters:
- name: params
@@ -5137,7 +5137,7 @@ paths:
post:
tags:
- 'ExterneIncassos'
- description: Voegt een nieuw(e) ExterneIncasso toe.
+ summary: Voegt een nieuw(e) ExterneIncasso toe.
operationId: createExterneIncasso
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5177,7 +5177,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Vervangen van een ExterneIncasso op basis van overeenkomstige sleutelvelden.
operationId: replaceExterneIncasso
parameters:
@@ -5212,7 +5212,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExterneIncasso. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExterneIncasso
@@ -5249,7 +5249,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Retourneert een ExterneIncasso met de gegeven identifier
+ summary: Retourneert een ExterneIncasso met de gegeven identifier
operationId: readExterneIncassoById
parameters:
- name: id
@@ -5286,7 +5286,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: Vervangen van een ExterneIncasso
+ summary: Vervangen van een ExterneIncasso
operationId: replaceExterneIncassoById
parameters:
- name: 'id'
@@ -5324,7 +5324,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: Wijzigen van een ExterneIncasso
+ summary: Wijzigen van een ExterneIncasso
operationId: updateExterneIncassoById
parameters:
- name: 'id'
@@ -5363,7 +5363,7 @@ paths:
get:
tags:
- 'ExterneIncassoActies'
- description: Ophalen van ExterneIncassoActies
+ summary: Ophalen van ExterneIncassoActies
operationId: listExterneIncassoActies
parameters:
- name: params
@@ -5413,7 +5413,7 @@ paths:
post:
tags:
- 'ExterneIncassoActies'
- description: Voegt een nieuw(e) ExterneIncassoActie toe.
+ summary: Voegt een nieuw(e) ExterneIncassoActie toe.
operationId: createExterneIncassoActie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5453,7 +5453,7 @@ paths:
put:
tags:
- 'ExterneIncassoActies'
- description: |
+ summary: |
Vervangen van een ExterneIncassoActie op basis van overeenkomstige sleutelvelden.
operationId: replaceExterneIncassoActie
parameters:
@@ -5488,7 +5488,7 @@ paths:
patch:
tags:
- 'ExterneIncassoActies'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExterneIncassoActie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExterneIncassoActie
@@ -5525,7 +5525,7 @@ paths:
get:
tags:
- 'ExterneIncassoActies'
- description: Retourneert een ExterneIncassoActie met de gegeven identifier
+ summary: Retourneert een ExterneIncassoActie met de gegeven identifier
operationId: readExterneIncassoActieById
parameters:
- name: id
@@ -5562,7 +5562,7 @@ paths:
put:
tags:
- 'ExterneIncassoActies'
- description: Vervangen van een ExterneIncassoActie
+ summary: Vervangen van een ExterneIncassoActie
operationId: replaceExterneIncassoActieById
parameters:
- name: 'id'
@@ -5600,7 +5600,7 @@ paths:
patch:
tags:
- 'ExterneIncassoActies'
- description: Wijzigen van een ExterneIncassoActie
+ summary: Wijzigen van een ExterneIncassoActie
operationId: updateExterneIncassoActieById
parameters:
- name: 'id'
@@ -5639,7 +5639,7 @@ paths:
get:
tags:
- 'Facturen'
- description: Ophalen van Facturen
+ summary: Ophalen van Facturen
operationId: listFacturen
parameters:
- name: params
@@ -5689,7 +5689,7 @@ paths:
post:
tags:
- 'Facturen'
- description: Voegt een nieuw(e) Factuur toe.
+ summary: Voegt een nieuw(e) Factuur toe.
operationId: createFactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5729,7 +5729,7 @@ paths:
put:
tags:
- 'Facturen'
- description: |
+ summary: |
Vervangen van een Factuur op basis van overeenkomstige sleutelvelden.
operationId: replaceFactuur
parameters:
@@ -5764,7 +5764,7 @@ paths:
patch:
tags:
- 'Facturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Factuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFactuur
@@ -5801,7 +5801,7 @@ paths:
get:
tags:
- 'Facturen'
- description: Retourneert een Factuur met de gegeven identifier
+ summary: Retourneert een Factuur met de gegeven identifier
operationId: readFactuurById
parameters:
- name: id
@@ -5838,7 +5838,7 @@ paths:
put:
tags:
- 'Facturen'
- description: Vervangen van een Factuur
+ summary: Vervangen van een Factuur
operationId: replaceFactuurById
parameters:
- name: 'id'
@@ -5876,7 +5876,7 @@ paths:
patch:
tags:
- 'Facturen'
- description: Wijzigen van een Factuur
+ summary: Wijzigen van een Factuur
operationId: updateFactuurById
parameters:
- name: 'id'
@@ -5915,7 +5915,7 @@ paths:
get:
tags:
- 'Factuurbetalingen'
- description: Ophalen van Factuurbetalingen
+ summary: Ophalen van Factuurbetalingen
operationId: listFactuurbetalingen
parameters:
- name: params
@@ -5965,7 +5965,7 @@ paths:
post:
tags:
- 'Factuurbetalingen'
- description: Voegt een nieuw(e) Factuurbetaling toe.
+ summary: Voegt een nieuw(e) Factuurbetaling toe.
operationId: createFactuurbetaling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6005,7 +6005,7 @@ paths:
put:
tags:
- 'Factuurbetalingen'
- description: |
+ summary: |
Vervangen van een Factuurbetaling op basis van overeenkomstige sleutelvelden.
operationId: replaceFactuurbetaling
parameters:
@@ -6040,7 +6040,7 @@ paths:
patch:
tags:
- 'Factuurbetalingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Factuurbetaling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFactuurbetaling
@@ -6077,7 +6077,7 @@ paths:
get:
tags:
- 'Factuurbetalingen'
- description: Retourneert een Factuurbetaling met de gegeven identifier
+ summary: Retourneert een Factuurbetaling met de gegeven identifier
operationId: readFactuurbetalingById
parameters:
- name: id
@@ -6114,7 +6114,7 @@ paths:
put:
tags:
- 'Factuurbetalingen'
- description: Vervangen van een Factuurbetaling
+ summary: Vervangen van een Factuurbetaling
operationId: replaceFactuurbetalingById
parameters:
- name: 'id'
@@ -6152,7 +6152,7 @@ paths:
patch:
tags:
- 'Factuurbetalingen'
- description: Wijzigen van een Factuurbetaling
+ summary: Wijzigen van een Factuurbetaling
operationId: updateFactuurbetalingById
parameters:
- name: 'id'
@@ -6191,7 +6191,7 @@ paths:
get:
tags:
- 'Factuurregels'
- description: Ophalen van Factuurregels
+ summary: Ophalen van Factuurregels
operationId: listFactuurregels
parameters:
- name: params
@@ -6241,7 +6241,7 @@ paths:
post:
tags:
- 'Factuurregels'
- description: Voegt een nieuw(e) Factuurregel toe.
+ summary: Voegt een nieuw(e) Factuurregel toe.
operationId: createFactuurregel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6281,7 +6281,7 @@ paths:
put:
tags:
- 'Factuurregels'
- description: |
+ summary: |
Vervangen van een Factuurregel op basis van overeenkomstige sleutelvelden.
operationId: replaceFactuurregel
parameters:
@@ -6316,7 +6316,7 @@ paths:
patch:
tags:
- 'Factuurregels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Factuurregel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFactuurregel
@@ -6353,7 +6353,7 @@ paths:
get:
tags:
- 'Factuurregels'
- description: Retourneert een Factuurregel met de gegeven identifier
+ summary: Retourneert een Factuurregel met de gegeven identifier
operationId: readFactuurregelById
parameters:
- name: id
@@ -6390,7 +6390,7 @@ paths:
put:
tags:
- 'Factuurregels'
- description: Vervangen van een Factuurregel
+ summary: Vervangen van een Factuurregel
operationId: replaceFactuurregelById
parameters:
- name: 'id'
@@ -6428,7 +6428,7 @@ paths:
patch:
tags:
- 'Factuurregels'
- description: Wijzigen van een Factuurregel
+ summary: Wijzigen van een Factuurregel
operationId: updateFactuurregelById
parameters:
- name: 'id'
@@ -6467,7 +6467,7 @@ paths:
get:
tags:
- 'FinancieelBedrijven'
- description: Ophalen van FinancieelBedrijven
+ summary: Ophalen van FinancieelBedrijven
operationId: listFinancieelBedrijven
parameters:
- name: params
@@ -6517,7 +6517,7 @@ paths:
post:
tags:
- 'FinancieelBedrijven'
- description: Voegt een nieuw(e) FinancieelBedrijf toe.
+ summary: Voegt een nieuw(e) FinancieelBedrijf toe.
operationId: createFinancieelBedrijf
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6557,7 +6557,7 @@ paths:
put:
tags:
- 'FinancieelBedrijven'
- description: |
+ summary: |
Vervangen van een FinancieelBedrijf op basis van overeenkomstige sleutelvelden.
operationId: replaceFinancieelBedrijf
parameters:
@@ -6592,7 +6592,7 @@ paths:
patch:
tags:
- 'FinancieelBedrijven'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een FinancieelBedrijf. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateFinancieelBedrijf
@@ -6629,7 +6629,7 @@ paths:
get:
tags:
- 'FinancieelBedrijven'
- description: Retourneert een FinancieelBedrijf met de gegeven identifier
+ summary: Retourneert een FinancieelBedrijf met de gegeven identifier
operationId: readFinancieelBedrijfById
parameters:
- name: id
@@ -6666,7 +6666,7 @@ paths:
put:
tags:
- 'FinancieelBedrijven'
- description: Vervangen van een FinancieelBedrijf
+ summary: Vervangen van een FinancieelBedrijf
operationId: replaceFinancieelBedrijfById
parameters:
- name: 'id'
@@ -6704,7 +6704,7 @@ paths:
patch:
tags:
- 'FinancieelBedrijven'
- description: Wijzigen van een FinancieelBedrijf
+ summary: Wijzigen van een FinancieelBedrijf
operationId: updateFinancieelBedrijfById
parameters:
- name: 'id'
@@ -6743,7 +6743,7 @@ paths:
get:
tags:
- 'Grootboekmutaties'
- description: Ophalen van Grootboekmutaties
+ summary: Ophalen van Grootboekmutaties
operationId: listGrootboekmutaties
parameters:
- name: params
@@ -6793,7 +6793,7 @@ paths:
post:
tags:
- 'Grootboekmutaties'
- description: Voegt een nieuw(e) Grootboekmutatie toe.
+ summary: Voegt een nieuw(e) Grootboekmutatie toe.
operationId: createGrootboekmutatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6833,7 +6833,7 @@ paths:
put:
tags:
- 'Grootboekmutaties'
- description: |
+ summary: |
Vervangen van een Grootboekmutatie op basis van overeenkomstige sleutelvelden.
operationId: replaceGrootboekmutatie
parameters:
@@ -6868,7 +6868,7 @@ paths:
patch:
tags:
- 'Grootboekmutaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Grootboekmutatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGrootboekmutatie
@@ -6905,7 +6905,7 @@ paths:
get:
tags:
- 'Grootboekmutaties'
- description: Retourneert een Grootboekmutatie met de gegeven identifier
+ summary: Retourneert een Grootboekmutatie met de gegeven identifier
operationId: readGrootboekmutatieById
parameters:
- name: id
@@ -6942,7 +6942,7 @@ paths:
put:
tags:
- 'Grootboekmutaties'
- description: Vervangen van een Grootboekmutatie
+ summary: Vervangen van een Grootboekmutatie
operationId: replaceGrootboekmutatieById
parameters:
- name: 'id'
@@ -6980,7 +6980,7 @@ paths:
patch:
tags:
- 'Grootboekmutaties'
- description: Wijzigen van een Grootboekmutatie
+ summary: Wijzigen van een Grootboekmutatie
operationId: updateGrootboekmutatieById
parameters:
- name: 'id'
@@ -7019,7 +7019,7 @@ paths:
get:
tags:
- 'Grootboekrekeningen'
- description: Ophalen van Grootboekrekeningen
+ summary: Ophalen van Grootboekrekeningen
operationId: listGrootboekrekeningen
parameters:
- name: params
@@ -7069,7 +7069,7 @@ paths:
post:
tags:
- 'Grootboekrekeningen'
- description: Voegt een nieuw(e) Grootboekrekening toe.
+ summary: Voegt een nieuw(e) Grootboekrekening toe.
operationId: createGrootboekrekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7109,7 +7109,7 @@ paths:
put:
tags:
- 'Grootboekrekeningen'
- description: |
+ summary: |
Vervangen van een Grootboekrekening op basis van overeenkomstige sleutelvelden.
operationId: replaceGrootboekrekening
parameters:
@@ -7144,7 +7144,7 @@ paths:
patch:
tags:
- 'Grootboekrekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Grootboekrekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGrootboekrekening
@@ -7181,7 +7181,7 @@ paths:
get:
tags:
- 'Grootboekrekeningen'
- description: Retourneert een Grootboekrekening met de gegeven identifier
+ summary: Retourneert een Grootboekrekening met de gegeven identifier
operationId: readGrootboekrekeningById
parameters:
- name: id
@@ -7218,7 +7218,7 @@ paths:
put:
tags:
- 'Grootboekrekeningen'
- description: Vervangen van een Grootboekrekening
+ summary: Vervangen van een Grootboekrekening
operationId: replaceGrootboekrekeningById
parameters:
- name: 'id'
@@ -7256,7 +7256,7 @@ paths:
patch:
tags:
- 'Grootboekrekeningen'
- description: Wijzigen van een Grootboekrekening
+ summary: Wijzigen van een Grootboekrekening
operationId: updateGrootboekrekeningById
parameters:
- name: 'id'
@@ -7295,7 +7295,7 @@ paths:
get:
tags:
- 'Incassomachtigingen'
- description: Ophalen van Incassomachtigingen
+ summary: Ophalen van Incassomachtigingen
operationId: listIncassomachtigingen
parameters:
- name: params
@@ -7345,7 +7345,7 @@ paths:
post:
tags:
- 'Incassomachtigingen'
- description: Voegt een nieuw(e) Incassomachtiging toe.
+ summary: Voegt een nieuw(e) Incassomachtiging toe.
operationId: createIncassomachtiging
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7385,7 +7385,7 @@ paths:
put:
tags:
- 'Incassomachtigingen'
- description: |
+ summary: |
Vervangen van een Incassomachtiging op basis van overeenkomstige sleutelvelden.
operationId: replaceIncassomachtiging
parameters:
@@ -7420,7 +7420,7 @@ paths:
patch:
tags:
- 'Incassomachtigingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Incassomachtiging. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateIncassomachtiging
@@ -7457,7 +7457,7 @@ paths:
get:
tags:
- 'Incassomachtigingen'
- description: Retourneert een Incassomachtiging met de gegeven identifier
+ summary: Retourneert een Incassomachtiging met de gegeven identifier
operationId: readIncassomachtigingById
parameters:
- name: id
@@ -7494,7 +7494,7 @@ paths:
put:
tags:
- 'Incassomachtigingen'
- description: Vervangen van een Incassomachtiging
+ summary: Vervangen van een Incassomachtiging
operationId: replaceIncassomachtigingById
parameters:
- name: 'id'
@@ -7532,7 +7532,7 @@ paths:
patch:
tags:
- 'Incassomachtigingen'
- description: Wijzigen van een Incassomachtiging
+ summary: Wijzigen van een Incassomachtiging
operationId: updateIncassomachtigingById
parameters:
- name: 'id'
@@ -7571,7 +7571,7 @@ paths:
get:
tags:
- 'IncassoOpdrachten'
- description: Ophalen van IncassoOpdrachten
+ summary: Ophalen van IncassoOpdrachten
operationId: listIncassoOpdrachten
parameters:
- name: params
@@ -7621,7 +7621,7 @@ paths:
post:
tags:
- 'IncassoOpdrachten'
- description: Voegt een nieuw(e) IncassoOpdracht toe.
+ summary: Voegt een nieuw(e) IncassoOpdracht toe.
operationId: createIncassoOpdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7661,7 +7661,7 @@ paths:
put:
tags:
- 'IncassoOpdrachten'
- description: |
+ summary: |
Vervangen van een IncassoOpdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceIncassoOpdracht
parameters:
@@ -7696,7 +7696,7 @@ paths:
patch:
tags:
- 'IncassoOpdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een IncassoOpdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateIncassoOpdracht
@@ -7733,7 +7733,7 @@ paths:
get:
tags:
- 'IncassoOpdrachten'
- description: Retourneert een IncassoOpdracht met de gegeven identifier
+ summary: Retourneert een IncassoOpdracht met de gegeven identifier
operationId: readIncassoOpdrachtById
parameters:
- name: id
@@ -7770,7 +7770,7 @@ paths:
put:
tags:
- 'IncassoOpdrachten'
- description: Vervangen van een IncassoOpdracht
+ summary: Vervangen van een IncassoOpdracht
operationId: replaceIncassoOpdrachtById
parameters:
- name: 'id'
@@ -7808,7 +7808,7 @@ paths:
patch:
tags:
- 'IncassoOpdrachten'
- description: Wijzigen van een IncassoOpdracht
+ summary: Wijzigen van een IncassoOpdracht
operationId: updateIncassoOpdrachtById
parameters:
- name: 'id'
@@ -7847,7 +7847,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Ophalen van Inkoopfacturen
+ summary: Ophalen van Inkoopfacturen
operationId: listInkoopfacturen
parameters:
- name: params
@@ -7897,7 +7897,7 @@ paths:
post:
tags:
- 'Inkoopfacturen'
- description: Voegt een nieuw(e) Inkoopfactuur toe.
+ summary: Voegt een nieuw(e) Inkoopfactuur toe.
operationId: createInkoopfactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7937,7 +7937,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Vervangen van een Inkoopfactuur op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopfactuur
parameters:
@@ -7972,7 +7972,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkoopfactuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopfactuur
@@ -8009,7 +8009,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Retourneert een Inkoopfactuur met de gegeven identifier
+ summary: Retourneert een Inkoopfactuur met de gegeven identifier
operationId: readInkoopfactuurById
parameters:
- name: id
@@ -8046,7 +8046,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: Vervangen van een Inkoopfactuur
+ summary: Vervangen van een Inkoopfactuur
operationId: replaceInkoopfactuurById
parameters:
- name: 'id'
@@ -8084,7 +8084,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: Wijzigen van een Inkoopfactuur
+ summary: Wijzigen van een Inkoopfactuur
operationId: updateInkoopfactuurById
parameters:
- name: 'id'
@@ -8123,7 +8123,7 @@ paths:
get:
tags:
- 'InkoopfactuurRegels'
- description: Ophalen van InkoopfactuurRegels
+ summary: Ophalen van InkoopfactuurRegels
operationId: listInkoopfactuurRegels
parameters:
- name: params
@@ -8173,7 +8173,7 @@ paths:
post:
tags:
- 'InkoopfactuurRegels'
- description: Voegt een nieuw(e) InkoopfactuurRegel toe.
+ summary: Voegt een nieuw(e) InkoopfactuurRegel toe.
operationId: createInkoopfactuurRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8213,7 +8213,7 @@ paths:
put:
tags:
- 'InkoopfactuurRegels'
- description: |
+ summary: |
Vervangen van een InkoopfactuurRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopfactuurRegel
parameters:
@@ -8248,7 +8248,7 @@ paths:
patch:
tags:
- 'InkoopfactuurRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een InkoopfactuurRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopfactuurRegel
@@ -8285,7 +8285,7 @@ paths:
get:
tags:
- 'InkoopfactuurRegels'
- description: Retourneert een InkoopfactuurRegel met de gegeven identifier
+ summary: Retourneert een InkoopfactuurRegel met de gegeven identifier
operationId: readInkoopfactuurRegelById
parameters:
- name: id
@@ -8322,7 +8322,7 @@ paths:
put:
tags:
- 'InkoopfactuurRegels'
- description: Vervangen van een InkoopfactuurRegel
+ summary: Vervangen van een InkoopfactuurRegel
operationId: replaceInkoopfactuurRegelById
parameters:
- name: 'id'
@@ -8360,7 +8360,7 @@ paths:
patch:
tags:
- 'InkoopfactuurRegels'
- description: Wijzigen van een InkoopfactuurRegel
+ summary: Wijzigen van een InkoopfactuurRegel
operationId: updateInkoopfactuurRegelById
parameters:
- name: 'id'
@@ -8399,7 +8399,7 @@ paths:
get:
tags:
- 'Inkoopopdrachten'
- description: Ophalen van Inkoopopdrachten
+ summary: Ophalen van Inkoopopdrachten
operationId: listInkoopopdrachten
parameters:
- name: params
@@ -8449,7 +8449,7 @@ paths:
post:
tags:
- 'Inkoopopdrachten'
- description: Voegt een nieuw(e) Inkoopopdracht toe.
+ summary: Voegt een nieuw(e) Inkoopopdracht toe.
operationId: createInkoopopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8489,7 +8489,7 @@ paths:
put:
tags:
- 'Inkoopopdrachten'
- description: |
+ summary: |
Vervangen van een Inkoopopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopopdracht
parameters:
@@ -8524,7 +8524,7 @@ paths:
patch:
tags:
- 'Inkoopopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkoopopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopopdracht
@@ -8561,7 +8561,7 @@ paths:
get:
tags:
- 'Inkoopopdrachten'
- description: Retourneert een Inkoopopdracht met de gegeven identifier
+ summary: Retourneert een Inkoopopdracht met de gegeven identifier
operationId: readInkoopopdrachtById
parameters:
- name: id
@@ -8598,7 +8598,7 @@ paths:
put:
tags:
- 'Inkoopopdrachten'
- description: Vervangen van een Inkoopopdracht
+ summary: Vervangen van een Inkoopopdracht
operationId: replaceInkoopopdrachtById
parameters:
- name: 'id'
@@ -8636,7 +8636,7 @@ paths:
patch:
tags:
- 'Inkoopopdrachten'
- description: Wijzigen van een Inkoopopdracht
+ summary: Wijzigen van een Inkoopopdracht
operationId: updateInkoopopdrachtById
parameters:
- name: 'id'
@@ -8675,7 +8675,7 @@ paths:
get:
tags:
- 'InkoopopdrachtRegels'
- description: Ophalen van InkoopopdrachtRegels
+ summary: Ophalen van InkoopopdrachtRegels
operationId: listInkoopopdrachtRegels
parameters:
- name: params
@@ -8725,7 +8725,7 @@ paths:
post:
tags:
- 'InkoopopdrachtRegels'
- description: Voegt een nieuw(e) InkoopopdrachtRegel toe.
+ summary: Voegt een nieuw(e) InkoopopdrachtRegel toe.
operationId: createInkoopopdrachtRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8765,7 +8765,7 @@ paths:
put:
tags:
- 'InkoopopdrachtRegels'
- description: |
+ summary: |
Vervangen van een InkoopopdrachtRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopopdrachtRegel
parameters:
@@ -8800,7 +8800,7 @@ paths:
patch:
tags:
- 'InkoopopdrachtRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een InkoopopdrachtRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopopdrachtRegel
@@ -8837,7 +8837,7 @@ paths:
get:
tags:
- 'InkoopopdrachtRegels'
- description: Retourneert een InkoopopdrachtRegel met de gegeven identifier
+ summary: Retourneert een InkoopopdrachtRegel met de gegeven identifier
operationId: readInkoopopdrachtRegelById
parameters:
- name: id
@@ -8874,7 +8874,7 @@ paths:
put:
tags:
- 'InkoopopdrachtRegels'
- description: Vervangen van een InkoopopdrachtRegel
+ summary: Vervangen van een InkoopopdrachtRegel
operationId: replaceInkoopopdrachtRegelById
parameters:
- name: 'id'
@@ -8912,7 +8912,7 @@ paths:
patch:
tags:
- 'InkoopopdrachtRegels'
- description: Wijzigen van een InkoopopdrachtRegel
+ summary: Wijzigen van een InkoopopdrachtRegel
operationId: updateInkoopopdrachtRegelById
parameters:
- name: 'id'
@@ -8951,7 +8951,7 @@ paths:
get:
tags:
- 'Leningen'
- description: Ophalen van Leningen
+ summary: Ophalen van Leningen
operationId: listLeningen
parameters:
- name: params
@@ -9001,7 +9001,7 @@ paths:
post:
tags:
- 'Leningen'
- description: Voegt een nieuw(e) Lening toe.
+ summary: Voegt een nieuw(e) Lening toe.
operationId: createLening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9041,7 +9041,7 @@ paths:
put:
tags:
- 'Leningen'
- description: |
+ summary: |
Vervangen van een Lening op basis van overeenkomstige sleutelvelden.
operationId: replaceLening
parameters:
@@ -9076,7 +9076,7 @@ paths:
patch:
tags:
- 'Leningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Lening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateLening
@@ -9113,7 +9113,7 @@ paths:
get:
tags:
- 'Leningen'
- description: Retourneert een Lening met de gegeven identifier
+ summary: Retourneert een Lening met de gegeven identifier
operationId: readLeningById
parameters:
- name: id
@@ -9150,7 +9150,7 @@ paths:
put:
tags:
- 'Leningen'
- description: Vervangen van een Lening
+ summary: Vervangen van een Lening
operationId: replaceLeningById
parameters:
- name: 'id'
@@ -9188,7 +9188,7 @@ paths:
patch:
tags:
- 'Leningen'
- description: Wijzigen van een Lening
+ summary: Wijzigen van een Lening
operationId: updateLeningById
parameters:
- name: 'id'
@@ -9227,7 +9227,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Ophalen van Offertes
+ summary: Ophalen van Offertes
operationId: listOffertes
parameters:
- name: params
@@ -9277,7 +9277,7 @@ paths:
post:
tags:
- 'Offertes'
- description: Voegt een nieuw(e) Offerte toe.
+ summary: Voegt een nieuw(e) Offerte toe.
operationId: createOfferte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9317,7 +9317,7 @@ paths:
put:
tags:
- 'Offertes'
- description: |
+ summary: |
Vervangen van een Offerte op basis van overeenkomstige sleutelvelden.
operationId: replaceOfferte
parameters:
@@ -9352,7 +9352,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Offerte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOfferte
@@ -9389,7 +9389,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Retourneert een Offerte met de gegeven identifier
+ summary: Retourneert een Offerte met de gegeven identifier
operationId: readOfferteById
parameters:
- name: id
@@ -9426,7 +9426,7 @@ paths:
put:
tags:
- 'Offertes'
- description: Vervangen van een Offerte
+ summary: Vervangen van een Offerte
operationId: replaceOfferteById
parameters:
- name: 'id'
@@ -9464,7 +9464,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: Wijzigen van een Offerte
+ summary: Wijzigen van een Offerte
operationId: updateOfferteById
parameters:
- name: 'id'
@@ -9503,7 +9503,7 @@ paths:
get:
tags:
- 'Offerteregels'
- description: Ophalen van Offerteregels
+ summary: Ophalen van Offerteregels
operationId: listOfferteregels
parameters:
- name: params
@@ -9553,7 +9553,7 @@ paths:
post:
tags:
- 'Offerteregels'
- description: Voegt een nieuw(e) Offerteregel toe.
+ summary: Voegt een nieuw(e) Offerteregel toe.
operationId: createOfferteregel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9593,7 +9593,7 @@ paths:
put:
tags:
- 'Offerteregels'
- description: |
+ summary: |
Vervangen van een Offerteregel op basis van overeenkomstige sleutelvelden.
operationId: replaceOfferteregel
parameters:
@@ -9628,7 +9628,7 @@ paths:
patch:
tags:
- 'Offerteregels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Offerteregel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOfferteregel
@@ -9665,7 +9665,7 @@ paths:
get:
tags:
- 'Offerteregels'
- description: Retourneert een Offerteregel met de gegeven identifier
+ summary: Retourneert een Offerteregel met de gegeven identifier
operationId: readOfferteregelById
parameters:
- name: id
@@ -9702,7 +9702,7 @@ paths:
put:
tags:
- 'Offerteregels'
- description: Vervangen van een Offerteregel
+ summary: Vervangen van een Offerteregel
operationId: replaceOfferteregelById
parameters:
- name: 'id'
@@ -9740,7 +9740,7 @@ paths:
patch:
tags:
- 'Offerteregels'
- description: Wijzigen van een Offerteregel
+ summary: Wijzigen van een Offerteregel
operationId: updateOfferteregelById
parameters:
- name: 'id'
@@ -9779,7 +9779,7 @@ paths:
get:
tags:
- 'Prijsaanpassingen'
- description: Ophalen van Prijsaanpassingen
+ summary: Ophalen van Prijsaanpassingen
operationId: listPrijsaanpassingen
parameters:
- name: params
@@ -9829,7 +9829,7 @@ paths:
post:
tags:
- 'Prijsaanpassingen'
- description: Voegt een nieuw(e) Prijsaanpassing toe.
+ summary: Voegt een nieuw(e) Prijsaanpassing toe.
operationId: createPrijsaanpassing
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9869,7 +9869,7 @@ paths:
put:
tags:
- 'Prijsaanpassingen'
- description: |
+ summary: |
Vervangen van een Prijsaanpassing op basis van overeenkomstige sleutelvelden.
operationId: replacePrijsaanpassing
parameters:
@@ -9904,7 +9904,7 @@ paths:
patch:
tags:
- 'Prijsaanpassingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Prijsaanpassing. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePrijsaanpassing
@@ -9941,7 +9941,7 @@ paths:
get:
tags:
- 'Prijsaanpassingen'
- description: Retourneert een Prijsaanpassing met de gegeven identifier
+ summary: Retourneert een Prijsaanpassing met de gegeven identifier
operationId: readPrijsaanpassingById
parameters:
- name: id
@@ -9978,7 +9978,7 @@ paths:
put:
tags:
- 'Prijsaanpassingen'
- description: Vervangen van een Prijsaanpassing
+ summary: Vervangen van een Prijsaanpassing
operationId: replacePrijsaanpassingById
parameters:
- name: 'id'
@@ -10016,7 +10016,7 @@ paths:
patch:
tags:
- 'Prijsaanpassingen'
- description: Wijzigen van een Prijsaanpassing
+ summary: Wijzigen van een Prijsaanpassing
operationId: updatePrijsaanpassingById
parameters:
- name: 'id'
@@ -10055,7 +10055,7 @@ paths:
get:
tags:
- 'ToegelatenInstellingen'
- description: Ophalen van ToegelatenInstellingen
+ summary: Ophalen van ToegelatenInstellingen
operationId: listToegelatenInstellingen
parameters:
- name: params
@@ -10105,7 +10105,7 @@ paths:
post:
tags:
- 'ToegelatenInstellingen'
- description: Voegt een nieuw(e) ToegelatenInstelling toe.
+ summary: Voegt een nieuw(e) ToegelatenInstelling toe.
operationId: createToegelatenInstelling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10145,7 +10145,7 @@ paths:
put:
tags:
- 'ToegelatenInstellingen'
- description: |
+ summary: |
Vervangen van een ToegelatenInstelling op basis van overeenkomstige sleutelvelden.
operationId: replaceToegelatenInstelling
parameters:
@@ -10180,7 +10180,7 @@ paths:
patch:
tags:
- 'ToegelatenInstellingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ToegelatenInstelling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateToegelatenInstelling
@@ -10217,7 +10217,7 @@ paths:
get:
tags:
- 'ToegelatenInstellingen'
- description: Retourneert een ToegelatenInstelling met de gegeven identifier
+ summary: Retourneert een ToegelatenInstelling met de gegeven identifier
operationId: readToegelatenInstellingById
parameters:
- name: id
@@ -10254,7 +10254,7 @@ paths:
put:
tags:
- 'ToegelatenInstellingen'
- description: Vervangen van een ToegelatenInstelling
+ summary: Vervangen van een ToegelatenInstelling
operationId: replaceToegelatenInstellingById
parameters:
- name: 'id'
@@ -10292,7 +10292,7 @@ paths:
patch:
tags:
- 'ToegelatenInstellingen'
- description: Wijzigen van een ToegelatenInstelling
+ summary: Wijzigen van een ToegelatenInstelling
operationId: updateToegelatenInstellingById
parameters:
- name: 'id'
@@ -10331,7 +10331,7 @@ paths:
get:
tags:
- 'Verbijzonderingen'
- description: Ophalen van Verbijzonderingen
+ summary: Ophalen van Verbijzonderingen
operationId: listVerbijzonderingen
parameters:
- name: params
@@ -10381,7 +10381,7 @@ paths:
post:
tags:
- 'Verbijzonderingen'
- description: Voegt een nieuw(e) Verbijzondering toe.
+ summary: Voegt een nieuw(e) Verbijzondering toe.
operationId: createVerbijzondering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10421,7 +10421,7 @@ paths:
put:
tags:
- 'Verbijzonderingen'
- description: |
+ summary: |
Vervangen van een Verbijzondering op basis van overeenkomstige sleutelvelden.
operationId: replaceVerbijzondering
parameters:
@@ -10456,7 +10456,7 @@ paths:
patch:
tags:
- 'Verbijzonderingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Verbijzondering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVerbijzondering
@@ -10493,7 +10493,7 @@ paths:
get:
tags:
- 'Verbijzonderingen'
- description: Retourneert een Verbijzondering met de gegeven identifier
+ summary: Retourneert een Verbijzondering met de gegeven identifier
operationId: readVerbijzonderingById
parameters:
- name: id
@@ -10530,7 +10530,7 @@ paths:
put:
tags:
- 'Verbijzonderingen'
- description: Vervangen van een Verbijzondering
+ summary: Vervangen van een Verbijzondering
operationId: replaceVerbijzonderingById
parameters:
- name: 'id'
@@ -10568,7 +10568,7 @@ paths:
patch:
tags:
- 'Verbijzonderingen'
- description: Wijzigen van een Verbijzondering
+ summary: Wijzigen van een Verbijzondering
operationId: updateVerbijzonderingById
parameters:
- name: 'id'
@@ -10607,7 +10607,7 @@ paths:
get:
tags:
- 'Verkoopfacturen'
- description: Ophalen van Verkoopfacturen
+ summary: Ophalen van Verkoopfacturen
operationId: listVerkoopfacturen
parameters:
- name: params
@@ -10657,7 +10657,7 @@ paths:
post:
tags:
- 'Verkoopfacturen'
- description: Voegt een nieuw(e) Verkoopfactuur toe.
+ summary: Voegt een nieuw(e) Verkoopfactuur toe.
operationId: createVerkoopfactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10697,7 +10697,7 @@ paths:
put:
tags:
- 'Verkoopfacturen'
- description: |
+ summary: |
Vervangen van een Verkoopfactuur op basis van overeenkomstige sleutelvelden.
operationId: replaceVerkoopfactuur
parameters:
@@ -10732,7 +10732,7 @@ paths:
patch:
tags:
- 'Verkoopfacturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Verkoopfactuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVerkoopfactuur
@@ -10769,7 +10769,7 @@ paths:
get:
tags:
- 'Verkoopfacturen'
- description: Retourneert een Verkoopfactuur met de gegeven identifier
+ summary: Retourneert een Verkoopfactuur met de gegeven identifier
operationId: readVerkoopfactuurById
parameters:
- name: id
@@ -10806,7 +10806,7 @@ paths:
put:
tags:
- 'Verkoopfacturen'
- description: Vervangen van een Verkoopfactuur
+ summary: Vervangen van een Verkoopfactuur
operationId: replaceVerkoopfactuurById
parameters:
- name: 'id'
@@ -10844,7 +10844,7 @@ paths:
patch:
tags:
- 'Verkoopfacturen'
- description: Wijzigen van een Verkoopfactuur
+ summary: Wijzigen van een Verkoopfactuur
operationId: updateVerkoopfactuurById
parameters:
- name: 'id'
@@ -10916,10 +10916,94 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Financien.All.Read: alleen lezen van alle resources
+ Financien.All.ReadWrite: lezen en schrijven van alle resources
+ Financien.Aanbestedingen.Read: alleen lezen van Aanbestedingen
+ Financien.Aanbestedingen.ReadWrite: lezen en schrijven van Aanbestedingen
+ Financien.Afletteringen.Read: alleen lezen van Afletteringen
+ Financien.Afletteringen.ReadWrite: lezen en schrijven van Afletteringen
+ Financien.Bankafschriften.Read: alleen lezen van Bankafschriften
+ Financien.Bankafschriften.ReadWrite: lezen en schrijven van Bankafschriften
+ Financien.BankafschriftRegels.Read: alleen lezen van BankafschriftRegels
+ Financien.BankafschriftRegels.ReadWrite: lezen en schrijven van BankafschriftRegels
+ Financien.Begrotingen.Read: alleen lezen van Begrotingen
+ Financien.Begrotingen.ReadWrite: lezen en schrijven van Begrotingen
+ Financien.Betaalopdrachten.Read: alleen lezen van Betaalopdrachten
+ Financien.Betaalopdrachten.ReadWrite: lezen en schrijven van Betaalopdrachten
+ Financien.Betaalwijzen.Read: alleen lezen van Betaalwijzen
+ Financien.Betaalwijzen.ReadWrite: lezen en schrijven van Betaalwijzen
+ Financien.Betalingsregelingen.Read: alleen lezen van Betalingsregelingen
+ Financien.Betalingsregelingen.ReadWrite: lezen en schrijven van Betalingsregelingen
+ Financien.BetalingsregelingTermijnen.Read: alleen lezen van BetalingsregelingTermijnen
+ Financien.BetalingsregelingTermijnen.ReadWrite: lezen en schrijven van BetalingsregelingTermijnen
+ Financien.Boekingen.Read: alleen lezen van Boekingen
+ Financien.Boekingen.ReadWrite: lezen en schrijven van Boekingen
+ Financien.Boekingdetails.Read: alleen lezen van Boekingdetails
+ Financien.Boekingdetails.ReadWrite: lezen en schrijven van Boekingdetails
+ Financien.Boekjaren.Read: alleen lezen van Boekjaren
+ Financien.Boekjaren.ReadWrite: lezen en schrijven van Boekjaren
+ Financien.BoekjaarPerioden.Read: alleen lezen van BoekjaarPerioden
+ Financien.BoekjaarPerioden.ReadWrite: lezen en schrijven van BoekjaarPerioden
+ Financien.BoekjaarPeriodesaldos.Read: alleen lezen van BoekjaarPeriodesaldos
+ Financien.BoekjaarPeriodesaldos.ReadWrite: lezen en schrijven van BoekjaarPeriodesaldos
+ Financien.BtwAangiften.Read: alleen lezen van BtwAangiften
+ Financien.BtwAangiften.ReadWrite: lezen en schrijven van BtwAangiften
+ Financien.BtwTarieven.Read: alleen lezen van BtwTarieven
+ Financien.BtwTarieven.ReadWrite: lezen en schrijven van BtwTarieven
+ Financien.Crediteuren.Read: alleen lezen van Crediteuren
+ Financien.Crediteuren.ReadWrite: lezen en schrijven van Crediteuren
+ Financien.Debiteuren.Read: alleen lezen van Debiteuren
+ Financien.Debiteuren.ReadWrite: lezen en schrijven van Debiteuren
+ Financien.ExterneIncassos.Read: alleen lezen van ExterneIncassos
+ Financien.ExterneIncassos.ReadWrite: lezen en schrijven van ExterneIncassos
+ Financien.ExterneIncassoActies.Read: alleen lezen van ExterneIncassoActies
+ Financien.ExterneIncassoActies.ReadWrite: lezen en schrijven van ExterneIncassoActies
+ Financien.Facturen.Read: alleen lezen van Facturen
+ Financien.Facturen.ReadWrite: lezen en schrijven van Facturen
+ Financien.Factuurbetalingen.Read: alleen lezen van Factuurbetalingen
+ Financien.Factuurbetalingen.ReadWrite: lezen en schrijven van Factuurbetalingen
+ Financien.Factuurregels.Read: alleen lezen van Factuurregels
+ Financien.Factuurregels.ReadWrite: lezen en schrijven van Factuurregels
+ Financien.FinancieelBedrijven.Read: alleen lezen van FinancieelBedrijven
+ Financien.FinancieelBedrijven.ReadWrite: lezen en schrijven van FinancieelBedrijven
+ Financien.Grootboekmutaties.Read: alleen lezen van Grootboekmutaties
+ Financien.Grootboekmutaties.ReadWrite: lezen en schrijven van Grootboekmutaties
+ Financien.Grootboekrekeningen.Read: alleen lezen van Grootboekrekeningen
+ Financien.Grootboekrekeningen.ReadWrite: lezen en schrijven van Grootboekrekeningen
+ Financien.Incassomachtigingen.Read: alleen lezen van Incassomachtigingen
+ Financien.Incassomachtigingen.ReadWrite: lezen en schrijven van Incassomachtigingen
+ Financien.IncassoOpdrachten.Read: alleen lezen van IncassoOpdrachten
+ Financien.IncassoOpdrachten.ReadWrite: lezen en schrijven van IncassoOpdrachten
+ Financien.Inkoopfacturen.Read: alleen lezen van Inkoopfacturen
+ Financien.Inkoopfacturen.ReadWrite: lezen en schrijven van Inkoopfacturen
+ Financien.InkoopfactuurRegels.Read: alleen lezen van InkoopfactuurRegels
+ Financien.InkoopfactuurRegels.ReadWrite: lezen en schrijven van InkoopfactuurRegels
+ Financien.Inkoopopdrachten.Read: alleen lezen van Inkoopopdrachten
+ Financien.Inkoopopdrachten.ReadWrite: lezen en schrijven van Inkoopopdrachten
+ Financien.InkoopopdrachtRegels.Read: alleen lezen van InkoopopdrachtRegels
+ Financien.InkoopopdrachtRegels.ReadWrite: lezen en schrijven van InkoopopdrachtRegels
+ Financien.Leningen.Read: alleen lezen van Leningen
+ Financien.Leningen.ReadWrite: lezen en schrijven van Leningen
+ Financien.Offertes.Read: alleen lezen van Offertes
+ Financien.Offertes.ReadWrite: lezen en schrijven van Offertes
+ Financien.Offerteregels.Read: alleen lezen van Offerteregels
+ Financien.Offerteregels.ReadWrite: lezen en schrijven van Offerteregels
+ Financien.Prijsaanpassingen.Read: alleen lezen van Prijsaanpassingen
+ Financien.Prijsaanpassingen.ReadWrite: lezen en schrijven van Prijsaanpassingen
+ Financien.ToegelatenInstellingen.Read: alleen lezen van ToegelatenInstellingen
+ Financien.ToegelatenInstellingen.ReadWrite: lezen en schrijven van ToegelatenInstellingen
+ Financien.Verbijzonderingen.Read: alleen lezen van Verbijzonderingen
+ Financien.Verbijzonderingen.ReadWrite: lezen en schrijven van Verbijzonderingen
+ Financien.Verkoopfacturen.Read: alleen lezen van Verkoopfacturen
+ Financien.Verkoopfacturen.ReadWrite: lezen en schrijven van Verkoopfacturen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Financien.All.Read: alleen lezen van alle resources
Financien.All.ReadWrite: lezen en schrijven van alle resources
@@ -11069,17 +11153,13 @@ components:
description: Het afgeletterde bedrag.
huurBoeking:
allOf:
- - $ref: '#/components/schemas/Boeking'
+ - $ref: '#/components/schemas/Boeking-sleutels'
description: Boeking die ten grondslag ligt aan de aflettering.
tegenHuurBoeking:
allOf:
- - $ref: '#/components/schemas/Boeking'
+ - $ref: '#/components/schemas/Boeking-sleutels'
description: Boeking waarop is afgeletterd.
- Boekingbericht:
- allOf:
- - $ref: '#/components/schemas/Boeking'
- - $ref: '#/components/schemas/Bericht-basis'
- Boeking:
+ Boeking-sleutels:
type: object
properties:
id:
@@ -11098,155 +11178,70 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort boeking. Bijvoorbeeld;vordering, ontvangst of uitbetaling. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Detaillering van het soort boeking. Bijvoorbeeld;storno, kasbetaling, acceptgiro, enzovoort. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGDETAILSOORT.
- omschrijving:
+ Bankafschriftbericht:
+ allOf:
+ - $ref: '#/components/schemas/Bankafschrift'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Bankafschrift:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Omschrijving van de boeking.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de boeking. Bijvoorbeeld;voorlopig, gefiatteerd. Referentiedatasoort BOEKINGSTATUS.
- boekdatum:
- type: string
- format: date
- description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- factuurdatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: Boekstuk- of factuurdatum van de boeking.
- valutadatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: Valutadatum van de boeking.
- vervaldatum:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: date
- description: Vervaldatum van de boeking.
- kortingsdatum:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ omschrijving:
type: string
- format: date
- description: Kortingsdatum.
- aflettering:
+ format: any
+ description: Omschrijving van het gegeven.
+ status:
allOf:
- - $ref: '#/components/schemas/Aflettering-sleutels'
- description: De grondslag aflettering behorende bij de boeking.
- afletteringen:
- description: De afletteringen behorende bij de boeking.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Status van het afschrift: ingelezen/verwerkt. Referentiedatasoort BANKAFSCHRIFTSTATUS.'
+ afBedrag:
+ type: number
+ format: float
+ description: Totaal bedrag af op dit afschrift.
+ bankafschriftRegels:
+ description: De bankafschriftregels van het bankafschrift.
type: array
items:
- $ref: '#/components/schemas/Aflettering-sleutels'
- bankafschriftRegel:
- allOf:
- - $ref: '#/components/schemas/BankafschriftRegel'
- description: De bankafschriftregel waaraan de boeking gekoppeld is.
- bedrag:
+ $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ beginsaldo:
type: number
format: float
- description: Het initiele bedrag van de boeking (inclusief btw).
- betaalgegeven:
+ description: Beginsaldo vermeld op dit afschrift.
+ bijBedrag:
+ type: number
+ format: float
+ description: Totaal bedrag bij op dit afschrift.
+ eindsaldo:
+ type: number
+ format: float
+ description: Eindsaldo vermeld op dit afschrift.
+ postenAantal:
+ type: integer
+ format: int32
+ description: Aantal posten.
+ rekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- betalingskenmerk:
- type: string
- format: any
- description: Betalingskenmerk van bijvoorbeeld acceptgiro of kwitantienummer.
- betalingsregelingen:
- description: Betalingsregelingen waar de boeking onderdeel van kan zijn.
- type: array
- items:
- $ref: '#/components/schemas/Betalingsregeling'
- boekingdetails:
- description: De boekingdetails behorende bij de boeking.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail'
- btwAangiftes:
- description: De btw aangiftes behorend bij deze factuur.
- type: array
- items:
- $ref: '#/components/schemas/BtwAangifte'
- btwBedrag:
- type: number
- format: float
- description: Totaal Bedrag btw.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw hoog voor op aangifte btw.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw laag voor op aangifte btw.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- crediteur:
- allOf:
- - $ref: '#/components/schemas/Crediteur'
- description: De crediteur van de boeking.
- debiteur:
- allOf:
- - $ref: '#/components/schemas/Debiteur'
- description: De debiteur van de boeking.
- externeIncassos:
- description: Externe incassos waar de boeking onderdeel van kan zijn.
- type: array
- items:
- $ref: '#/components/schemas/ExterneIncasso'
- grootboekmutatie:
- allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
- description: De grootboekmutatie behorende bij de boeking.
- huurgeschil:
- type: string
- format: uri
- description: Referentie naar Huurgeschil in informatiedomein Overeenkomsten
- incassomachtiging:
- allOf:
- - $ref: '#/components/schemas/Incassomachtiging'
- description: De incassomachtiging behorende bij de boeking.
- incassoOpdracht:
- allOf:
- - $ref: '#/components/schemas/IncassoOpdracht'
- description: Incasso opdracht waar de boeking aan gekoppeld is.
- organisatieBetaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- overeenkomst:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ relatie:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- saldo:
- type: number
- format: float
- description: Het saldo of openstaande bedrag van de boeking.
- verbijzondering:
- allOf:
- - $ref: '#/components/schemas/Verbijzondering'
- description: Verbijzondering van de boeking.
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -11273,7 +11268,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -11285,7 +11280,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -11321,7 +11316,7 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Aflettering-sleutels:
+ BankafschriftRegel-sleutels:
type: object
properties:
id:
@@ -11339,7 +11334,7 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
BankafschriftRegelbericht:
allOf:
- $ref: '#/components/schemas/BankafschriftRegel'
@@ -11381,11 +11376,11 @@ components:
description: Bedrag bij.
bankafschrift:
allOf:
- - $ref: '#/components/schemas/Bankafschrift'
+ - $ref: '#/components/schemas/Bankafschrift-sleutels'
description: Het bankafschrift waarvan de bankafschriftregel onderdeel is.
betaalopdracht:
allOf:
- - $ref: '#/components/schemas/Betaalopdracht'
+ - $ref: '#/components/schemas/Betaalopdracht-sleutels'
description: De Betaalopdracht die gekoppeld is aan de bankafschriftregel.
betalingskenmerk:
type: string
@@ -11404,21 +11399,97 @@ components:
description: De inkoopfactuurbetalingen behorende bij deze bankafschriftregel.
type: array
items:
- $ref: '#/components/schemas/Factuurbetaling'
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
incassoOpdrachten:
description: Incasso opdrachten waar de bankafschriftregel aan gekoppeld is.
type: array
items:
- $ref: '#/components/schemas/IncassoOpdracht'
+ $ref: '#/components/schemas/IncassoOpdracht-sleutels'
rekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- Bankafschriftbericht:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ Bankafschrift-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Betaalopdracht-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Factuurbetaling-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ IncassoOpdracht-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Begrotingbericht:
allOf:
- - $ref: '#/components/schemas/Bankafschrift'
+ - $ref: '#/components/schemas/Begroting'
- $ref: '#/components/schemas/Bericht-basis'
- Bankafschrift:
+ Begroting:
type: object
properties:
id:
@@ -11436,49 +11507,76 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- status:
+ description: De omschrijving van het gegeven.
+ periode:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Status van het afschrift: ingelezen/verwerkt. Referentiedatasoort BANKAFSCHRIFTSTATUS.'
- afBedrag:
- type: number
- format: float
- description: Totaal bedrag af op dit afschrift.
- bankafschriftRegels:
- description: De bankafschriftregels van het bankafschrift.
- type: array
- items:
- $ref: '#/components/schemas/BankafschriftRegel-sleutels'
- beginsaldo:
- type: number
- format: float
- description: Beginsaldo vermeld op dit afschrift.
- bijBedrag:
+ - $ref: '#/components/schemas/BoekjaarPeriode-sleutels'
+ description: De periode van deze begroting.
+ creditbedrag:
type: number
format: float
- description: Totaal bedrag bij op dit afschrift.
- eindsaldo:
+ description: Bedrag debet.
+ debetbedrag:
type: number
format: float
- description: Eindsaldo vermeld op dit afschrift.
- postenAantal:
- type: integer
- format: int32
- description: Aantal posten.
- rekening:
+ description: Bedrag credit.
+ grootboekrekeningen:
+ description: De grootboekrekeningen van deze begroting (collectie type).
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ verbijzonderingen:
+ description: De verbijzonderingen van bij deze begroting.
+ type: array
+ items:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ versie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De versieaanduiding van de begroting, bijvoorbeeld;Oorspronkelijk budget, Mutatiebudget, etc. Referentiedatasoort BEGROTINGVERSIE.
+ BoekjaarPeriode-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- relatie:
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- BankafschriftRegel-sleutels:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Grootboekrekening-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Verbijzondering-sleutels:
type: object
properties:
id:
@@ -11549,12 +11647,12 @@ components:
description: De inkoopfactuurbetalingen behorende bij de betaalopdracht.
type: array
items:
- $ref: '#/components/schemas/Factuurbetaling'
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
grootboekmutaties:
description: De grootboekmutaties behorende bij de betaalopdracht.
type: array
items:
- $ref: '#/components/schemas/Grootboekmutatie'
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
postenAantal:
type: integer
format: int32
@@ -11562,12 +11660,8 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- Factuurbetalingbericht:
- allOf:
- - $ref: '#/components/schemas/Factuurbetaling'
- - $ref: '#/components/schemas/Bericht-basis'
- Factuurbetaling:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ Grootboekmutatie-sleutels:
type: object
properties:
id:
@@ -11585,61 +11679,63 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- omschrijving:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Betaalwijzebericht:
+ allOf:
+ - $ref: '#/components/schemas/Betaalwijze'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Betaalwijze:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van de betaling, bijvoorbeeld betaald of te verwerken. Referentiedatasoort FACTUURSTATUS.
- datum:
+ description: De wijze van incasso waarop de huurovereenkomst wordt betaald. Referentiedatasoort BETAALWIJZESOORT.
+ begindatum:
type: string
format: date
- description: Datum van de betaling.
- bankafschriftRegel:
+ description: De begindatum van de betaalwijze.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de betaalwijze.
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ deelsoort:
allOf:
- - $ref: '#/components/schemas/BankafschriftRegel-sleutels'
- description: De bankafschriftregel waarop deze factuurbetaling is vermeld.
- bedrag:
- type: number
- format: float
- description: Bedrag van de betaling.
- betaalkenmerk:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De verdeelsleutel waarmee de vergoeding van de overeenkomst betaald moet worden over één of meerdere betalers, bijvoorbeeld percentueel. Referentiedatasoort BETAALWIJZEDEELSOORT.
+ deelwaarde:
type: string
format: any
- description: Betalingskenmerk.
- betaalopdracht:
+ description: Het (maximale) bedrag of het percentage van het totaal die via deze betaalwijze betaald moet worden.
+ incassomachtiging:
allOf:
- - $ref: '#/components/schemas/Betaalopdracht-sleutels'
- description: De betaalopdracht van deze factuurbetaling.
- facturen:
- description: De factuur van deze factuurbetaling.
- type: array
- items:
- $ref: '#/components/schemas/Factuur'
- grootboekmutatie:
+ - $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ description: De digitale machtiging voor het uitvoeren van de incassoopdrachten. SEPA.
+ incassomoment:
allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
- description: De grootboekmutatie behorende bij de factuurbetaling.
- kortingsbedrag:
- type: number
- format: float
- description: Genomen korting.
- rekening:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- rekeningBetaling:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- volgnummerInBetaalopdracht:
- type: integer
- format: int32
- description: Het volgnummer van de betaling binnen de betaalopdracht.
- Betaalopdracht-sleutels:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het moment waarop de incasso wordt gedaan. Referentiedatasoort INCASSOMOMENT.
+ Incassomachtiging-sleutels:
type: object
properties:
id:
@@ -11657,8 +11753,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Factuur-basis:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
+ Betalingsregelingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Betalingsregeling'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Betalingsregeling:
type: object
properties:
id:
@@ -11677,148 +11777,91 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Soort van de factuur: Inkoopfactuur of Verkoopfactuur. Referentiedatasoort FACTUURSOORT.'
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
+ description: Omschrijving van het gegeven.
+ toelichting:
+ type: string
+ format: any
+ description: Nadere toelichting waarin extra informatie met betrekking tot de betalingsregeling kan worden opgenomen (memo, opmerkingen).
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De status van de factuur. Bijv. Goedgekeurd, Geblokkeerd, Betaald, Gedeeltelijk betaald etc. Referentiedatasoort INKOOPFACTUURSTATUS.
- ontvangstdatum:
- type: string
- format: date
- description: Datum waarop de factuur is ontvangen.
- boekdatum:
- type: string
- format: date
- description: Datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- factuurdatum:
+ description: 'Status van de betalingsregeling. Voorbeeld: actief, bevroren, geannuleerd, enzovoort. Referentiedatasoort BETALINGSREGELINGSTATUS.'
+ begindatum:
type: string
format: date
- description: Factuurdatum van de factuur.
- plandatum:
+ description: Datum waarop de regeling is of wordt gestart.
+ einddatum:
type: string
format: date
- description: Geplande datum voor betaling van de factuur.
- vervaldatum:
+ description: Datum waarop de regeling is of wordt beëindigd.
+ afspraakdatum:
type: string
format: date
- description: De datum waarop de factuur uiterlijk betaald dient te zijn.
+ description: Datum waarop de regeling is overeengekomen.
bedrag:
type: number
format: float
- description: Bedrag van de factuur.
+ description: Het initiele bedrag van de betalingsregeling.
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
betaalwijze:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De betaalwijze van de factuur. Bijv. Contant, Op rekening, Automatische incasso etc. Referentiedatasoort FACTUURBETAALWIJZE.
- betalingAkkoord:
- type: boolean
- description: Gefiatteerd voor betaling.
- betalingskenmerk:
- type: string
- format: any
- description: Betalingskenmerk van de factuur.
- btwAangifte:
+ - $ref: '#/components/schemas/Betaalwijze-sleutels'
+ description: De afgesproken betaalwijze voor de betalingsregeling.
+ boekingen:
+ description: De boekingen behorende bij de betalingsregeling.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ debiteur:
allOf:
- - $ref: '#/components/schemas/BtwAangifte'
- description: De btw aangifte behorend bij deze factuur
- btwBedrag:
- type: number
- format: float
- description: Totale btw bedrag op de factuur.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw hoog voor op aangifte btw.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagAangiftebedrag:
- type: number
- format: float
- description: Bedrag btw laag voor op aangifte btw.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- btwTerugTeVorderen:
- type: boolean
- description: btw terug te vorderen ja/nee.
- btwVerlegd:
- type: boolean
- description: btw verlegd ja/nee.
- correctiesoort:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur voor wie de betalingsregeling is opgesteld.
+ eindeReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort correctie op de factuur. Bijv. intern, extern. Referentiedatasoort CORRECTIESOORT.
- externFactuurnummer:
+ description: 'Reden dat de betalingsregeling is beëindigd. Voorbeeld: voldaan, enzovoort. Referentiedatasoort BETALINGSREGELINGEINDEREDEN.'
+ incassowijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Wijze van incasso waarop de betalingsregeling wordt betaald. OBSOLETE Referentiedatasoort INCASSOWIJZE.
+ deprecated: true
+ organisatieBetaalgegeven:
type: string
- format: any
- description: Extern factuurnummer van de factuur.
- factuurbetalingen:
- description: De betalingen behorende bij de factuur.
- type: array
- items:
- $ref: '#/components/schemas/Factuurbetaling-sleutels'
- factuurGeblokkeerd:
- type: boolean
- description: Geblokkeerd ja/nee.
- factuurregels:
- description: De factuurregels behorende bij deze factuur.
- type: array
- items:
- $ref: '#/components/schemas/Factuurregel'
- gRekeningbedrag:
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ prolongatieInterval:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: De interval die aangeeft na hoeveel tijd er wordt geprolongeerd op de betalingsregeling.
+ prolongatieTotDatum:
+ type: string
+ format: date
+ description: De betalingsregeling is geprolongeerd tot deze datum.
+ saldo:
type: number
format: float
- description: Bedrag G rekening.
- grootboekmutaties:
- description: De grootboekmutaties behorende bij deze factuur.
+ description: Het saldo of openstaande bedrag van de betalingsregeling.
+ termijnen:
+ description: De betalingsregeling termijnen behorende bij de betalingsregeling.
type: array
items:
- $ref: '#/components/schemas/Grootboekmutatie'
- korting:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Korting die wordt gegeven op het factuurbedrag.
- openstaandBedrag:
+ $ref: '#/components/schemas/BetalingsregelingTermijn-sleutels'
+ termijnenAantal:
type: number
format: float
- description: Bedrag dat nog openstaat op de factuur.
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- toeslag:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Toeslag die in rekening wordt gebracht op het factuurbedrag.
- BtwAangiftebericht:
- allOf:
- - $ref: '#/components/schemas/BtwAangifte'
- - $ref: '#/components/schemas/Bericht-basis'
- BtwAangifte:
+ description: Het aantal termijnen waaruit de betalingsregeling bestaat.
+ Betaalwijze-sleutels:
type: object
properties:
id:
@@ -11837,51 +11880,26 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- omschrijving:
+ Debiteur-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de btw aangifte, bijvoorbeeld Voorlopig, In Behandeling. Referentiedatasoort BTWAANGIFTESTATUS.
- datum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: Datum aangifte.
- begindatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: Datum vanaf de btw op de aangifte wordt opgenomen.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: date
- description: Datum tot en met de btw op de aangifte wordt opgenomen.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf'
- description: Het bedrijf van de btw aangifte.
- boekingen:
- description: De boekingen van de btw aangifte.
- type: array
- items:
- $ref: '#/components/schemas/Boeking-sleutels'
- facturen:
- description: De creditfacturen van de btw aangifte.
- type: array
- items:
- $ref: '#/components/schemas/Factuur-sleutels'
- inkoopfacturen:
- description: De inkoopfacturen van de btw aangifte. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/Inkoopfactuur'
- deprecated: true
- FinancieelBedrijfbericht:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf'
- - $ref: '#/components/schemas/Bericht-basis'
- FinancieelBedrijf:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BetalingsregelingTermijn-sleutels:
type: object
properties:
id:
@@ -11899,76 +11917,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft het type van het bedrijf aan: VVE, TI, servicebedrijf. Referentiedatasoort BEDRIJFSOORT.'
- naam:
- type: string
- format: any
- description: De naam van het bedrijf.
- betaalcyclusDuur:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: Geeft de duur aan die benodigd is voor het betaalproces.
- boekjaren:
- description: De boekjaren btw behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Boekjaar'
- btwAangiftes:
- description: De aangifte btw behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/BtwAangifte-sleutels'
- consolidatieBedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Geeft aan in welk bedrijf dit bedrijf geconsolideerd is.
- crediteuren:
- description: De crediteuren behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Crediteur'
- debiteuren:
- description: De debiteuren behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Debiteur'
- deelnemingspercentage:
- type: number
- format: float
- description: Indien het een deelname betreft bevat dit het percentage deelname.
- geconsolideerdebedrijven:
- description: Geeft aan welke bedrijven in dit bedrijf geconsolideerd zijn.
- type: array
- items:
- $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- grootboekrekeningen:
- description: De grootboekrekeningen behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Grootboekrekening'
- maatschappelijkLabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het label waarmee wordt aangegeven of de activiteiten die binnen het financieel bedrijf worden verricht verantwoord worden als zijnde DAEB- of niet-DAEB-activiteiten. Als sprake is van een verbinding kan het financieel bedrijf ook het label ‘Geconsolideerde NIET-DAEB verbinding’ hebben. Referentiedatasoort MAATSCHAPPELIJKLABEL.
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- verbijzonderingen:
- description: De verbijzonderingen behorende bij het financieel bedrijf.
- type: array
- items:
- $ref: '#/components/schemas/Verbijzondering'
- Boekjaarbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BetalingsregelingTermijnbericht:
allOf:
- - $ref: '#/components/schemas/Boekjaar'
+ - $ref: '#/components/schemas/BetalingsregelingTermijn'
- $ref: '#/components/schemas/Bericht-basis'
- Boekjaar:
+ BetalingsregelingTermijn:
type: object
properties:
id:
@@ -11990,33 +11944,32 @@ components:
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
+ description: Omschrijving van het gegeven.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van het boekjaar, bijvoorbeeld;open, geblokkeerd, gesloten. Referentiedatasoort BOEKJAARSTATUS.
- begindatum:
+ description: Status van de termijn, bv. openstaand, betaald. Referentiedatasoort BETALINGSREGELINGTERMIJNSTATUS.
+ datum:
type: string
format: date
- description: Begindatum van het boekjaar.
- einddatum:
+ description: Datum waarop de termijn betaald is.
+ vervaldatum:
type: string
format: date
- description: Einddatum van het boekjaar.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Het bedrijf waarvoor dit boekjaar.
- boekjaarperiodes:
- description: De boekjaarperiodes behorende bij het boekjaar.
- type: array
- items:
- $ref: '#/components/schemas/BoekjaarPeriode'
- periodeSoort:
+ description: Vervaldatum van de termijn.
+ bedrag:
+ type: number
+ format: float
+ description: Initiële bedrag van de termijn.
+ betalingsregeling:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort periode waarin het boekjaar is ingedeeld, bijvoorbeeld;maand, week, 4-week, etc. Referentiedatasoort BOEKJAARPERIODESOORT.
- FinancieelBedrijf-sleutels:
+ - $ref: '#/components/schemas/Betalingsregeling-sleutels'
+ description: Betalingsregeling waaraan de termijn is gekoppeld.
+ saldo:
+ type: number
+ format: float
+ description: Het saldo of openstaande bedrag van de termijn.
+ Betalingsregeling-sleutels:
type: object
properties:
id:
@@ -12034,12 +11987,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- BoekjaarPeriodebericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Boekingbericht:
allOf:
- - $ref: '#/components/schemas/BoekjaarPeriode'
+ - $ref: '#/components/schemas/Boeking'
- $ref: '#/components/schemas/Bericht-basis'
- BoekjaarPeriode:
+ Boeking:
type: object
properties:
id:
@@ -12061,95 +12014,157 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De soort boekjaarperiode, bijvoorbeeld Week, Maand, Jaar. Referentiedatasoort BOEKJAARPERIODESOORT.
+ description: Soort boeking. Bijvoorbeeld;vordering, ontvangst of uitbetaling. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Detaillering van het soort boeking. Bijvoorbeeld;storno, kasbetaling, acceptgiro, enzovoort. Boekingsoorten en boekingdetailsoorten kunnen in allerlei combinaties voorkomen;er is geen vaste hiërarchie. Referentiedatasoort BOEKINGDETAILSOORT.
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
+ description: Omschrijving van de boeking.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van de periode, bijvoorbeeld;open, geblokkeerd. Referentiedatasoort BOEKJAARPERIODESTATUS.
- begindatum:
+ description: Status van de boeking. Bijvoorbeeld;voorlopig, gefiatteerd. Referentiedatasoort BOEKINGSTATUS.
+ boekdatum:
type: string
format: date
- description: De begindatum van de periode.
- einddatum:
+ description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ factuurdatum:
type: string
format: date
- description: De einddatum van de periode.
- begrotingen:
- description: De begroting behorende bij de periode.
- type: array
- items:
- $ref: '#/components/schemas/Begroting'
- boekjaar:
- allOf:
- - $ref: '#/components/schemas/Boekjaar-sleutels'
- description: Het boekjaar waarbinnen deze periode valt.
- boekjaarperiodesaldos:
- description: Het boekjaarperiodesaldo van de periode.
- type: array
- items:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo'
- Begrotingbericht:
- allOf:
- - $ref: '#/components/schemas/Begroting'
- - $ref: '#/components/schemas/Bericht-basis'
- Begroting:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ description: Boekstuk- of factuurdatum van de boeking.
+ valutadatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ format: date
+ description: Valutadatum van de boeking.
+ vervaldatum:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
- omschrijving:
+ format: date
+ description: Vervaldatum van de boeking.
+ kortingsdatum:
type: string
- format: any
- description: De omschrijving van het gegeven.
- periode:
+ format: date
+ description: Kortingsdatum.
+ aflettering:
allOf:
- - $ref: '#/components/schemas/BoekjaarPeriode-sleutels'
- description: De periode van deze begroting.
- creditbedrag:
- type: number
- format: float
- description: Bedrag debet.
- debetbedrag:
- type: number
- format: float
- description: Bedrag credit.
- grootboekrekeningen:
- description: De grootboekrekeningen van deze begroting (collectie type).
- type: array
- items:
- $ref: '#/components/schemas/Grootboekrekening'
- verbijzonderingen:
- description: De verbijzonderingen van bij deze begroting.
+ - $ref: '#/components/schemas/Aflettering-sleutels'
+ description: De grondslag aflettering behorende bij de boeking.
+ afletteringen:
+ description: De afletteringen behorende bij de boeking.
type: array
items:
- $ref: '#/components/schemas/Verbijzondering'
- versie:
+ $ref: '#/components/schemas/Aflettering-sleutels'
+ bankafschriftRegel:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De versieaanduiding van de begroting, bijvoorbeeld;Oorspronkelijk budget, Mutatiebudget, etc. Referentiedatasoort BEGROTINGVERSIE.
- BoekjaarPeriode-sleutels:
- type: object
- properties:
- id:
- type: string
+ - $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ description: De bankafschriftregel waaraan de boeking gekoppeld is.
+ bedrag:
+ type: number
+ format: float
+ description: Het initiele bedrag van de boeking (inclusief btw).
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ betalingskenmerk:
+ type: string
+ format: any
+ description: Betalingskenmerk van bijvoorbeeld acceptgiro of kwitantienummer.
+ betalingsregelingen:
+ description: Betalingsregelingen waar de boeking onderdeel van kan zijn.
+ type: array
+ items:
+ $ref: '#/components/schemas/Betalingsregeling-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de boeking.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
+ btwAangiftes:
+ description: De btw aangiftes behorend bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/BtwAangifte-sleutels'
+ btwBedrag:
+ type: number
+ format: float
+ description: Totaal Bedrag btw.
+ btwGeenGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw hoog voor op aangifte btw.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw laag voor op aangifte btw.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ crediteur:
+ allOf:
+ - $ref: '#/components/schemas/Crediteur-sleutels'
+ description: De crediteur van de boeking.
+ debiteur:
+ allOf:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur van de boeking.
+ externeIncassos:
+ description: Externe incassos waar de boeking onderdeel van kan zijn.
+ type: array
+ items:
+ $ref: '#/components/schemas/ExterneIncasso-sleutels'
+ grootboekmutatie:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ description: De grootboekmutatie behorende bij de boeking.
+ huurgeschil:
+ type: string
+ format: uri
+ description: Referentie naar Huurgeschil-sleutels in informatiedomein Overeenkomsten
+ incassomachtiging:
+ allOf:
+ - $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ description: De incassomachtiging behorende bij de boeking.
+ incassoOpdracht:
+ allOf:
+ - $ref: '#/components/schemas/IncassoOpdracht-sleutels'
+ description: Incasso opdracht waar de boeking aan gekoppeld is.
+ organisatieBetaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ saldo:
+ type: number
+ format: float
+ description: Het saldo of openstaande bedrag van de boeking.
+ verbijzondering:
+ allOf:
+ - $ref: '#/components/schemas/Verbijzondering-sleutels'
+ description: Verbijzondering van de boeking.
+ Aflettering-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
format: any
description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
idExtern:
@@ -12164,11 +12179,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Grootboekrekeningbericht:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening'
- - $ref: '#/components/schemas/Bericht-basis'
- Grootboekrekening:
+ Boekingdetail-sleutels:
type: object
properties:
id:
@@ -12186,56 +12197,27 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Aanduiding van de soort grootboekrekening. Administraties kunnen verschillen in indeling en detaillering. De referentiedata wordt gevormd door het ReferentieGrootboekSchema (RGS) zoals gepubliceerd op https://www.referentiegrootboekschema.nl/kbase?field_category_target_id=27 (Kennisbank). Voorbeelden: *B – Balans *BIva – Immateriële vaste activa *BIvaKouVvp – Verkrijgings- of vervaardigingsprijs Referentiedatasoort GROOTBOEKREKENINGSOORT.'
- omschrijving:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BtwAangifte-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de rekening, bijvoorbeeld;actief, historisch. Referentiedatasoort GROOTBOEKREKENINGSTATUS.
- begindatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De begindatum waarop geboekt mag worden op de grootboekrekening.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: De einddatum waarop geboekt mag worden op de grootboekrekening.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Het bedrijf van deze grootboekrekening.
- begrotingen:
- description: De begrotingen behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/Begroting-sleutels'
- boekingdetails:
- description: De boekingdetails behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail'
- boekjaarperiodesaldos:
- description: De boekjaarperiodesaldi behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo'
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels behorende bij de grootboekrekening.
- type: array
- items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- referentiegrootboekschemacode:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
format: any
- description: De verwijzing naar de code in het referentiegrootboekschema.
- Begroting-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Crediteur-sleutels:
type: object
properties:
id:
@@ -12253,7 +12235,26 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ ExterneIncasso-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
Boekingdetailbericht:
allOf:
- $ref: '#/components/schemas/Boekingdetail'
@@ -12299,11 +12300,11 @@ components:
description: Bedrag btw op deze regel
btwTarief:
allOf:
- - $ref: '#/components/schemas/BtwTarief'
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
description: Het btw tarief van dit boekingdetail (hoog, laag, geen of nul).
grootboekmutatie:
allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
description: De grootboekmutatie behorende bij het boekingdetail.
grootboekrekening:
allOf:
@@ -12319,9 +12320,9 @@ components:
description: Prijs per meeteenheid.
verbijzondering:
allOf:
- - $ref: '#/components/schemas/Verbijzondering'
+ - $ref: '#/components/schemas/Verbijzondering-sleutels'
description: Verbijzondering van de boekingdetail.
- Boeking-sleutels:
+ BtwTarief-sleutels:
type: object
properties:
id:
@@ -12340,11 +12341,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- BtwTariefbericht:
+ Boekjaarbericht:
allOf:
- - $ref: '#/components/schemas/BtwTarief'
+ - $ref: '#/components/schemas/Boekjaar'
- $ref: '#/components/schemas/Bericht-basis'
- BtwTarief:
+ Boekjaar:
type: object
properties:
id:
@@ -12366,41 +12367,33 @@ components:
omschrijving:
type: string
format: any
- description: Omschrijving van het tarief, bijvoorbeeld;hoog, laag, geen, nul.
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van het boekjaar, bijvoorbeeld;open, geblokkeerd, gesloten. Referentiedatasoort BOEKJAARSTATUS.
begindatum:
type: string
format: date
- description: Datum waarop het tarief voorhet type ingaat.
+ description: Begindatum van het boekjaar.
einddatum:
type: string
format: date
- description: Datum waarop het tarief voorhet type eindigt.
- boekingdetails:
- description: De btw tarieven van de boekingdetails.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail-sleutels'
- factuurregels:
- description: De btw tarieven van de inkoopfactuurregels.
- type: array
- items:
- $ref: '#/components/schemas/Factuurregel'
- grootboekmutaties:
- description: De btw tarieven van de grootboekmutaties.
- type: array
- items:
- $ref: '#/components/schemas/Grootboekmutatie'
- inkoopfactuurregels:
- description: De btw tarieven van de inkoopfactuurregels. OBSOLETE
+ description: Einddatum van het boekjaar.
+ bedrijf:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf waarvoor dit boekjaar.
+ boekjaarperiodes:
+ description: De boekjaarperiodes behorende bij het boekjaar.
type: array
items:
- $ref: '#/components/schemas/InkoopfactuurRegel'
- deprecated: true
- percentage:
- type: number
- format: float
- description: Het btw percentage van het tarief.
- Boekingdetail-sleutels:
+ $ref: '#/components/schemas/BoekjaarPeriode-sleutels'
+ periodeSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort periode waarin het boekjaar is ingedeeld, bijvoorbeeld;maand, week, 4-week, etc. Referentiedatasoort BOEKJAARPERIODESOORT.
+ FinancieelBedrijf-sleutels:
type: object
properties:
id:
@@ -12418,8 +12411,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurregel-basis:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ BoekjaarPeriodebericht:
+ allOf:
+ - $ref: '#/components/schemas/BoekjaarPeriode'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BoekjaarPeriode:
type: object
properties:
id:
@@ -12438,45 +12435,41 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De soort boekjaarperiode, bijvoorbeeld Week, Maand, Jaar. Referentiedatasoort BOEKJAARPERIODESOORT.
omschrijving:
type: string
format: any
description: De omschrijving van het gegeven.
- bedrag:
- type: number
- format: float
- description: Bedrag.
- btwAangiftebedrag:
- type: number
- format: float
- description: Aangiftebedrag btw op deze regel.
- btwTarief:
+ status:
allOf:
- - $ref: '#/components/schemas/BtwTarief-sleutels'
- description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen of nul.
- grootboekmutaties:
- description: De grootboekmutaties behorende bij de factuurregel.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de periode, bijvoorbeeld;open, geblokkeerd. Referentiedatasoort BOEKJAARPERIODESTATUS.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de periode.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de periode.
+ begrotingen:
+ description: De begroting behorende bij de periode.
type: array
items:
- $ref: '#/components/schemas/Grootboekmutatie'
- grootboekrekening:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening-sleutels'
- description: Het rekeningnummer.
- korting:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Korting die wordt gegeven op het factuurregelbedrag.
- toeslag:
+ $ref: '#/components/schemas/Begroting-sleutels'
+ boekjaar:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- description: Toeslag die in rekening wordt gebracht op het factuurregelbedrag.
- verbijzonderingen:
- description: Verbijzondering van de grootboekboeking.
+ - $ref: '#/components/schemas/Boekjaar-sleutels'
+ description: Het boekjaar waarbinnen deze periode valt.
+ boekjaarperiodesaldos:
+ description: Het boekjaarperiodesaldo van de periode.
type: array
items:
- $ref: '#/components/schemas/Verbijzondering'
- BtwTarief-sleutels:
+ $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ Begroting-sleutels:
type: object
properties:
id:
@@ -12494,12 +12487,8 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Grootboekmutatiebericht:
- allOf:
- - $ref: '#/components/schemas/Grootboekmutatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Grootboekmutatie:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken.)
+ Boekjaar-sleutels:
type: object
properties:
id:
@@ -12517,121 +12506,26 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BoekjaarPeriodesaldo-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van het gegeven.
- boekdatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- betaalopdrachten:
- description: De betaalopdracht behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Betaalopdracht-sleutels'
- boekingdetails:
- description: De boekingdetails behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Boekingdetail-sleutels'
- boekingen:
- description: De boekingen behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Boeking-sleutels'
- boekjaarPeriodesaldo:
- allOf:
- - $ref: '#/components/schemas/BoekjaarPeriodesaldo'
- description: Het saldo van de periode waarop deze grootboekmutatie betrekking heeft.
- boekstuknummer:
- type: integer
- format: int32
- description: Nummer van het boekstuk waarin deze mutatie is ontstaan.
- boekstuknummerCode:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: Tijdelijke constructie om boekstuknummers door te geven die geen nummers zijn. In volgende major versie wordt dit opgeheven en veranderd attribuut boekstuknummer naar string.
- boekstukregel:
- type: integer
- format: int32
- description: Het regelnummer binnen het boekstuk waarin deze mutatie is ontstaan.
- btwBedrag:
- type: number
- format: float
- description: Btw-bedrag op de mutatie.
- btwTarieven:
- description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen, nul.
- type: array
- items:
- $ref: '#/components/schemas/BtwTarief-sleutels'
- creditbedrag:
- type: number
- format: float
- description: Bedrag credit.
- debetbedrag:
- type: number
- format: float
- description: Bedrag debet.
- facturen:
- description: De creditfacturen behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Factuur-sleutels'
- factuurbetalingen:
- description: De factuurbetalingen behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Factuurbetaling-sleutels'
- factuurregels:
- description: De factuurregels behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Factuurregel-sleutels'
- grootboekrekening:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening-sleutels'
- description: De grootboekrekening waarop de mutatie wordt geboekt.
- herkomst:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft de herkomst van de grootboekmutatie aan: memo, subadministratie etc. Referentiedatasoort GROOTBOEKMUTATIEHERKOMST.'
- incassoOpdrachten:
- description: De incasso opdrachten behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/IncassoOpdracht'
- inkoopfacturen:
- description: De inkoopfacturen behorende bij de grootboekmutatie. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/Inkoopfactuur'
- deprecated: true
- inkoopfactuurRegels:
- description: De inkoopfactuurregels behorende bij de grootboekmutatie. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/InkoopfactuurRegel'
- deprecated: true
- inkoopopdrachten:
- description: De inkoopopdrachten behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/Inkoopopdracht'
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels behorende bij de grootboekmutatie.
- type: array
- items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- verbijzondering:
- allOf:
- - $ref: '#/components/schemas/Verbijzondering'
- description: Verbijzondering van de grootboekmutatie.
- volgnummer:
- type: integer
- format: int32
- description: Volgnummer van de grootboekmutatie.
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
BoekjaarPeriodesaldobericht:
allOf:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo'
@@ -12680,8 +12574,12 @@ components:
description: De verbijzonderingen van dit periodesaldo.
type: array
items:
- $ref: '#/components/schemas/Verbijzondering'
- Grootboekmutatie-sleutels:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ BtwAangiftebericht:
+ allOf:
+ - $ref: '#/components/schemas/BtwAangifte'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BtwAangifte:
type: object
properties:
id:
@@ -12699,8 +12597,48 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Grootboekrekening-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de btw aangifte, bijvoorbeeld Voorlopig, In Behandeling. Referentiedatasoort BTWAANGIFTESTATUS.
+ datum:
+ type: string
+ format: date
+ description: Datum aangifte.
+ begindatum:
+ type: string
+ format: date
+ description: Datum vanaf de btw op de aangifte wordt opgenomen.
+ einddatum:
+ type: string
+ format: date
+ description: Datum tot en met de btw op de aangifte wordt opgenomen.
+ bedrijf:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf van de btw aangifte.
+ boekingen:
+ description: De boekingen van de btw aangifte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ facturen:
+ description: De creditfacturen van de btw aangifte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuur-sleutels'
+ inkoopfacturen:
+ description: De inkoopfacturen van de btw aangifte. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ deprecated: true
+ Factuur-sleutels:
type: object
properties:
id:
@@ -12718,12 +12656,31 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Verbijzonderingbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Inkoopfactuur-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ BtwTariefbericht:
allOf:
- - $ref: '#/components/schemas/Verbijzondering'
+ - $ref: '#/components/schemas/BtwTarief'
- $ref: '#/components/schemas/Bericht-basis'
- Verbijzondering:
+ BtwTarief:
type: object
properties:
id:
@@ -12741,80 +12698,45 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft het soort verbijzondering aan, bijvoorbeeld;kostenplaats, kostensoort, dimensie. Referentiedatasoort VERBIJZONDERINGSOORT.
- detailsoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Optionele nadere verbijzondering van de verbijzonderingsoort Dimensie. Hier kan een eigen dimensiesoort, waarvoor geen referentiedata voor Verbijzondering bestaat, worden toegevoegd. Referentiedatasoort VERBIJZONDERINGDETAILSOORT.
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de verbijzondering. Referentiedatasoort VERBIJZONDERINGSTATUS.
- beginjaar:
- type: integer
- format: int32
- description: Open vanaf jaar, bepaalt de periode waarin geboekt mag worden.
- beginperiode:
- type: integer
- format: int32
- description: Open vanaf periode, bepaalt de periode waarin geboekt mag worden.
- eindjaar:
- type: integer
- format: int32
- description: Open t/m jaar, bepaalt de periode waarin geboekt mag worden.
- eindperiode:
- type: integer
- format: int32
- description: Open t/m periode, bepaalt de periode waarin geboekt mag worden.
- bedrijf:
- allOf:
- - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Het bedrijf van deze verbijzondering.
- begrotingen:
- description: De begroting behorende bij de verbijzondering.
- type: array
- items:
- $ref: '#/components/schemas/Begroting-sleutels'
- boeking:
- description: De boekingen behorende bij de verbijzondering.
- type: array
- items:
- $ref: '#/components/schemas/Boeking-sleutels'
+ description: Omschrijving van het tarief, bijvoorbeeld;hoog, laag, geen, nul.
+ begindatum:
+ type: string
+ format: date
+ description: Datum waarop het tarief voorhet type ingaat.
+ einddatum:
+ type: string
+ format: date
+ description: Datum waarop het tarief voorhet type eindigt.
boekingdetails:
- description: De boekingdetails behorende bij de verbijzondering.
+ description: De btw tarieven van de boekingdetails.
type: array
items:
$ref: '#/components/schemas/Boekingdetail-sleutels'
- boekjaarperiodesaldos:
- description: Het boekjaarperiodesaldo van de verbijzondering.
+ factuurregels:
+ description: De btw tarieven van de inkoopfactuurregels.
type: array
items:
- $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ $ref: '#/components/schemas/Factuurregel-sleutels'
grootboekmutaties:
- description: De grootboekmutaties behorende bij de verbijzondering.
+ description: De btw tarieven van de grootboekmutaties.
type: array
items:
$ref: '#/components/schemas/Grootboekmutatie-sleutels'
inkoopfactuurregels:
- description: De inkoopfactuurregels behorende bij de verbijzondering.
+ description: De btw tarieven van de inkoopfactuurregels. OBSOLETE
type: array
items:
- $ref: '#/components/schemas/InkoopfactuurRegel'
- viaMemoriaalBoekenToestaan:
- type: boolean
- description: Boeking via memoriaal toegestaan ja/nee.
- viaSubBoekenToestaan:
- type: boolean
- description: Boeking via sub toegestaan ja/nee.
- BoekjaarPeriodesaldo-sleutels:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ deprecated: true
+ percentage:
+ type: number
+ format: float
+ description: Het btw percentage van het tarief.
+ Factuurregel-sleutels:
type: object
properties:
id:
@@ -12833,30 +12755,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- InkoopfactuurRegelbericht:
- allOf:
- - $ref: '#/components/schemas/InkoopfactuurRegel'
- - $ref: '#/components/schemas/Bericht-basis'
- InkoopfactuurRegel:
- allOf:
- - $ref: '#/components/schemas/Factuurregel-basis'
- - type: object
- properties:
- factuur:
- allOf:
- - $ref: '#/components/schemas/Factuur-sleutels'
- description: De creditfactuur van deze factuurregel.
- inkoopfactuur:
- allOf:
- - $ref: '#/components/schemas/Inkoopfactuur'
- description: De inkoopfactuur van deze inkoopfactuurregel. OBSOLETE
- deprecated: true
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels waar deze inkoopfactuurregel aan gekoppeld is
- type: array
- items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- Factuur-sleutels:
+ InkoopfactuurRegel-sleutels:
type: object
properties:
id:
@@ -12875,40 +12774,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurbericht:
- allOf:
- - $ref: '#/components/schemas/Factuur'
- - $ref: '#/components/schemas/Bericht-basis'
- Factuur:
- oneOf:
- - $ref: '#/components/schemas/Inkoopfactuur'
- - $ref: '#/components/schemas/Verkoopfactuur'
- - $ref: '#/components/schemas/Factuur-basis'
- Inkoopfactuurbericht:
- allOf:
- - $ref: '#/components/schemas/Inkoopfactuur'
- - $ref: '#/components/schemas/Bericht-basis'
- Inkoopfactuur:
- allOf:
- - $ref: '#/components/schemas/Factuur-basis'
- - type: object
- properties:
- ontvangstdatum:
- type: string
- format: date
- description: Datum waarop de factuur is ontvangen.
- crediteur:
- allOf:
- - $ref: '#/components/schemas/Crediteur'
- description: De crediteur van deze factuur.
- inkoopopdracht:
- allOf:
- - $ref: '#/components/schemas/Inkoopopdracht'
- description: De inkoopopdracht waaraan deze factuur gekoppeld is.
- rekening:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
Crediteurbericht:
allOf:
- $ref: '#/components/schemas/Crediteur'
@@ -12972,7 +12837,7 @@ components:
gRekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
gRekeningPercentage:
type: number
format: float
@@ -12987,7 +12852,7 @@ components:
description: De inkoopopdrachten van de crediteur.
type: array
items:
- $ref: '#/components/schemas/Inkoopopdracht'
+ $ref: '#/components/schemas/Inkoopopdracht-sleutels'
kortingdagen:
type: integer
format: int32
@@ -12997,11 +12862,11 @@ components:
items:
type: string
format: uri
- description: Referenties naar Betaalgegeven in informatiedomein Relaties
+ description: Referenties naar Betaalgegeven-sleutels in informatiedomein Relaties
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
saldo:
type: number
format: float
@@ -13025,7 +12890,7 @@ components:
wkaRegeling:
type: boolean
description: Geeft aan of de crediteur onder de WKA regeling valt.
- Inkoopfactuur-sleutels:
+ Inkoopopdracht-sleutels:
type: object
properties:
id:
@@ -13043,12 +12908,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Inkoopopdrachtbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Debiteurbericht:
allOf:
- - $ref: '#/components/schemas/Inkoopopdracht'
+ - $ref: '#/components/schemas/Debiteur'
- $ref: '#/components/schemas/Bericht-basis'
- Inkoopopdracht:
+ Debiteur:
type: object
properties:
id:
@@ -13066,102 +12931,59 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
- type: string
- format: any
- description: De omschrijving van het gegeven.
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Soort debiteur: huurder, gemeente, etc. Referentiedatasoort DEBITEURSOORT.'
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De status van de inkoopopdracht. Referentiedatasoort INKOOPOPDRACHTSTATUS.
- opdrachtdatum:
- type: string
- format: date
- description: De datum waarop de opdracht is verstrekt.
- boekdatum:
- type: string
- format: date
- description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- crediteur:
+ description: Status van de debiteur, bijvoorbeeld;geblokkeerd, alleen voor betalen, etc. Referentiedatasoort DEBITEURSTATUS.
+ bedrijf:
allOf:
- - $ref: '#/components/schemas/Crediteur-sleutels'
- description: De crediteur van deze inkoopopdracht.
- facturen:
- description: De creditfacturen behorende bij deze inkoopopdracht.
- type: array
- items:
- $ref: '#/components/schemas/Factuur-sleutels'
- grootboekmutaties:
- description: De grootboekmutaties behorende bij deze inkoopopdracht.
- type: array
- items:
- $ref: '#/components/schemas/Grootboekmutatie-sleutels'
- inkoopfacturen:
- description: De inkoopfacturen behorende bij deze inkoopopdracht. OBSOLETE
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Bedrijf gekoppeld aan de debiteur.
+ boekingen:
+ description: De boekingen van de debiteur.
type: array
items:
- $ref: '#/components/schemas/Inkoopfactuur-sleutels'
- deprecated: true
- inkoopopdrachtregels:
- description: De inkoopopdrachtregels behorende bij deze inkoopopdracht.
+ $ref: '#/components/schemas/Boeking-sleutels'
+ btwPlichtig:
+ type: boolean
+ description: Geeft aan of de debiteur btw plichtig is ja/nee.
+ incassomachtigingen:
+ description: De incassomachtigingen van de debiteur.
type: array
items:
- $ref: '#/components/schemas/InkoopopdrachtRegel'
- onderhoudsorder:
- type: string
- format: uri
- description: Referentie naar Onderhoudsorder in informatiedomein Onderhoud
- projectorders:
+ $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ kortingsdagen:
+ type: integer
+ format: int32
+ description: Aantal dagen waarin de debiteur de korting van het factuurbedrag mag aftrekken.
+ rekeningen:
type: array
items:
type: string
format: uri
- description: Referenties naar Projectorder in informatiedomein Projectontwikkeling
+ description: Referenties naar Betaalgegeven-sleutels in informatiedomein Relaties
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- Crediteur-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- InkoopopdrachtRegelbericht:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ saldo:
+ type: number
+ format: float
+ description: Openstaand saldo.
+ vervaltermijn:
+ type: integer
+ format: int32
+ description: Standaard vervaltermijn voor uit te sturen facturen in dagen.
+ ExterneIncassobericht:
allOf:
- - $ref: '#/components/schemas/InkoopopdrachtRegel'
+ - $ref: '#/components/schemas/ExterneIncasso'
- $ref: '#/components/schemas/Bericht-basis'
- InkoopopdrachtRegel:
+ ExterneIncasso:
type: object
properties:
id:
@@ -13179,61 +13001,68 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Soort externe incasso. Bijvoorbeeld: deurwaarder, incassobureau. Referentiedatasoort EXTERNEINCASSOSOORT.'
omschrijving:
type: string
format: any
- description: De omschrijving van het gegeven.
- soort:
+ description: Omschrijving van het gegeven.
+ status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan welk soort inkoopopdrachtregel het betreft. Bijv. Meerwerk, Minderwerk, Initieel etc. Referentiedatasoort INKOOPOPDRACHTREGELSOORT.
- plandatum:
+ description: 'Status van de externe incasso. Bijvoorbeeld: lopend, afgesloten, bevroren. Referentiedatasoort EXTERNEINCASSOSTATUS.'
+ begindatum:
type: string
format: date
- description: Plandatum voor betaling.
- btwGeenGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover geen btw zal worden berekend.
- btwHoogGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
- btwLaagGrondslagbedrag:
- type: number
- format: float
- description: Bedrag van de opdracht waarover laag btw zal worden berekend.
- btwNulGrondslagbedrag:
+ description: Datum waarop het is gestart.
+ einddatum:
+ type: string
+ format: date
+ description: Datum waarop het is afgesloten.
+ overdrachtsdatum:
+ type: string
+ format: date
+ description: Datum waarop is overgedragen.
+ bedrag:
type: number
format: float
- description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
- btwTarief:
- allOf:
- - $ref: '#/components/schemas/BtwTarief-sleutels'
- description: Het BTW-tarief dat van toepassing is op de inkoopopdrachtregel.
- grootboekmutatie:
- allOf:
- - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
- description: De grootboekmutaties behorende bij deze inkoopopdrachtregel.
- grootboekrekening:
- allOf:
- - $ref: '#/components/schemas/Grootboekrekening-sleutels'
- description: De grootboekrekening behorende bij deze inkoopopdrachtregel.
- inkoopfactuurregels:
- description: De inkoopfactuurregels behorende bij deze inkoopopdrachtregel.
+ description: Het bedrag dat is overgedragen.
+ boekingen:
+ description: De boekingen behorende bij de externe incasso.
type: array
items:
- $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
- inkoopopdracht:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ debiteur:
allOf:
- - $ref: '#/components/schemas/Inkoopopdracht-sleutels'
- description: De inkoopopdracht van deze inkoopopdrachtregel.
- onderhoudsTaak:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur waaraan de boeking gekoppeld is.
+ externeincassoacties:
+ description: De externe incasso acties behorende bij de externe incasso
+ type: array
+ items:
+ $ref: '#/components/schemas/ExterneIncassoActie-sleutels'
+ overeenkomst:
type: string
format: uri
- description: Referentie naar Onderhoudstaak in informatiedomein Onderhoud
- InkoopfactuurRegel-sleutels:
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ saldo:
+ type: number
+ format: float
+ description: Het saldo of openstaande bedrag.
+ ExterneIncassoActie-sleutels:
type: object
properties:
id:
@@ -13252,7 +13081,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Inkoopopdracht-sleutels:
+ ExterneIncassoActiebericht:
+ allOf:
+ - $ref: '#/components/schemas/ExterneIncassoActie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ ExterneIncassoActie:
type: object
properties:
id:
@@ -13270,8 +13103,36 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Factuurbetaling-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort actie. Referentiedatasoort EXTERNEINCASSOACTIESOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: Omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de actie. Referentiedatasoort EXTERNEINCASSOACTIESTATUS.
+ begindatum:
+ type: string
+ format: date
+ description: Datum en tijd waarop de actie is gestart.
+ einddatum:
+ type: string
+ format: date
+ description: Datum en tijd waarop de actie is beeindigd.
+ externeIncasso:
+ allOf:
+ - $ref: '#/components/schemas/ExterneIncasso-sleutels'
+ description: Externe incasso waartoe de actie behoort.
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ Factuur-basis:
type: object
properties:
id:
@@ -13290,7 +13151,150 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurregel-sleutels:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Soort van de factuur: Inkoopfactuur of Verkoopfactuur. Referentiedatasoort FACTUURSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de factuur. Bijv. Goedgekeurd, Geblokkeerd, Betaald, Gedeeltelijk betaald etc. Referentiedatasoort INKOOPFACTUURSTATUS.
+ ontvangstdatum:
+ type: string
+ format: date
+ description: Datum waarop de factuur is ontvangen.
+ boekdatum:
+ type: string
+ format: date
+ description: Datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ factuurdatum:
+ type: string
+ format: date
+ description: Factuurdatum van de factuur.
+ plandatum:
+ type: string
+ format: date
+ description: Geplande datum voor betaling van de factuur.
+ vervaldatum:
+ type: string
+ format: date
+ description: De datum waarop de factuur uiterlijk betaald dient te zijn.
+ bedrag:
+ type: number
+ format: float
+ description: Bedrag van de factuur.
+ betaalwijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De betaalwijze van de factuur. Bijv. Contant, Op rekening, Automatische incasso etc. Referentiedatasoort FACTUURBETAALWIJZE.
+ betalingAkkoord:
+ type: boolean
+ description: Gefiatteerd voor betaling.
+ betalingskenmerk:
+ type: string
+ format: any
+ description: Betalingskenmerk van de factuur.
+ btwAangifte:
+ allOf:
+ - $ref: '#/components/schemas/BtwAangifte-sleutels'
+ description: De btw aangifte behorend bij deze factuur
+ btwBedrag:
+ type: number
+ format: float
+ description: Totale btw bedrag op de factuur.
+ btwGeenGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw hoog voor op aangifte btw.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagAangiftebedrag:
+ type: number
+ format: float
+ description: Bedrag btw laag voor op aangifte btw.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ btwTerugTeVorderen:
+ type: boolean
+ description: btw terug te vorderen ja/nee.
+ btwVerlegd:
+ type: boolean
+ description: btw verlegd ja/nee.
+ correctiesoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort correctie op de factuur. Bijv. intern, extern. Referentiedatasoort CORRECTIESOORT.
+ externFactuurnummer:
+ type: string
+ format: any
+ description: Extern factuurnummer van de factuur.
+ factuurbetalingen:
+ description: De betalingen behorende bij de factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
+ factuurGeblokkeerd:
+ type: boolean
+ description: Geblokkeerd ja/nee.
+ factuurregels:
+ description: De factuurregels behorende bij deze factuur. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurregel-sleutels'
+ deprecated: true
+ gRekeningbedrag:
+ type: number
+ format: float
+ description: Bedrag G rekening.
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ korting:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Korting die wordt gegeven op het factuurbedrag.
+ openstaandBedrag:
+ type: number
+ format: float
+ description: Bedrag dat nog openstaat op de factuur.
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ regels:
+ description: De factuurregels behorende bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurregel-sleutels'
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ toeslag:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Toeslag die in rekening wordt gebracht op het factuurbedrag.
+ Prijsaanpassing-sleutels:
type: object
properties:
id:
@@ -13308,20 +13312,21 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Factuurregelbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Factuurbericht:
allOf:
- - $ref: '#/components/schemas/Factuurregel'
+ - $ref: '#/components/schemas/Factuur'
- $ref: '#/components/schemas/Bericht-basis'
- Factuurregel:
+ Factuur:
oneOf:
- - $ref: '#/components/schemas/InkoopfactuurRegel'
- - $ref: '#/components/schemas/Factuurregel-basis'
- IncassoOpdrachtbericht:
+ - $ref: '#/components/schemas/Inkoopfactuur'
+ - $ref: '#/components/schemas/Verkoopfactuur'
+ - $ref: '#/components/schemas/Factuur-basis'
+ Factuurbetalingbericht:
allOf:
- - $ref: '#/components/schemas/IncassoOpdracht'
+ - $ref: '#/components/schemas/Factuurbetaling'
- $ref: '#/components/schemas/Bericht-basis'
- IncassoOpdracht:
+ Factuurbetaling:
type: object
properties:
id:
@@ -13339,62 +13344,61 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- aanmaakdatum:
- type: string
- format: date
- description: Aanmaakdatum van de opdracht
- fiatdatum:
- type: string
- format: date
- description: Datum gefiatteerd voor verzenden
- plandatum:
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de betaling, bijvoorbeeld betaald of te verwerken. Referentiedatasoort FACTUURSTATUS.
+ datum:
type: string
format: date
- description: Plandatum van afschrijven
- bankafschriftRegels:
- description: De bankafschrift regels behorende bij de incasso opdracht
- type: array
- items:
- $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ description: Datum van de betaling.
+ bankafschriftRegel:
+ allOf:
+ - $ref: '#/components/schemas/BankafschriftRegel-sleutels'
+ description: De bankafschriftregel waarop deze factuurbetaling is vermeld.
bedrag:
type: number
format: float
- description: Totaalbedrag te ontvangen in deze opdracht.
- boekingen:
- description: De boekingen behorende bij de incasso opdracht
+ description: Bedrag van de betaling.
+ betaalkenmerk:
+ type: string
+ format: any
+ description: Betalingskenmerk.
+ betaalopdracht:
+ allOf:
+ - $ref: '#/components/schemas/Betaalopdracht-sleutels'
+ description: De betaalopdracht van deze factuurbetaling.
+ facturen:
+ description: De factuur van deze factuurbetaling.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
+ $ref: '#/components/schemas/Factuur-sleutels'
grootboekmutatie:
allOf:
- $ref: '#/components/schemas/Grootboekmutatie-sleutels'
- description: De grootboekmutatie behorende bij de incasso opdracht
- postenAantal:
- type: integer
- format: int32
- description: Aantal posten in deze opdracht
+ description: De grootboekmutatie behorende bij de factuurbetaling.
+ kortingsbedrag:
+ type: number
+ format: float
+ description: Genomen korting.
rekening:
type: string
format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- relatie:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ rekeningBetaling:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- saldo:
- type: number
- format: float
- description: Het (nog) niet ontvangen bedrag in deze opdracht.
- Prijsaanpassingbericht:
- allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
- - $ref: '#/components/schemas/Bericht-basis'
- Prijsaanpassing:
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ volgnummerInBetaalopdracht:
+ type: integer
+ format: int32
+ description: Het volgnummer van de betaling binnen de betaalopdracht.
+ Factuurregel-basis:
type: object
properties:
id:
@@ -13412,66 +13416,58 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort prijsaanpassing: Korting of toeslag Referentiedatasoort PRIJSAANPASSINGSOORT.'
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
omschrijving:
type: string
format: any
- description: Tekstveld met een omschrijving of nadere specificatie van het soort toeslag of korting.
+ description: De omschrijving van het gegeven.
bedrag:
type: number
format: float
- description: Het bedrag dat extra in rekening wordt gebracht, of de korting die wordt gegeven, op het factuur(regel)bedrag.
- percentage:
+ description: Bedrag.
+ btwAangiftebedrag:
type: number
format: float
- description: Getal waarmee de hoogte van de toeslag of korting wordt gespecificeerd in procenten van het totale regelbedrag of de totale regelhoeveelheid. Dit gegeven wordt alleen ter informatie meegegeven.
- Boekjaar-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- BtwAangifte-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Debiteurbericht:
+ description: Aangiftebedrag btw op deze regel.
+ btwTarief:
+ allOf:
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
+ description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen of nul.
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij de factuurregel.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ grootboekrekening:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ description: Het rekeningnummer.
+ korting:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Korting die wordt gegeven op het factuurregelbedrag.
+ toeslag:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
+ description: Toeslag die in rekening wordt gebracht op het factuurregelbedrag.
+ verbijzonderingen:
+ description: Verbijzondering van de grootboekboeking.
+ type: array
+ items:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ Factuurregelbericht:
allOf:
- - $ref: '#/components/schemas/Debiteur'
+ - $ref: '#/components/schemas/Factuurregel'
- $ref: '#/components/schemas/Bericht-basis'
- Debiteur:
+ Factuurregel:
+ oneOf:
+ - $ref: '#/components/schemas/InkoopfactuurRegel'
+ - $ref: '#/components/schemas/Factuurregel-basis'
+ FinancieelBedrijfbericht:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf'
+ - $ref: '#/components/schemas/Bericht-basis'
+ FinancieelBedrijf:
type: object
properties:
id:
@@ -13489,59 +13485,76 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Soort debiteur: huurder, gemeente, etc. Referentiedatasoort DEBITEURSOORT.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de debiteur, bijvoorbeeld;geblokkeerd, alleen voor betalen, etc. Referentiedatasoort DEBITEURSTATUS.
- bedrijf:
+ description: 'Geeft het type van het bedrijf aan: VVE, TI, servicebedrijf. Referentiedatasoort BEDRIJFSOORT.'
+ naam:
+ type: string
+ format: any
+ description: De naam van het bedrijf.
+ betaalcyclusDuur:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: Geeft de duur aan die benodigd is voor het betaalproces.
+ boekjaren:
+ description: De boekjaren btw behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekjaar-sleutels'
+ btwAangiftes:
+ description: De aangifte btw behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/BtwAangifte-sleutels'
+ consolidatieBedrijf:
allOf:
- $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
- description: Bedrijf gekoppeld aan de debiteur.
- boekingen:
- description: De boekingen van de debiteur.
+ description: Geeft aan in welk bedrijf dit bedrijf geconsolideerd is.
+ crediteuren:
+ description: De crediteuren behorende bij het financieel bedrijf.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
- btwPlichtig:
- type: boolean
- description: Geeft aan of de debiteur btw plichtig is ja/nee.
- incassomachtigingen:
- description: De incassomachtigingen van de debiteur.
+ $ref: '#/components/schemas/Crediteur-sleutels'
+ debiteuren:
+ description: De debiteuren behorende bij het financieel bedrijf.
type: array
items:
- $ref: '#/components/schemas/Incassomachtiging'
- kortingsdagen:
- type: integer
- format: int32
- description: Aantal dagen waarin de debiteur de korting van het factuurbedrag mag aftrekken.
- rekeningen:
+ $ref: '#/components/schemas/Debiteur-sleutels'
+ deelnemingspercentage:
+ type: number
+ format: float
+ description: Indien het een deelname betreft bevat dit het percentage deelname.
+ geconsolideerdebedrijven:
+ description: Geeft aan welke bedrijven in dit bedrijf geconsolideerd zijn.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Betaalgegeven in informatiedomein Relaties
+ $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ grootboekrekeningen:
+ description: De grootboekrekeningen behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ maatschappelijkLabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het label waarmee wordt aangegeven of de activiteiten die binnen het financieel bedrijf worden verricht verantwoord worden als zijnde DAEB- of niet-DAEB-activiteiten. Als sprake is van een verbinding kan het financieel bedrijf ook het label ‘Geconsolideerde NIET-DAEB verbinding’ hebben. Referentiedatasoort MAATSCHAPPELIJKLABEL.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- saldo:
- type: number
- format: float
- description: Openstaand saldo.
- vervaltermijn:
- type: integer
- format: int32
- description: Standaard vervaltermijn voor uit te sturen facturen in dagen.
- Incassomachtigingbericht:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ verbijzonderingen:
+ description: De verbijzonderingen behorende bij het financieel bedrijf.
+ type: array
+ items:
+ $ref: '#/components/schemas/Verbijzondering-sleutels'
+ Grootboekmutatiebericht:
allOf:
- - $ref: '#/components/schemas/Incassomachtiging'
+ - $ref: '#/components/schemas/Grootboekmutatie'
- $ref: '#/components/schemas/Bericht-basis'
- Incassomachtiging:
+ Grootboekmutatie:
type: object
properties:
id:
@@ -13559,57 +13572,122 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Soort machtiging: doorlopend/eenmalig. Referentiedatasoort MACHTIGINGSOORT.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de machtiging/ Bijv. Actief, Ingetrokken, . Referentiedatasoort MACHTIGINGSTATUS.
- begindatum:
- type: string
- format: date
- description: De begindatum van de incassomachtiging.
- einddatum:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ omschrijving:
type: string
- format: date
- description: De einddatum van de incassomachtiging.
- afgiftedatum:
+ format: any
+ description: De omschrijving van het gegeven.
+ boekdatum:
type: string
format: date
- description: De afgiftedatum van de machtiging
+ description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ betaalopdrachten:
+ description: De betaalopdracht behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Betaalopdracht-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
boekingen:
- description: De boekingen behorende bij de incassomachtiging.
+ description: De boekingen behorende bij de grootboekmutatie.
type: array
items:
$ref: '#/components/schemas/Boeking-sleutels'
- debiteur:
+ boekjaarPeriodesaldo:
allOf:
- - $ref: '#/components/schemas/Debiteur-sleutels'
- description: De debiteur van de machtiging.
- incassantId:
- type: string
- format: any
- description: Het incassantId van de machtiging.
- kenmerkMachtiging:
- type: string
- format: any
- description: Het kenmerk machtiging waarin het doel van de machtiging staat beschreven. Bijvoorbeeld inschrijving regio Almere.
- machtigingsnummer:
+ - $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ description: Het saldo van de periode waarop deze grootboekmutatie betrekking heeft.
+ boekstuknummer:
+ type: integer
+ format: int32
+ description: Nummer van het boekstuk waarin deze mutatie is ontstaan.
+ boekstuknummerCode:
type: string
format: any
- description: Het nummer van de machtiging.
- maximumBedrag:
+ description: Tijdelijke constructie om boekstuknummers door te geven die geen nummers zijn. In volgende major versie wordt dit opgeheven en veranderd attribuut boekstuknummer naar string.
+ boekstukregel:
+ type: integer
+ format: int32
+ description: Het regelnummer binnen het boekstuk waarin deze mutatie is ontstaan.
+ btwBedrag:
type: number
format: float
- description: Het maximale bedrag dat per incasso geincasseerd mag worden.
- rekening:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- Debiteur-sleutels:
+ description: Btw-bedrag op de mutatie.
+ btwTarieven:
+ description: Btw-tarief dat op de mutatie van toepassing is, bijvoorbeeld;hoog, laag, geen, nul.
+ type: array
+ items:
+ $ref: '#/components/schemas/BtwTarief-sleutels'
+ creditbedrag:
+ type: number
+ format: float
+ description: Bedrag credit.
+ debetbedrag:
+ type: number
+ format: float
+ description: Bedrag debet.
+ facturen:
+ description: De creditfacturen behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuur-sleutels'
+ factuurbetalingen:
+ description: De factuurbetalingen behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurbetaling-sleutels'
+ factuurregels:
+ description: De factuurregels behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Factuurregel-sleutels'
+ grootboekrekening:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ description: De grootboekrekening waarop de mutatie wordt geboekt.
+ herkomst:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Geeft de herkomst van de grootboekmutatie aan: memo, subadministratie etc. Referentiedatasoort GROOTBOEKMUTATIEHERKOMST.'
+ incassoOpdrachten:
+ description: De incasso opdrachten behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/IncassoOpdracht-sleutels'
+ inkoopfacturen:
+ description: De inkoopfacturen behorende bij de grootboekmutatie. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ deprecated: true
+ inkoopfactuurRegels:
+ description: De inkoopfactuurregels behorende bij de grootboekmutatie. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ deprecated: true
+ inkoopopdrachten:
+ description: De inkoopopdrachten behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopopdracht-sleutels'
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels behorende bij de grootboekmutatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ verbijzondering:
+ allOf:
+ - $ref: '#/components/schemas/Verbijzondering-sleutels'
+ description: Verbijzondering van de grootboekmutatie.
+ volgnummer:
+ type: integer
+ format: int32
+ description: Volgnummer van de grootboekmutatie.
+ InkoopopdrachtRegel-sleutels:
type: object
properties:
id:
@@ -13627,12 +13705,12 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Betalingsregelingbericht:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Grootboekrekeningbericht:
allOf:
- - $ref: '#/components/schemas/Betalingsregeling'
+ - $ref: '#/components/schemas/Grootboekrekening'
- $ref: '#/components/schemas/Bericht-basis'
- Betalingsregeling:
+ Grootboekrekening:
type: object
properties:
id:
@@ -13650,96 +13728,60 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Aanduiding van de soort grootboekrekening. Administraties kunnen verschillen in indeling en detaillering. De referentiedata wordt gevormd door het ReferentieGrootboekSchema (RGS) zoals gepubliceerd op https://www.referentiegrootboekschema.nl/kbase?field_category_target_id=27 (Kennisbank). Voorbeelden: *B – Balans *BIva – Immateriële vaste activa *BIvaKouVvp – Verkrijgings- of vervaardigingsprijs Referentiedatasoort GROOTBOEKREKENINGSOORT.'
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- toelichting:
- type: string
- format: any
- description: Nadere toelichting waarin extra informatie met betrekking tot de betalingsregeling kan worden opgenomen (memo, opmerkingen).
+ description: De omschrijving van het gegeven.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Status van de betalingsregeling. Voorbeeld: actief, bevroren, geannuleerd, enzovoort. Referentiedatasoort BETALINGSREGELINGSTATUS.'
+ description: Status van de rekening, bijvoorbeeld;actief, historisch. Referentiedatasoort GROOTBOEKREKENINGSTATUS.
begindatum:
type: string
format: date
- description: Datum waarop de regeling is of wordt gestart.
+ description: De begindatum waarop geboekt mag worden op de grootboekrekening.
einddatum:
type: string
format: date
- description: Datum waarop de regeling is of wordt beëindigd.
- afspraakdatum:
- type: string
- format: date
- description: Datum waarop de regeling is overeengekomen.
- bedrag:
- type: number
- format: float
- description: Het initiele bedrag van de betalingsregeling.
- betaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- betaalwijze:
+ description: De einddatum waarop geboekt mag worden op de grootboekrekening.
+ bedrijf:
allOf:
- - $ref: '#/components/schemas/Betaalwijze'
- description: De afgesproken betaalwijze voor de betalingsregeling.
- boekingen:
- description: De boekingen behorende bij de betalingsregeling.
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf van deze grootboekrekening.
+ begrotingen:
+ description: De begrotingen behorende bij de grootboekrekening.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
- debiteur:
- allOf:
- - $ref: '#/components/schemas/Debiteur'
- description: De debiteur voor wie de betalingsregeling is opgesteld.
- eindeReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Reden dat de betalingsregeling is beëindigd. Voorbeeld: voldaan, enzovoort. Referentiedatasoort BETALINGSREGELINGEINDEREDEN.'
- incassowijze:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Wijze van incasso waarop de betalingsregeling wordt betaald. OBSOLETE Referentiedatasoort INCASSOWIJZE.
- deprecated: true
- organisatieBetaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- overeenkomst:
- type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- prolongatieInterval:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: De interval die aangeeft na hoeveel tijd er wordt geprolongeerd op de betalingsregeling.
- prolongatieTotDatum:
- type: string
- format: date
- description: De betalingsregeling is geprolongeerd tot deze datum.
- saldo:
- type: number
- format: float
- description: Het saldo of openstaande bedrag van de betalingsregeling.
- termijnen:
- description: De betalingsregeling termijnen behorende bij de betalingsregeling.
+ $ref: '#/components/schemas/Begroting-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de grootboekrekening.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
+ boekjaarperiodesaldos:
+ description: De boekjaarperiodesaldi behorende bij de grootboekrekening.
type: array
items:
- $ref: '#/components/schemas/BetalingsregelingTermijn'
- termijnenAantal:
- type: number
- format: float
- description: Het aantal termijnen waaruit de betalingsregeling bestaat.
- Betaalwijzebericht:
+ $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels behorende bij de grootboekrekening.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ referentiegrootboekschemacode:
+ type: string
+ format: any
+ description: De verwijzing naar de code in het referentiegrootboekschema.
+ Incassomachtigingbericht:
allOf:
- - $ref: '#/components/schemas/Betaalwijze'
+ - $ref: '#/components/schemas/Incassomachtiging'
- $ref: '#/components/schemas/Bericht-basis'
- Betaalwijze:
+ Incassomachtiging:
type: object
properties:
id:
@@ -13757,44 +13799,61 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De wijze van incasso waarop de huurovereenkomst wordt betaald. Referentiedatasoort BETAALWIJZESOORT.
+ description: 'Soort machtiging: doorlopend/eenmalig. Referentiedatasoort MACHTIGINGSOORT.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de machtiging/ Bijv. Actief, Ingetrokken, . Referentiedatasoort MACHTIGINGSTATUS.
begindatum:
type: string
format: date
- description: De begindatum van de betaalwijze.
+ description: De begindatum van de incassomachtiging.
einddatum:
type: string
format: date
- description: De einddatum van de betaalwijze.
- betaalgegeven:
+ description: De einddatum van de incassomachtiging.
+ afgiftedatum:
type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- deelsoort:
+ format: date
+ description: De afgiftedatum van de machtiging
+ boekingen:
+ description: De boekingen behorende bij de incassomachtiging.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ debiteur:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De verdeelsleutel waarmee de vergoeding van de overeenkomst betaald moet worden over één of meerdere betalers, bijvoorbeeld percentueel. Referentiedatasoort BETAALWIJZEDEELSOORT.
- deelwaarde:
+ - $ref: '#/components/schemas/Debiteur-sleutels'
+ description: De debiteur van de machtiging.
+ incassantId:
type: string
format: any
- description: Het (maximale) bedrag of het percentage van het totaal die via deze betaalwijze betaald moet worden.
- incassomachtiging:
- allOf:
- - $ref: '#/components/schemas/Incassomachtiging'
- description: De digitale machtiging voor het uitvoeren van de incassoopdrachten. SEPA.
- incassomoment:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het moment waarop de incasso wordt gedaan. Referentiedatasoort INCASSOMOMENT.
- BetalingsregelingTermijnbericht:
+ description: Het incassantId van de machtiging.
+ kenmerkMachtiging:
+ type: string
+ format: any
+ description: Het kenmerk machtiging waarin het doel van de machtiging staat beschreven. Bijvoorbeeld inschrijving regio Almere.
+ machtigingsnummer:
+ type: string
+ format: any
+ description: Het nummer van de machtiging.
+ maximumBedrag:
+ type: number
+ format: float
+ description: Het maximale bedrag dat per incasso geincasseerd mag worden.
+ rekening:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ IncassoOpdrachtbericht:
allOf:
- - $ref: '#/components/schemas/BetalingsregelingTermijn'
+ - $ref: '#/components/schemas/IncassoOpdracht'
- $ref: '#/components/schemas/Bericht-basis'
- BetalingsregelingTermijn:
+ IncassoOpdracht:
type: object
properties:
id:
@@ -13812,59 +13871,110 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
omschrijving:
type: string
format: any
description: Omschrijving van het gegeven.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Status van de termijn, bv. openstaand, betaald. Referentiedatasoort BETALINGSREGELINGTERMIJNSTATUS.
- datum:
+ aanmaakdatum:
type: string
format: date
- description: Datum waarop de termijn betaald is.
- vervaldatum:
+ description: Aanmaakdatum van de opdracht
+ fiatdatum:
type: string
format: date
- description: Vervaldatum van de termijn.
+ description: Datum gefiatteerd voor verzenden
+ plandatum:
+ type: string
+ format: date
+ description: Plandatum van afschrijven
+ bankafschriftRegels:
+ description: De bankafschrift regels behorende bij de incasso opdracht
+ type: array
+ items:
+ $ref: '#/components/schemas/BankafschriftRegel-sleutels'
bedrag:
type: number
format: float
- description: Initiële bedrag van de termijn.
- betalingsregeling:
+ description: Totaalbedrag te ontvangen in deze opdracht.
+ boekingen:
+ description: De boekingen behorende bij de incasso opdracht
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ grootboekmutatie:
allOf:
- - $ref: '#/components/schemas/Betalingsregeling-sleutels'
- description: Betalingsregeling waaraan de termijn is gekoppeld.
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ description: De grootboekmutatie behorende bij de incasso opdracht
+ postenAantal:
+ type: integer
+ format: int32
+ description: Aantal posten in deze opdracht
+ rekening:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
saldo:
type: number
format: float
- description: Het saldo of openstaande bedrag van de termijn.
- Betalingsregeling-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- ExterneIncassobericht:
+ description: Het (nog) niet ontvangen bedrag in deze opdracht.
+ Inkoopfactuurbericht:
allOf:
- - $ref: '#/components/schemas/ExterneIncasso'
+ - $ref: '#/components/schemas/Inkoopfactuur'
- $ref: '#/components/schemas/Bericht-basis'
- ExterneIncasso:
+ Inkoopfactuur:
+ allOf:
+ - $ref: '#/components/schemas/Factuur-basis'
+ - type: object
+ properties:
+ ontvangstdatum:
+ type: string
+ format: date
+ description: Datum waarop de factuur is ontvangen.
+ crediteur:
+ allOf:
+ - $ref: '#/components/schemas/Crediteur-sleutels'
+ description: De crediteur van deze factuur.
+ inkoopopdracht:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopopdracht-sleutels'
+ description: De inkoopopdracht waaraan deze factuur gekoppeld is.
+ rekening:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ InkoopfactuurRegelbericht:
+ allOf:
+ - $ref: '#/components/schemas/InkoopfactuurRegel'
+ - $ref: '#/components/schemas/Bericht-basis'
+ InkoopfactuurRegel:
+ allOf:
+ - $ref: '#/components/schemas/Factuurregel-basis'
+ - type: object
+ properties:
+ factuur:
+ allOf:
+ - $ref: '#/components/schemas/Factuur-sleutels'
+ description: De creditfactuur van deze factuurregel.
+ inkoopfactuur:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ description: De inkoopfactuur van deze inkoopfactuurregel. OBSOLETE
+ deprecated: true
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels waar deze inkoopfactuurregel aan gekoppeld is
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ Inkoopopdrachtbericht:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopopdracht'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Inkoopopdracht:
type: object
properties:
id:
@@ -13882,72 +13992,83 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Soort externe incasso. Bijvoorbeeld: deurwaarder, incassobureau. Referentiedatasoort EXTERNEINCASSOSOORT.'
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
+ description: De omschrijving van het gegeven.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Status van de externe incasso. Bijvoorbeeld: lopend, afgesloten, bevroren. Referentiedatasoort EXTERNEINCASSOSTATUS.'
- begindatum:
- type: string
- format: date
- description: Datum waarop het is gestart.
- einddatum:
+ description: De status van de inkoopopdracht. Referentiedatasoort INKOOPOPDRACHTSTATUS.
+ opdrachtdatum:
type: string
format: date
- description: Datum waarop het is afgesloten.
- overdrachtsdatum:
+ description: De datum waarop de opdracht is verstrekt.
+ boekdatum:
type: string
format: date
- description: Datum waarop is overgedragen.
- bedrag:
+ description: De datum waarmee de mutatie in de boekhouding wordt ingeboekt.
+ btwGeenGrondslagbedrag:
type: number
format: float
- description: Het bedrag dat is overgedragen.
- boekingen:
- description: De boekingen behorende bij de externe incasso.
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ crediteur:
+ allOf:
+ - $ref: '#/components/schemas/Crediteur-sleutels'
+ description: De crediteur van deze inkoopopdracht.
+ facturen:
+ description: De creditfacturen behorende bij deze inkoopopdracht.
type: array
items:
- $ref: '#/components/schemas/Boeking-sleutels'
- debiteur:
- allOf:
- - $ref: '#/components/schemas/Debiteur'
- description: De debiteur waaraan de boeking gekoppeld is.
- externeincassoacties:
- description: De externe incasso acties behorende bij de externe incasso
+ $ref: '#/components/schemas/Factuur-sleutels'
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij deze inkoopopdracht.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ inkoopfacturen:
+ description: De inkoopfacturen behorende bij deze inkoopopdracht. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfactuur-sleutels'
+ deprecated: true
+ inkoopopdrachtregels:
+ description: De inkoopopdrachtregels behorende bij deze inkoopopdracht.
type: array
items:
- $ref: '#/components/schemas/ExterneIncassoActie'
- overeenkomst:
+ $ref: '#/components/schemas/InkoopopdrachtRegel-sleutels'
+ onderhoudsorder:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- overeenkomsten:
+ description: Referentie naar Onderhoudsorder-sleutels in informatiedomein Onderhoud
+ projectorders:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Projectorder-sleutels in informatiedomein Projectontwikkeling
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- saldo:
- type: number
- format: float
- description: Het saldo of openstaande bedrag.
- ExterneIncassoActiebericht:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ InkoopopdrachtRegelbericht:
allOf:
- - $ref: '#/components/schemas/ExterneIncassoActie'
+ - $ref: '#/components/schemas/InkoopopdrachtRegel'
- $ref: '#/components/schemas/Bericht-basis'
- ExterneIncassoActie:
+ InkoopopdrachtRegel:
type: object
properties:
id:
@@ -13965,54 +14086,60 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort actie. Referentiedatasoort EXTERNEINCASSOACTIESOORT.
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
omschrijving:
type: string
format: any
- description: Omschrijving van het gegeven.
- status:
+ description: De omschrijving van het gegeven.
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Status van de actie. Referentiedatasoort EXTERNEINCASSOACTIESTATUS.
- begindatum:
- type: string
- format: date
- description: Datum en tijd waarop de actie is gestart.
- einddatum:
+ description: Geeft aan welk soort inkoopopdrachtregel het betreft. Bijv. Meerwerk, Minderwerk, Initieel etc. Referentiedatasoort INKOOPOPDRACHTREGELSOORT.
+ plandatum:
type: string
format: date
- description: Datum en tijd waarop de actie is beeindigd.
- externeIncasso:
+ description: Plandatum voor betaling.
+ btwGeenGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover geen btw zal worden berekend.
+ btwHoogGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover hoog btw zal worden berekend.
+ btwLaagGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover laag btw zal worden berekend.
+ btwNulGrondslagbedrag:
+ type: number
+ format: float
+ description: Bedrag van de opdracht waarover nul procent btw zal worden berekend.
+ btwTarief:
allOf:
- - $ref: '#/components/schemas/ExterneIncasso-sleutels'
- description: Externe incasso waartoe de actie behoort.
- relatie:
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
+ description: Het BTW-tarief dat van toepassing is op de inkoopopdrachtregel.
+ grootboekmutatie:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ description: De grootboekmutaties behorende bij deze inkoopopdrachtregel.
+ grootboekrekening:
+ allOf:
+ - $ref: '#/components/schemas/Grootboekrekening-sleutels'
+ description: De grootboekrekening behorende bij deze inkoopopdrachtregel.
+ inkoopfactuurregels:
+ description: De inkoopfactuurregels behorende bij deze inkoopopdrachtregel.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ inkoopopdracht:
+ allOf:
+ - $ref: '#/components/schemas/Inkoopopdracht-sleutels'
+ description: De inkoopopdracht van deze inkoopopdrachtregel.
+ onderhoudsTaak:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- ExterneIncasso-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: Referentie naar Onderhoudstaak-sleutels in informatiedomein Onderhoud
Leningbericht:
allOf:
- $ref: '#/components/schemas/Lening'
@@ -14084,7 +14211,7 @@ components:
description: Toegepaste opslag ten opzichte van de Euribor rente.
financier:
allOf:
- - $ref: '#/components/schemas/Crediteur'
+ - $ref: '#/components/schemas/Crediteur-sleutels'
description: De financier van de lening wordt opgenomen als crediteur in de financiële administratie.
nominaalSchuldrestant:
type: number
@@ -14095,7 +14222,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
rentepercentage:
type: number
format: float
@@ -14165,23 +14292,48 @@ components:
description: Totale btw bedrag op de offerte
korting:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: De korting die wordt gegeven op het totale offertebedrag. Een korting kan ook van toepassing zijn op een offerteregel (klasse Offerteregel).
offerteregels:
- description: sleutels
+ description: De offerteregels van de offerte. OBSOLETE
type: array
items:
- $ref: '#/components/schemas/Offerteregel'
+ $ref: '#/components/schemas/Offerteregel-sleutels'
+ deprecated: true
+ regels:
+ description: De offerte regels van de offerte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Offerteregel-sleutels'
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
toeslag:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: Het bedrag dat extra in rekening wordt gebracht op het totale offertebedrag. Een toeslag kan ook van toepassing zijn op een offerteregel (klasse Offerteregel).
+ Offerteregel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Offerteregelbericht:
allOf:
- $ref: '#/components/schemas/Offerteregel'
@@ -14223,11 +14375,11 @@ components:
description: Het soort besteding. Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
btwTarief:
allOf:
- - $ref: '#/components/schemas/BtwTarief'
+ - $ref: '#/components/schemas/BtwTarief-sleutels'
description: Het op de netto prijs van toepassing zijnde BTW tarief. Hiermee kan de bruto prijs worden uitgerekend.
korting:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: De korting die wordt gegeven op het bedrag van de offerteregel. Een korting kan ook van toepassing zijn op het totale offertebedrag (klasse Offerte).
meeteenheid:
allOf:
@@ -14239,7 +14391,7 @@ components:
description: De offerte waar de offerteregel bij hoort.
toeslag:
allOf:
- - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Prijsaanpassing-sleutels'
description: Het bedrag dat extra in rekening wordt gebracht op het bedrag van de offerteregel. Een toeslag kan ook van toepassing zijn op het totale offertebedrag (klasse Offerte.
Offerte-sleutels:
type: object
@@ -14260,6 +14412,45 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Prijsaanpassingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Prijsaanpassing'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Prijsaanpassing:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort prijsaanpassing: Korting of toeslag Referentiedatasoort PRIJSAANPASSINGSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: Tekstveld met een omschrijving of nadere specificatie van het soort toeslag of korting.
+ bedrag:
+ type: number
+ format: float
+ description: Het bedrag dat extra in rekening wordt gebracht, of de korting die wordt gegeven, op het factuur(regel)bedrag.
+ percentage:
+ type: number
+ format: float
+ description: Getal waarmee de hoogte van de toeslag of korting wordt gespecificeerd in procenten van het totale regelbedrag of de totale regelhoeveelheid. Dit gegeven wordt alleen ter informatie meegegeven.
ToegelatenInstellingbericht:
allOf:
- $ref: '#/components/schemas/ToegelatenInstelling'
@@ -14295,6 +14486,101 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Indicatie waarmee wordt aangegeven op welke wijze de TI haar DAEB-activiteiten administratief scheidt van haar eventuele niet-DAEB activiteiten: Verlicht regime, Administratieve scheiding, Juridische scheiding of Hybride Referentiedatasoort VERANTWOORDINGREGIME.'
+ Verbijzonderingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Verbijzondering'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Verbijzondering:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft het soort verbijzondering aan, bijvoorbeeld;kostenplaats, kostensoort, dimensie. Referentiedatasoort VERBIJZONDERINGSOORT.
+ detailsoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Optionele nadere verbijzondering van de verbijzonderingsoort Dimensie. Hier kan een eigen dimensiesoort, waarvoor geen referentiedata voor Verbijzondering bestaat, worden toegevoegd. Referentiedatasoort VERBIJZONDERINGDETAILSOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gegeven.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Status van de verbijzondering. Referentiedatasoort VERBIJZONDERINGSTATUS.
+ beginjaar:
+ type: integer
+ format: int32
+ description: Open vanaf jaar, bepaalt de periode waarin geboekt mag worden.
+ beginperiode:
+ type: integer
+ format: int32
+ description: Open vanaf periode, bepaalt de periode waarin geboekt mag worden.
+ eindjaar:
+ type: integer
+ format: int32
+ description: Open t/m jaar, bepaalt de periode waarin geboekt mag worden.
+ eindperiode:
+ type: integer
+ format: int32
+ description: Open t/m periode, bepaalt de periode waarin geboekt mag worden.
+ bedrijf:
+ allOf:
+ - $ref: '#/components/schemas/FinancieelBedrijf-sleutels'
+ description: Het bedrijf van deze verbijzondering.
+ begrotingen:
+ description: De begroting behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Begroting-sleutels'
+ boeking:
+ description: De boekingen behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boeking-sleutels'
+ boekingdetails:
+ description: De boekingdetails behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Boekingdetail-sleutels'
+ boekjaarperiodesaldos:
+ description: Het boekjaarperiodesaldo van de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/BoekjaarPeriodesaldo-sleutels'
+ grootboekmutaties:
+ description: De grootboekmutaties behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/Grootboekmutatie-sleutels'
+ inkoopfactuurregels:
+ description: De inkoopfactuurregels behorende bij de verbijzondering.
+ type: array
+ items:
+ $ref: '#/components/schemas/InkoopfactuurRegel-sleutels'
+ viaMemoriaalBoekenToestaan:
+ type: boolean
+ description: Boeking via memoriaal toegestaan ja/nee.
+ viaSubBoekenToestaan:
+ type: boolean
+ description: Boeking via sub toegestaan ja/nee.
Verkoopfactuurbericht:
allOf:
- $ref: '#/components/schemas/Verkoopfactuur'
@@ -14310,7 +14596,7 @@ components:
description: Datum waarop de factuur is verzonden.
Debiteur:
allOf:
- - $ref: '#/components/schemas/Debiteur'
+ - $ref: '#/components/schemas/Debiteur-sleutels'
description: De debiteur van deze factuur.
Bericht-basis:
type: object
diff --git a/docs/Informatiedomeinen/Kwaliteit.yaml b/docs/Informatiedomeinen/Kwaliteit.yaml
index 97b937c..b795606 100644
--- a/docs/Informatiedomeinen/Kwaliteit.yaml
+++ b/docs/Informatiedomeinen/Kwaliteit.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://kwaliteit.vera.io:{port}/{basePath}
description: Productieserver
@@ -39,7 +39,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -55,7 +55,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Ophalen van Kwaliteitsmetingsresultaten
+ summary: Ophalen van Kwaliteitsmetingsresultaten
operationId: listKwaliteitsmetingsresultaten
parameters:
- name: params
@@ -105,7 +105,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
operationId: createKwaliteitsmetingsresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -145,7 +145,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsresultaat
parameters:
@@ -180,7 +180,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsresultaat
@@ -217,7 +217,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
operationId: readKwaliteitsmetingsresultaatById
parameters:
- name: id
@@ -254,7 +254,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Vervangen van een Kwaliteitsmetingsresultaat
+ summary: Vervangen van een Kwaliteitsmetingsresultaat
operationId: replaceKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -292,7 +292,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Wijzigen van een Kwaliteitsmetingsresultaat
+ summary: Wijzigen van een Kwaliteitsmetingsresultaat
operationId: updateKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -331,7 +331,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Ophalen van Kwaliteitsmetingsverzoeken
+ summary: Ophalen van Kwaliteitsmetingsverzoeken
operationId: listKwaliteitsmetingsverzoeken
parameters:
- name: params
@@ -381,7 +381,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
operationId: createKwaliteitsmetingsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -421,7 +421,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsverzoek
parameters:
@@ -456,7 +456,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsverzoek
@@ -493,7 +493,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
operationId: readKwaliteitsmetingsverzoekById
parameters:
- name: id
@@ -530,7 +530,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Vervangen van een Kwaliteitsmetingsverzoek
+ summary: Vervangen van een Kwaliteitsmetingsverzoek
operationId: replaceKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -568,7 +568,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Wijzigen van een Kwaliteitsmetingsverzoek
+ summary: Wijzigen van een Kwaliteitsmetingsverzoek
operationId: updateKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -607,7 +607,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Ophalen van Onderzoeksopdrachten
+ summary: Ophalen van Onderzoeksopdrachten
operationId: listOnderzoeksopdrachten
parameters:
- name: params
@@ -657,7 +657,7 @@ paths:
post:
tags:
- 'Onderzoeksopdrachten'
- description: Voegt een nieuw(e) Onderzoeksopdracht toe.
+ summary: Voegt een nieuw(e) Onderzoeksopdracht toe.
operationId: createOnderzoeksopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -697,7 +697,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Vervangen van een Onderzoeksopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksopdracht
parameters:
@@ -732,7 +732,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksopdracht
@@ -769,7 +769,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Retourneert een Onderzoeksopdracht met de gegeven identifier
+ summary: Retourneert een Onderzoeksopdracht met de gegeven identifier
operationId: readOnderzoeksopdrachtById
parameters:
- name: id
@@ -806,7 +806,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: Vervangen van een Onderzoeksopdracht
+ summary: Vervangen van een Onderzoeksopdracht
operationId: replaceOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -844,7 +844,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: Wijzigen van een Onderzoeksopdracht
+ summary: Wijzigen van een Onderzoeksopdracht
operationId: updateOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -883,7 +883,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Ophalen van Onderzoeksresultaten
+ summary: Ophalen van Onderzoeksresultaten
operationId: listOnderzoeksresultaten
parameters:
- name: params
@@ -933,7 +933,7 @@ paths:
post:
tags:
- 'Onderzoeksresultaten'
- description: Voegt een nieuw(e) Onderzoeksresultaat toe.
+ summary: Voegt een nieuw(e) Onderzoeksresultaat toe.
operationId: createOnderzoeksresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -973,7 +973,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Vervangen van een Onderzoeksresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksresultaat
parameters:
@@ -1008,7 +1008,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksresultaat
@@ -1045,7 +1045,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Retourneert een Onderzoeksresultaat met de gegeven identifier
+ summary: Retourneert een Onderzoeksresultaat met de gegeven identifier
operationId: readOnderzoeksresultaatById
parameters:
- name: id
@@ -1082,7 +1082,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: Vervangen van een Onderzoeksresultaat
+ summary: Vervangen van een Onderzoeksresultaat
operationId: replaceOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1120,7 +1120,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: Wijzigen van een Onderzoeksresultaat
+ summary: Wijzigen van een Onderzoeksresultaat
operationId: updateOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1159,7 +1159,7 @@ paths:
get:
tags:
- 'Vragenlijsten'
- description: Ophalen van Vragenlijsten
+ summary: Ophalen van Vragenlijsten
operationId: listVragenlijsten
parameters:
- name: params
@@ -1209,7 +1209,7 @@ paths:
post:
tags:
- 'Vragenlijsten'
- description: Voegt een nieuw(e) Vragenlijst toe.
+ summary: Voegt een nieuw(e) Vragenlijst toe.
operationId: createVragenlijst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1249,7 +1249,7 @@ paths:
put:
tags:
- 'Vragenlijsten'
- description: |
+ summary: |
Vervangen van een Vragenlijst op basis van overeenkomstige sleutelvelden.
operationId: replaceVragenlijst
parameters:
@@ -1284,7 +1284,7 @@ paths:
patch:
tags:
- 'Vragenlijsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Vragenlijst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVragenlijst
@@ -1321,7 +1321,7 @@ paths:
get:
tags:
- 'Vragenlijsten'
- description: Retourneert een Vragenlijst met de gegeven identifier
+ summary: Retourneert een Vragenlijst met de gegeven identifier
operationId: readVragenlijstById
parameters:
- name: id
@@ -1358,7 +1358,7 @@ paths:
put:
tags:
- 'Vragenlijsten'
- description: Vervangen van een Vragenlijst
+ summary: Vervangen van een Vragenlijst
operationId: replaceVragenlijstById
parameters:
- name: 'id'
@@ -1396,7 +1396,7 @@ paths:
patch:
tags:
- 'Vragenlijsten'
- description: Wijzigen van een Vragenlijst
+ summary: Wijzigen van een Vragenlijst
operationId: updateVragenlijstById
parameters:
- name: 'id'
@@ -1435,7 +1435,7 @@ paths:
get:
tags:
- 'VragenlijstAntwoorden'
- description: Ophalen van VragenlijstAntwoorden
+ summary: Ophalen van VragenlijstAntwoorden
operationId: listVragenlijstAntwoorden
parameters:
- name: params
@@ -1485,7 +1485,7 @@ paths:
post:
tags:
- 'VragenlijstAntwoorden'
- description: Voegt een nieuw(e) VragenlijstAntwoord toe.
+ summary: Voegt een nieuw(e) VragenlijstAntwoord toe.
operationId: createVragenlijstAntwoord
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1525,7 +1525,7 @@ paths:
put:
tags:
- 'VragenlijstAntwoorden'
- description: |
+ summary: |
Vervangen van een VragenlijstAntwoord op basis van overeenkomstige sleutelvelden.
operationId: replaceVragenlijstAntwoord
parameters:
@@ -1560,7 +1560,7 @@ paths:
patch:
tags:
- 'VragenlijstAntwoorden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een VragenlijstAntwoord. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVragenlijstAntwoord
@@ -1597,7 +1597,7 @@ paths:
get:
tags:
- 'VragenlijstAntwoorden'
- description: Retourneert een VragenlijstAntwoord met de gegeven identifier
+ summary: Retourneert een VragenlijstAntwoord met de gegeven identifier
operationId: readVragenlijstAntwoordById
parameters:
- name: id
@@ -1634,7 +1634,7 @@ paths:
put:
tags:
- 'VragenlijstAntwoorden'
- description: Vervangen van een VragenlijstAntwoord
+ summary: Vervangen van een VragenlijstAntwoord
operationId: replaceVragenlijstAntwoordById
parameters:
- name: 'id'
@@ -1672,7 +1672,7 @@ paths:
patch:
tags:
- 'VragenlijstAntwoorden'
- description: Wijzigen van een VragenlijstAntwoord
+ summary: Wijzigen van een VragenlijstAntwoord
operationId: updateVragenlijstAntwoordById
parameters:
- name: 'id'
@@ -1711,7 +1711,7 @@ paths:
get:
tags:
- 'VragenlijstRegels'
- description: Ophalen van VragenlijstRegels
+ summary: Ophalen van VragenlijstRegels
operationId: listVragenlijstRegels
parameters:
- name: params
@@ -1761,7 +1761,7 @@ paths:
post:
tags:
- 'VragenlijstRegels'
- description: Voegt een nieuw(e) VragenlijstRegel toe.
+ summary: Voegt een nieuw(e) VragenlijstRegel toe.
operationId: createVragenlijstRegel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1801,7 +1801,7 @@ paths:
put:
tags:
- 'VragenlijstRegels'
- description: |
+ summary: |
Vervangen van een VragenlijstRegel op basis van overeenkomstige sleutelvelden.
operationId: replaceVragenlijstRegel
parameters:
@@ -1836,7 +1836,7 @@ paths:
patch:
tags:
- 'VragenlijstRegels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een VragenlijstRegel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVragenlijstRegel
@@ -1873,7 +1873,7 @@ paths:
get:
tags:
- 'VragenlijstRegels'
- description: Retourneert een VragenlijstRegel met de gegeven identifier
+ summary: Retourneert een VragenlijstRegel met de gegeven identifier
operationId: readVragenlijstRegelById
parameters:
- name: id
@@ -1910,7 +1910,7 @@ paths:
put:
tags:
- 'VragenlijstRegels'
- description: Vervangen van een VragenlijstRegel
+ summary: Vervangen van een VragenlijstRegel
operationId: replaceVragenlijstRegelById
parameters:
- name: 'id'
@@ -1948,7 +1948,7 @@ paths:
patch:
tags:
- 'VragenlijstRegels'
- description: Wijzigen van een VragenlijstRegel
+ summary: Wijzigen van een VragenlijstRegel
operationId: updateVragenlijstRegelById
parameters:
- name: 'id'
@@ -2020,10 +2020,30 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Kwaliteit.All.Read: alleen lezen van alle resources
+ Kwaliteit.All.ReadWrite: lezen en schrijven van alle resources
+ Kwaliteit.Kwaliteitsmetingsresultaten.Read: alleen lezen van Kwaliteitsmetingsresultaten
+ Kwaliteit.Kwaliteitsmetingsresultaten.ReadWrite: lezen en schrijven van Kwaliteitsmetingsresultaten
+ Kwaliteit.Kwaliteitsmetingsverzoeken.Read: alleen lezen van Kwaliteitsmetingsverzoeken
+ Kwaliteit.Kwaliteitsmetingsverzoeken.ReadWrite: lezen en schrijven van Kwaliteitsmetingsverzoeken
+ Kwaliteit.Onderzoeksopdrachten.Read: alleen lezen van Onderzoeksopdrachten
+ Kwaliteit.Onderzoeksopdrachten.ReadWrite: lezen en schrijven van Onderzoeksopdrachten
+ Kwaliteit.Onderzoeksresultaten.Read: alleen lezen van Onderzoeksresultaten
+ Kwaliteit.Onderzoeksresultaten.ReadWrite: lezen en schrijven van Onderzoeksresultaten
+ Kwaliteit.Vragenlijsten.Read: alleen lezen van Vragenlijsten
+ Kwaliteit.Vragenlijsten.ReadWrite: lezen en schrijven van Vragenlijsten
+ Kwaliteit.VragenlijstAntwoorden.Read: alleen lezen van VragenlijstAntwoorden
+ Kwaliteit.VragenlijstAntwoorden.ReadWrite: lezen en schrijven van VragenlijstAntwoorden
+ Kwaliteit.VragenlijstRegels.Read: alleen lezen van VragenlijstRegels
+ Kwaliteit.VragenlijstRegels.ReadWrite: lezen en schrijven van VragenlijstRegels
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Kwaliteit.All.Read: alleen lezen van alle resources
Kwaliteit.All.ReadWrite: lezen en schrijven van alle resources
@@ -2090,11 +2110,11 @@ components:
description: de waarde van de beoordeling op basis van de gespecificeerde beoordelingsSchaal.
kwaliteitsmetingsverzoek:
allOf:
- - $ref: '#/components/schemas/Kwaliteitsmetingsverzoek'
+ - $ref: '#/components/schemas/Kwaliteitsmetingsverzoek-sleutels'
description: Het kwaliteitsmetingsverzoek behorende bij het resultaat.
onderzoeksopdracht:
allOf:
- - $ref: '#/components/schemas/Onderzoeksopdracht'
+ - $ref: '#/components/schemas/Onderzoeksopdracht-sleutels'
description: De onderzoeksopdracht die de basis is voor de analyse en het resultaat van de kwaliteitsmeting.
resultaatReactie:
allOf:
@@ -2130,7 +2150,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -2142,7 +2162,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -2178,6 +2198,44 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ Kwaliteitsmetingsverzoek-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderzoeksopdracht-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Kwaliteitsmetingsverzoekbericht:
allOf:
- $ref: '#/components/schemas/Kwaliteitsmetingsverzoek'
@@ -2216,15 +2274,15 @@ components:
afgerondeZaak:
type: string
format: uri
- description: Referentie naar Zaak in informatiedomein Dossier
+ description: Referentie naar Zaak-sleutels in informatiedomein Dossier
contactmoment:
type: string
format: uri
- description: Referentie naar Contactmoment in informatiedomein Relaties
+ description: Referentie naar Contactmoment-sleutels in informatiedomein Relaties
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
kwaliteitsmetingresultaat:
allOf:
- $ref: '#/components/schemas/Kwaliteitsmetingsresultaat-sleutels'
@@ -2232,25 +2290,25 @@ components:
onderhoudsverzoek:
type: string
format: uri
- description: Referentie naar Onderhoudsverzoek in informatiedomein Onderhoud
+ description: Referentie naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
onderzoeksopdracht:
allOf:
- - $ref: '#/components/schemas/Onderzoeksopdracht'
+ - $ref: '#/components/schemas/Onderzoeksopdracht-sleutels'
description: De onderzoeksopdracht die uitgevoerd is naar aanleiding van het kwaliteitsmetingsverzoek.
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
teEnqueterenRelatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Kwaliteitsmetingsresultaat-sleutels:
type: object
properties:
@@ -2309,11 +2367,11 @@ components:
description: De antwoorden die door de relatie zijn gegeven behorende bij de onderzoeksopdracht.
type: array
items:
- $ref: '#/components/schemas/VragenlijstAntwoord'
+ $ref: '#/components/schemas/VragenlijstAntwoord-sleutels'
contactgegeven:
type: string
format: uri
- description: Referentie naar Contactgegeven in informatiedomein Relaties
+ description: Referentie naar Contactgegeven-sleutels in informatiedomein Relaties
kanaal:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2321,20 +2379,16 @@ components:
postadres:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
vragenlijst:
allOf:
- - $ref: '#/components/schemas/Vragenlijst'
+ - $ref: '#/components/schemas/Vragenlijst-sleutels'
description: De vragenlijst die gebruikt moet worden bij het uitvoeren van de onderzoeksopdracht.
- VragenlijstAntwoordbericht:
- allOf:
- - $ref: '#/components/schemas/VragenlijstAntwoord'
- - $ref: '#/components/schemas/Bericht-basis'
- VragenlijstAntwoord:
+ VragenlijstAntwoord-sleutels:
type: object
properties:
id:
@@ -2353,23 +2407,30 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- antwoord:
+ Vragenlijst-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Antwoord op de gestelde vraag
- toelichting:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: Toelichting bij het antwoord
- vraag:
- allOf:
- - $ref: '#/components/schemas/VragenlijstRegel'
- description: De vraag die hoort bij het gegeven antwoord
- VragenlijstRegelbericht:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderzoeksresultaatbericht:
allOf:
- - $ref: '#/components/schemas/VragenlijstRegel'
+ - $ref: '#/components/schemas/Onderzoeksresultaat'
- $ref: '#/components/schemas/Bericht-basis'
- VragenlijstRegel:
+ Onderzoeksresultaat:
type: object
properties:
id:
@@ -2388,28 +2449,15 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft het soort van de vraag aan: open vraag, ja/nee vraag, meerkeuzevraag, optie, NPS, cijferschaal, etc. Referentiedatasoort VRAAGSOORT.'
- omschrijving:
- type: string
- format: any
- description: Beknopte omschrijving van de vraag.
- opties:
- description: De mogelijke opties bij de vraag indien geen open vraag. Referentiedatasoort ANTWOORDOPTIES.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- volgordenummer:
- type: integer
- format: int32
- description: Volgordenummer van de vraag in de vragenlijst.
- vragenlijsten:
- description: De vragenlijsten waar de vraag gebruikt wordt.
+ antwoorden:
+ description: De antwoorden die door de relatie zijn gegeven behorende bij de onderzoeksopdracht.
type: array
items:
- $ref: '#/components/schemas/Vragenlijst'
+ $ref: '#/components/schemas/VragenlijstAntwoord-sleutels'
+ opdracht:
+ allOf:
+ - $ref: '#/components/schemas/Onderzoeksopdracht-sleutels'
+ description: De onderzoeksopdracht.
Vragenlijstbericht:
allOf:
- $ref: '#/components/schemas/Vragenlijst'
@@ -2465,11 +2513,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Onderzoeksresultaatbericht:
+ VragenlijstAntwoordbericht:
allOf:
- - $ref: '#/components/schemas/Onderzoeksresultaat'
+ - $ref: '#/components/schemas/VragenlijstAntwoord'
- $ref: '#/components/schemas/Bericht-basis'
- Onderzoeksresultaat:
+ VragenlijstAntwoord:
type: object
properties:
id:
@@ -2488,15 +2536,63 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- antwoorden:
- description: De antwoorden die door de relatie zijn gegeven behorende bij de onderzoeksopdracht.
+ antwoord:
+ type: string
+ format: any
+ description: Antwoord op de gestelde vraag
+ toelichting:
+ type: string
+ format: any
+ description: Toelichting bij het antwoord
+ vraag:
+ allOf:
+ - $ref: '#/components/schemas/VragenlijstRegel-sleutels'
+ description: De vraag die hoort bij het gegeven antwoord
+ VragenlijstRegelbericht:
+ allOf:
+ - $ref: '#/components/schemas/VragenlijstRegel'
+ - $ref: '#/components/schemas/Bericht-basis'
+ VragenlijstRegel:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Geeft het soort van de vraag aan: open vraag, ja/nee vraag, meerkeuzevraag, optie, NPS, cijferschaal, etc. Referentiedatasoort VRAAGSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: Beknopte omschrijving van de vraag.
+ opties:
+ description: De mogelijke opties bij de vraag indien geen open vraag. Referentiedatasoort ANTWOORDOPTIES.
type: array
items:
- $ref: '#/components/schemas/VragenlijstAntwoord'
- opdracht:
- allOf:
- - $ref: '#/components/schemas/Onderzoeksopdracht'
- description: De onderzoeksopdracht.
+ $ref: '#/components/schemas/Referentiedata'
+ volgordenummer:
+ type: integer
+ format: int32
+ description: Volgordenummer van de vraag in de vragenlijst.
+ vragenlijsten:
+ description: De vragenlijsten waar de vraag gebruikt wordt.
+ type: array
+ items:
+ $ref: '#/components/schemas/Vragenlijst-sleutels'
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Onderhoud.yaml b/docs/Informatiedomeinen/Onderhoud.yaml
index 4c927cc..bc2a585 100644
--- a/docs/Informatiedomeinen/Onderhoud.yaml
+++ b/docs/Informatiedomeinen/Onderhoud.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://onderhoud.vera.io:{port}/{basePath}
description: Productieserver
@@ -43,7 +43,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -59,7 +59,7 @@ paths:
get:
tags:
- 'Defecten'
- description: Ophalen van Defecten
+ summary: Ophalen van Defecten
operationId: listDefecten
parameters:
- name: params
@@ -109,7 +109,7 @@ paths:
post:
tags:
- 'Defecten'
- description: Voegt een nieuw(e) Defect toe.
+ summary: Voegt een nieuw(e) Defect toe.
operationId: createDefect
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -149,7 +149,7 @@ paths:
put:
tags:
- 'Defecten'
- description: |
+ summary: |
Vervangen van een Defect op basis van overeenkomstige sleutelvelden.
operationId: replaceDefect
parameters:
@@ -184,7 +184,7 @@ paths:
patch:
tags:
- 'Defecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Defect. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDefect
@@ -221,7 +221,7 @@ paths:
get:
tags:
- 'Defecten'
- description: Retourneert een Defect met de gegeven identifier
+ summary: Retourneert een Defect met de gegeven identifier
operationId: readDefectById
parameters:
- name: id
@@ -258,7 +258,7 @@ paths:
put:
tags:
- 'Defecten'
- description: Vervangen van een Defect
+ summary: Vervangen van een Defect
operationId: replaceDefectById
parameters:
- name: 'id'
@@ -296,7 +296,7 @@ paths:
patch:
tags:
- 'Defecten'
- description: Wijzigen van een Defect
+ summary: Wijzigen van een Defect
operationId: updateDefectById
parameters:
- name: 'id'
@@ -335,7 +335,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Ophalen van Inspectierapporten
+ summary: Ophalen van Inspectierapporten
operationId: listInspectierapporten
parameters:
- name: params
@@ -385,7 +385,7 @@ paths:
post:
tags:
- 'Inspectierapporten'
- description: Voegt een nieuw(e) Inspectierapport toe.
+ summary: Voegt een nieuw(e) Inspectierapport toe.
operationId: createInspectierapport
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -425,7 +425,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Vervangen van een Inspectierapport op basis van overeenkomstige sleutelvelden.
operationId: replaceInspectierapport
parameters:
@@ -460,7 +460,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inspectierapport. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInspectierapport
@@ -497,7 +497,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Retourneert een Inspectierapport met de gegeven identifier
+ summary: Retourneert een Inspectierapport met de gegeven identifier
operationId: readInspectierapportById
parameters:
- name: id
@@ -534,7 +534,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: Vervangen van een Inspectierapport
+ summary: Vervangen van een Inspectierapport
operationId: replaceInspectierapportById
parameters:
- name: 'id'
@@ -572,7 +572,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: Wijzigen van een Inspectierapport
+ summary: Wijzigen van een Inspectierapport
operationId: updateInspectierapportById
parameters:
- name: 'id'
@@ -611,7 +611,7 @@ paths:
get:
tags:
- 'Onderhoudsbestedingen'
- description: Ophalen van Onderhoudsbestedingen
+ summary: Ophalen van Onderhoudsbestedingen
operationId: listOnderhoudsbestedingen
parameters:
- name: params
@@ -661,7 +661,7 @@ paths:
post:
tags:
- 'Onderhoudsbestedingen'
- description: Voegt een nieuw(e) Onderhoudsbesteding toe.
+ summary: Voegt een nieuw(e) Onderhoudsbesteding toe.
operationId: createOnderhoudsbesteding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -701,7 +701,7 @@ paths:
put:
tags:
- 'Onderhoudsbestedingen'
- description: |
+ summary: |
Vervangen van een Onderhoudsbesteding op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsbesteding
parameters:
@@ -736,7 +736,7 @@ paths:
patch:
tags:
- 'Onderhoudsbestedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsbesteding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsbesteding
@@ -773,7 +773,7 @@ paths:
get:
tags:
- 'Onderhoudsbestedingen'
- description: Retourneert een Onderhoudsbesteding met de gegeven identifier
+ summary: Retourneert een Onderhoudsbesteding met de gegeven identifier
operationId: readOnderhoudsbestedingById
parameters:
- name: id
@@ -810,7 +810,7 @@ paths:
put:
tags:
- 'Onderhoudsbestedingen'
- description: Vervangen van een Onderhoudsbesteding
+ summary: Vervangen van een Onderhoudsbesteding
operationId: replaceOnderhoudsbestedingById
parameters:
- name: 'id'
@@ -848,7 +848,7 @@ paths:
patch:
tags:
- 'Onderhoudsbestedingen'
- description: Wijzigen van een Onderhoudsbesteding
+ summary: Wijzigen van een Onderhoudsbesteding
operationId: updateOnderhoudsbestedingById
parameters:
- name: 'id'
@@ -887,7 +887,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Ophalen van Onderhoudsorders
+ summary: Ophalen van Onderhoudsorders
operationId: listOnderhoudsorders
parameters:
- name: params
@@ -937,7 +937,7 @@ paths:
post:
tags:
- 'Onderhoudsorders'
- description: Voegt een nieuw(e) Onderhoudsorder toe.
+ summary: Voegt een nieuw(e) Onderhoudsorder toe.
operationId: createOnderhoudsorder
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -977,7 +977,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Vervangen van een Onderhoudsorder op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsorder
parameters:
@@ -1012,7 +1012,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsorder. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsorder
@@ -1049,7 +1049,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Retourneert een Onderhoudsorder met de gegeven identifier
+ summary: Retourneert een Onderhoudsorder met de gegeven identifier
operationId: readOnderhoudsorderById
parameters:
- name: id
@@ -1086,7 +1086,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: Vervangen van een Onderhoudsorder
+ summary: Vervangen van een Onderhoudsorder
operationId: replaceOnderhoudsorderById
parameters:
- name: 'id'
@@ -1124,7 +1124,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: Wijzigen van een Onderhoudsorder
+ summary: Wijzigen van een Onderhoudsorder
operationId: updateOnderhoudsorderById
parameters:
- name: 'id'
@@ -1163,7 +1163,7 @@ paths:
get:
tags:
- 'Onderhoudstaken'
- description: Ophalen van Onderhoudstaken
+ summary: Ophalen van Onderhoudstaken
operationId: listOnderhoudstaken
parameters:
- name: params
@@ -1213,7 +1213,7 @@ paths:
post:
tags:
- 'Onderhoudstaken'
- description: Voegt een nieuw(e) Onderhoudstaak toe.
+ summary: Voegt een nieuw(e) Onderhoudstaak toe.
operationId: createOnderhoudstaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1253,7 +1253,7 @@ paths:
put:
tags:
- 'Onderhoudstaken'
- description: |
+ summary: |
Vervangen van een Onderhoudstaak op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudstaak
parameters:
@@ -1288,7 +1288,7 @@ paths:
patch:
tags:
- 'Onderhoudstaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudstaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudstaak
@@ -1325,7 +1325,7 @@ paths:
get:
tags:
- 'Onderhoudstaken'
- description: Retourneert een Onderhoudstaak met de gegeven identifier
+ summary: Retourneert een Onderhoudstaak met de gegeven identifier
operationId: readOnderhoudstaakById
parameters:
- name: id
@@ -1362,7 +1362,7 @@ paths:
put:
tags:
- 'Onderhoudstaken'
- description: Vervangen van een Onderhoudstaak
+ summary: Vervangen van een Onderhoudstaak
operationId: replaceOnderhoudstaakById
parameters:
- name: 'id'
@@ -1400,7 +1400,7 @@ paths:
patch:
tags:
- 'Onderhoudstaken'
- description: Wijzigen van een Onderhoudstaak
+ summary: Wijzigen van een Onderhoudstaak
operationId: updateOnderhoudstaakById
parameters:
- name: 'id'
@@ -1439,7 +1439,7 @@ paths:
get:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Ophalen van Onderhoudstaakvoorcalculaties
+ summary: Ophalen van Onderhoudstaakvoorcalculaties
operationId: listOnderhoudstaakvoorcalculaties
parameters:
- name: params
@@ -1489,7 +1489,7 @@ paths:
post:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Voegt een nieuw(e) Onderhoudstaakvoorcalculatie toe.
+ summary: Voegt een nieuw(e) Onderhoudstaakvoorcalculatie toe.
operationId: createOnderhoudstaakvoorcalculatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1529,7 +1529,7 @@ paths:
put:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: |
+ summary: |
Vervangen van een Onderhoudstaakvoorcalculatie op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudstaakvoorcalculatie
parameters:
@@ -1564,7 +1564,7 @@ paths:
patch:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudstaakvoorcalculatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudstaakvoorcalculatie
@@ -1601,7 +1601,7 @@ paths:
get:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Retourneert een Onderhoudstaakvoorcalculatie met de gegeven identifier
+ summary: Retourneert een Onderhoudstaakvoorcalculatie met de gegeven identifier
operationId: readOnderhoudstaakvoorcalculatieById
parameters:
- name: id
@@ -1638,7 +1638,7 @@ paths:
put:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Vervangen van een Onderhoudstaakvoorcalculatie
+ summary: Vervangen van een Onderhoudstaakvoorcalculatie
operationId: replaceOnderhoudstaakvoorcalculatieById
parameters:
- name: 'id'
@@ -1676,7 +1676,7 @@ paths:
patch:
tags:
- 'Onderhoudstaakvoorcalculaties'
- description: Wijzigen van een Onderhoudstaakvoorcalculatie
+ summary: Wijzigen van een Onderhoudstaakvoorcalculatie
operationId: updateOnderhoudstaakvoorcalculatieById
parameters:
- name: 'id'
@@ -1715,7 +1715,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Ophalen van Onderhoudsverzoeken
+ summary: Ophalen van Onderhoudsverzoeken
operationId: listOnderhoudsverzoeken
parameters:
- name: params
@@ -1765,7 +1765,7 @@ paths:
post:
tags:
- 'Onderhoudsverzoeken'
- description: Voegt een nieuw(e) Onderhoudsverzoek toe.
+ summary: Voegt een nieuw(e) Onderhoudsverzoek toe.
operationId: createOnderhoudsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1805,7 +1805,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Vervangen van een Onderhoudsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsverzoek
parameters:
@@ -1840,7 +1840,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsverzoek
@@ -1877,7 +1877,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Retourneert een Onderhoudsverzoek met de gegeven identifier
+ summary: Retourneert een Onderhoudsverzoek met de gegeven identifier
operationId: readOnderhoudsverzoekById
parameters:
- name: id
@@ -1914,7 +1914,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: Vervangen van een Onderhoudsverzoek
+ summary: Vervangen van een Onderhoudsverzoek
operationId: replaceOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -1952,7 +1952,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: Wijzigen van een Onderhoudsverzoek
+ summary: Wijzigen van een Onderhoudsverzoek
operationId: updateOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -1991,7 +1991,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Ophalen van Onderhoudsverzoekverrekeningen
+ summary: Ophalen van Onderhoudsverzoekverrekeningen
operationId: listOnderhoudsverzoekverrekeningen
parameters:
- name: params
@@ -2041,7 +2041,7 @@ paths:
post:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Voegt een nieuw(e) Onderhoudsverzoekverrekening toe.
+ summary: Voegt een nieuw(e) Onderhoudsverzoekverrekening toe.
operationId: createOnderhoudsverzoekverrekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2081,7 +2081,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: |
+ summary: |
Vervangen van een Onderhoudsverzoekverrekening op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsverzoekverrekening
parameters:
@@ -2116,7 +2116,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsverzoekverrekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsverzoekverrekening
@@ -2153,7 +2153,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Retourneert een Onderhoudsverzoekverrekening met de gegeven identifier
+ summary: Retourneert een Onderhoudsverzoekverrekening met de gegeven identifier
operationId: readOnderhoudsverzoekverrekeningById
parameters:
- name: id
@@ -2190,7 +2190,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Vervangen van een Onderhoudsverzoekverrekening
+ summary: Vervangen van een Onderhoudsverzoekverrekening
operationId: replaceOnderhoudsverzoekverrekeningById
parameters:
- name: 'id'
@@ -2228,7 +2228,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoekverrekeningen'
- description: Wijzigen van een Onderhoudsverzoekverrekening
+ summary: Wijzigen van een Onderhoudsverzoekverrekening
operationId: updateOnderhoudsverzoekverrekeningById
parameters:
- name: 'id'
@@ -2267,7 +2267,7 @@ paths:
get:
tags:
- 'Standaardprijzen'
- description: Ophalen van Standaardprijzen
+ summary: Ophalen van Standaardprijzen
operationId: listStandaardprijzen
parameters:
- name: params
@@ -2317,7 +2317,7 @@ paths:
post:
tags:
- 'Standaardprijzen'
- description: Voegt een nieuw(e) Standaardprijs toe.
+ summary: Voegt een nieuw(e) Standaardprijs toe.
operationId: createStandaardprijs
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2357,7 +2357,7 @@ paths:
put:
tags:
- 'Standaardprijzen'
- description: |
+ summary: |
Vervangen van een Standaardprijs op basis van overeenkomstige sleutelvelden.
operationId: replaceStandaardprijs
parameters:
@@ -2392,7 +2392,7 @@ paths:
patch:
tags:
- 'Standaardprijzen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Standaardprijs. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateStandaardprijs
@@ -2429,7 +2429,7 @@ paths:
get:
tags:
- 'Standaardprijzen'
- description: Retourneert een Standaardprijs met de gegeven identifier
+ summary: Retourneert een Standaardprijs met de gegeven identifier
operationId: readStandaardprijsById
parameters:
- name: id
@@ -2466,7 +2466,7 @@ paths:
put:
tags:
- 'Standaardprijzen'
- description: Vervangen van een Standaardprijs
+ summary: Vervangen van een Standaardprijs
operationId: replaceStandaardprijsById
parameters:
- name: 'id'
@@ -2504,7 +2504,7 @@ paths:
patch:
tags:
- 'Standaardprijzen'
- description: Wijzigen van een Standaardprijs
+ summary: Wijzigen van een Standaardprijs
operationId: updateStandaardprijsById
parameters:
- name: 'id'
@@ -2576,10 +2576,34 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Onderhoud.All.Read: alleen lezen van alle resources
+ Onderhoud.All.ReadWrite: lezen en schrijven van alle resources
+ Onderhoud.Defecten.Read: alleen lezen van Defecten
+ Onderhoud.Defecten.ReadWrite: lezen en schrijven van Defecten
+ Onderhoud.Inspectierapporten.Read: alleen lezen van Inspectierapporten
+ Onderhoud.Inspectierapporten.ReadWrite: lezen en schrijven van Inspectierapporten
+ Onderhoud.Onderhoudsbestedingen.Read: alleen lezen van Onderhoudsbestedingen
+ Onderhoud.Onderhoudsbestedingen.ReadWrite: lezen en schrijven van Onderhoudsbestedingen
+ Onderhoud.Onderhoudsorders.Read: alleen lezen van Onderhoudsorders
+ Onderhoud.Onderhoudsorders.ReadWrite: lezen en schrijven van Onderhoudsorders
+ Onderhoud.Onderhoudstaken.Read: alleen lezen van Onderhoudstaken
+ Onderhoud.Onderhoudstaken.ReadWrite: lezen en schrijven van Onderhoudstaken
+ Onderhoud.Onderhoudstaakvoorcalculaties.Read: alleen lezen van Onderhoudstaakvoorcalculaties
+ Onderhoud.Onderhoudstaakvoorcalculaties.ReadWrite: lezen en schrijven van Onderhoudstaakvoorcalculaties
+ Onderhoud.Onderhoudsverzoeken.Read: alleen lezen van Onderhoudsverzoeken
+ Onderhoud.Onderhoudsverzoeken.ReadWrite: lezen en schrijven van Onderhoudsverzoeken
+ Onderhoud.Onderhoudsverzoekverrekeningen.Read: alleen lezen van Onderhoudsverzoekverrekeningen
+ Onderhoud.Onderhoudsverzoekverrekeningen.ReadWrite: lezen en schrijven van Onderhoudsverzoekverrekeningen
+ Onderhoud.Standaardprijzen.Read: alleen lezen van Standaardprijzen
+ Onderhoud.Standaardprijzen.ReadWrite: lezen en schrijven van Standaardprijzen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Onderhoud.All.Read: alleen lezen van alle resources
Onderhoud.All.ReadWrite: lezen en schrijven van alle resources
@@ -2655,22 +2679,22 @@ components:
bouwkundigElement:
type: string
format: uri
- description: Referentie naar BouwkundigElement in informatiedomein Vastgoed
+ description: Referentie naar BouwkundigElement-sleutels in informatiedomein Vastgoed
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObject:
type: string
format: uri
- description: Referentie naar CollectiefObject in informatiedomein Vastgoed
+ description: Referentie naar CollectiefObject-sleutels in informatiedomein Vastgoed
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
inspectierapport:
allOf:
- - $ref: '#/components/schemas/Inspectierapport'
+ - $ref: '#/components/schemas/Inspectierapport-sleutels'
description: Het inspectierapport waarmee het defect is gemeld.
locatie:
allOf:
@@ -2680,7 +2704,7 @@ components:
description: De onderhoudsverzoeken waarmee het defect is gemeld.
type: array
items:
- $ref: '#/components/schemas/Onderhoudsverzoek'
+ $ref: '#/components/schemas/Onderhoudsverzoek-sleutels'
oorzaak:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2690,7 +2714,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2717,7 +2741,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -2729,7 +2753,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -2765,6 +2789,44 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ Inspectierapport-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsverzoek-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Inspectierapportbericht:
allOf:
- $ref: '#/components/schemas/Inspectierapport'
@@ -2807,19 +2869,19 @@ components:
$ref: '#/components/schemas/Defect-sleutels'
inspectieOrder:
allOf:
- - $ref: '#/components/schemas/Onderhoudsorder'
+ - $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: De inspectieorder waardoor de inspectie heeft plaatsgevonden.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
voorgesteldeOnderhoudstaken:
description: In de situatie dat de inspecteur ook uit te voeren onderhoudstaken vaststelt tijdens de inspectie kunnen deze als voorgestelde onderhoudstaken opgenomen worden bij het inspectierapport
type: array
items:
- $ref: '#/components/schemas/Onderhoudstaak'
+ $ref: '#/components/schemas/Onderhoudstaak-sleutels'
Defect-sleutels:
type: object
properties:
@@ -2839,6 +2901,112 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsorder-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudstaak-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsbestedingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Onderhoudsbesteding'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Onderhoudsbesteding:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort besteding voor de onderhoudstaak. Afhankelijk van de afrekenwijze kunnen hier verschillende bestedingsoorten gebruikt worden zoals vaste taakprijs bij nacalculatie eenheidsprijzen en werktijd bij nacalculatie Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
+ omschrijving:
+ type: string
+ format: any
+ description: De korte omschrijving van de onderhoudsbesteding.
+ uitvoerdatum:
+ type: string
+ format: date-time
+ description: De datum waarop de onderhoudsbesteding is uitgevoerd.
+ uitvoerBegintijd:
+ type: string
+ format: date-time
+ description: De aanvangstijd van de uitvoering
+ uitvoerEindtijd:
+ type: string
+ format: date-time
+ description: De eindtijd van de uitvoering.
+ aantal:
+ type: number
+ format: float
+ description: Het aantal bestede middelen of tijd (uitgedrukt in de meeteenheid van de besteding).
+ bedrag:
+ type: number
+ format: float
+ description: De totale kosten van de bestedingsregel op basis van het aantal, de meeteenheid en het eventueel gebruikte artikel
+ grootboekmutatie:
+ type: string
+ format: uri
+ description: Referentie naar Grootboekmutatie-sleutels in informatiedomein Financien
+ meeteenheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De meeteenheid waarin de besteding wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
+ onderhoudstaak:
+ allOf:
+ - $ref: '#/components/schemas/Onderhoudstaak-sleutels'
+ description: Verwijzing naar de onderhoudstaak
+ reistijd:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: De reistijd
Onderhoudsorderbericht:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder'
@@ -2911,22 +3079,22 @@ components:
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
btwVerlegd:
type: boolean
description: Uiteindelijke beslissing of de btw is verlegd ja/nee. Mag afwijken van de instelling op de crediteur.
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObject:
type: string
format: uri
- description: Referentie naar CollectiefObject in informatiedomein Vastgoed
+ description: Referentie naar CollectiefObject-sleutels in informatiedomein Vastgoed
debiteur:
type: string
format: uri
- description: Referentie naar Debiteur in informatiedomein Financien
+ description: Referentie naar Debiteur-sleutels in informatiedomein Financien
defecten:
description: De defecten die via het verzoek of het inspectierapport zijn gemeld.
type: array
@@ -2935,7 +3103,7 @@ components:
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
financieelGereeddatum:
type: string
format: date-time
@@ -2945,27 +3113,27 @@ components:
items:
type: string
format: uri
- description: Referenties naar Offerte in informatiedomein Financien
+ description: Referenties naar Offerte-sleutels in informatiedomein Financien
onderhoudstaken:
description: De onderhoudstaken behorend bij de onderhoudsorder.
type: array
items:
- $ref: '#/components/schemas/Onderhoudstaak'
+ $ref: '#/components/schemas/Onderhoudstaak-sleutels'
onderhoudsverzoeken:
description: Het onderhoudsverzoek of de onderhoudsverzoeken die hebben geleid tot de onderhoudsorder.
type: array
items:
- $ref: '#/components/schemas/Onderhoudsverzoek'
+ $ref: '#/components/schemas/Onderhoudsverzoek-sleutels'
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
technischGereeddatum:
type: string
format: date-time
@@ -2974,25 +3142,6 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'De waarde die het soort uitvoerende aangeeft die de taak uitvoert. Bijvoorbeeld: vakgroep/leverancier of intern/extern. Referentiedatasoort UITVOERENDESOORT.'
- Onderhoudsorder-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Onderhoudstaakbericht:
allOf:
- $ref: '#/components/schemas/Onderhoudstaak'
@@ -3033,7 +3182,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
defecten:
description: De geconstateerde defecten die met de onderhoudstaak worden verholpen
type: array
@@ -3043,21 +3192,21 @@ components:
description: De onderhoudsbestedingen behorend bij de onderhoudstaak.
type: array
items:
- $ref: '#/components/schemas/Onderhoudsbesteding'
+ $ref: '#/components/schemas/Onderhoudsbesteding-sleutels'
onderhoudsorder:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: De onderhoudsorder behorend bij de onderhoudstaak.
onderhoudsverzoek:
allOf:
- - $ref: '#/components/schemas/Onderhoudsverzoek'
+ - $ref: '#/components/schemas/Onderhoudsverzoek-sleutels'
description: Het onderhoudsverzoek behorend bij de onderhoudstaak. Ook als er (nog) geen onderhoudsorder is bij de onderhoudstaak, kan op deze manier het bijbehorende onderhoudsverzoek worden gevonden.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
specialisme:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -3066,12 +3215,50 @@ components:
description: De onderhoudstaakvoorcalculaties behorende bij de onderhoudstaak.
type: array
items:
- $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie'
- Onderhoudsbestedingbericht:
+ $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie-sleutels'
+ Onderhoudsbesteding-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudstaakvoorcalculatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudstaakvoorcalculatiebericht:
allOf:
- - $ref: '#/components/schemas/Onderhoudsbesteding'
+ - $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie'
- $ref: '#/components/schemas/Bericht-basis'
- Onderhoudsbesteding:
+ Onderhoudstaakvoorcalculatie:
type: object
properties:
id:
@@ -3090,52 +3277,35 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
+ bestedingsoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort besteding voor de onderhoudstaak. Afhankelijk van de afrekenwijze kunnen hier verschillende bestedingsoorten gebruikt worden zoals vaste taakprijs bij nacalculatie eenheidsprijzen en werktijd bij nacalculatie Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
+ description: Het soort besteding voor de voorcalculatie. Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
omschrijving:
type: string
format: any
- description: De korte omschrijving van de onderhoudsbesteding.
- uitvoerdatum:
- type: string
- format: date-time
- description: De datum waarop de onderhoudsbesteding is uitgevoerd.
- uitvoerBegintijd:
- type: string
- format: date-time
- description: De aanvangstijd van de uitvoering
- uitvoerEindtijd:
- type: string
- format: date-time
- description: De eindtijd van de uitvoering.
+ description: De omschrijving van de voorcalculatie.
aantal:
type: number
format: float
- description: Het aantal bestede middelen of tijd (uitgedrukt in de meeteenheid van de besteding).
+ description: Het verwachte aantal te besteden middelen of tijd (uitgedrukt in de meeteenheid van de voorcalculatie).
bedrag:
type: number
format: float
- description: De totale kosten van de bestedingsregel op basis van het aantal, de meeteenheid en het eventueel gebruikte artikel
- grootboekmutatie:
- type: string
- format: uri
- description: Referentie naar Grootboekmutatie in informatiedomein Financien
+ description: Een indicatie van de kosten van de verwachte bestedingen.
meeteenheid:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De meeteenheid waarin de besteding wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
+ description: De meeteenheid waarin de voorcalculatie wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
onderhoudstaak:
allOf:
- $ref: '#/components/schemas/Onderhoudstaak-sleutels'
- description: Verwijzing naar de onderhoudstaak
- reistijd:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: De reistijd
- Onderhoudstaak-sleutels:
+ description: De onderhoudstaak behorende bij de voorcalculatie.
+ standaardprijs:
+ allOf:
+ - $ref: '#/components/schemas/Standaardprijs-sleutels'
+ description: Verwijzing naar een standaard (eenheids- of taak-) prijs die past bij de bestedingssoort, of die geldt voor de onderhoudstaak als geheel.
+ Standaardprijs-sleutels:
type: object
properties:
id:
@@ -3202,7 +3372,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
defecten:
description: De defecten die via zijn gemeld en gekoppeld aan het onderhoudsverzoek.
type: array
@@ -3228,19 +3398,19 @@ components:
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
verrekeningen:
description: De verrekeningen van het onderhoudsverzoek met de melder
type: array
items:
- $ref: '#/components/schemas/Onderhoudsverzoekverrekening'
+ $ref: '#/components/schemas/Onderhoudsverzoekverrekening-sleutels'
voorkeurAfspraken:
type: array
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
- Onderhoudsverzoek-sleutels:
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
+ Onderhoudsverzoekverrekening-sleutels:
type: object
properties:
id:
@@ -3294,57 +3464,6 @@ components:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: Verwijzing naar de eventuele onderhoudsorder waarvoor de (deel)verrekening.
- Onderhoudstaakvoorcalculatiebericht:
- allOf:
- - $ref: '#/components/schemas/Onderhoudstaakvoorcalculatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Onderhoudstaakvoorcalculatie:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bestedingsoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort besteding voor de voorcalculatie. Referentiedatasoort ONDERHOUDSBESTEDINGSOORT.
- omschrijving:
- type: string
- format: any
- description: De omschrijving van de voorcalculatie.
- aantal:
- type: number
- format: float
- description: Het verwachte aantal te besteden middelen of tijd (uitgedrukt in de meeteenheid van de voorcalculatie).
- bedrag:
- type: number
- format: float
- description: Een indicatie van de kosten van de verwachte bestedingen.
- meeteenheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De meeteenheid waarin de voorcalculatie wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
- onderhoudstaak:
- allOf:
- - $ref: '#/components/schemas/Onderhoudstaak-sleutels'
- description: De onderhoudstaak behorende bij de voorcalculatie.
- standaardprijs:
- allOf:
- - $ref: '#/components/schemas/Standaardprijs'
- description: Verwijzing naar een standaard (eenheids- of taak-) prijs die past bij de bestedingssoort, of die geldt voor de onderhoudstaak als geheel.
Standaardprijsbericht:
allOf:
- $ref: '#/components/schemas/Standaardprijs'
@@ -3389,25 +3508,6 @@ components:
type: array
items:
$ref: '#/components/schemas/Onderhoudstaakvoorcalculatie-sleutels'
- Onderhoudstaakvoorcalculatie-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Organisatie.yaml b/docs/Informatiedomeinen/Organisatie.yaml
index d6c3534..0fbd58f 100644
--- a/docs/Informatiedomeinen/Organisatie.yaml
+++ b/docs/Informatiedomeinen/Organisatie.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://organisatie.vera.io:{port}/{basePath}
description: Productieserver
@@ -35,7 +35,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -51,7 +51,7 @@ paths:
get:
tags:
- 'Medewerkers'
- description: Ophalen van Medewerkers
+ summary: Ophalen van Medewerkers
operationId: listMedewerkers
parameters:
- name: params
@@ -101,7 +101,7 @@ paths:
post:
tags:
- 'Medewerkers'
- description: Voegt een nieuw(e) Medewerker toe.
+ summary: Voegt een nieuw(e) Medewerker toe.
operationId: createMedewerker
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -141,7 +141,7 @@ paths:
put:
tags:
- 'Medewerkers'
- description: |
+ summary: |
Vervangen van een Medewerker op basis van overeenkomstige sleutelvelden.
operationId: replaceMedewerker
parameters:
@@ -176,7 +176,7 @@ paths:
patch:
tags:
- 'Medewerkers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Medewerker. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateMedewerker
@@ -213,7 +213,7 @@ paths:
get:
tags:
- 'Medewerkers'
- description: Retourneert een Medewerker met de gegeven identifier
+ summary: Retourneert een Medewerker met de gegeven identifier
operationId: readMedewerkerById
parameters:
- name: id
@@ -250,7 +250,7 @@ paths:
put:
tags:
- 'Medewerkers'
- description: Vervangen van een Medewerker
+ summary: Vervangen van een Medewerker
operationId: replaceMedewerkerById
parameters:
- name: 'id'
@@ -288,7 +288,7 @@ paths:
patch:
tags:
- 'Medewerkers'
- description: Wijzigen van een Medewerker
+ summary: Wijzigen van een Medewerker
operationId: updateMedewerkerById
parameters:
- name: 'id'
@@ -327,7 +327,7 @@ paths:
get:
tags:
- 'Medewerkerrollen'
- description: Ophalen van Medewerkerrollen
+ summary: Ophalen van Medewerkerrollen
operationId: listMedewerkerrollen
parameters:
- name: params
@@ -377,7 +377,7 @@ paths:
post:
tags:
- 'Medewerkerrollen'
- description: Voegt een nieuw(e) Medewerkerrol toe.
+ summary: Voegt een nieuw(e) Medewerkerrol toe.
operationId: createMedewerkerrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -417,7 +417,7 @@ paths:
put:
tags:
- 'Medewerkerrollen'
- description: |
+ summary: |
Vervangen van een Medewerkerrol op basis van overeenkomstige sleutelvelden.
operationId: replaceMedewerkerrol
parameters:
@@ -452,7 +452,7 @@ paths:
patch:
tags:
- 'Medewerkerrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Medewerkerrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateMedewerkerrol
@@ -489,7 +489,7 @@ paths:
get:
tags:
- 'Medewerkerrollen'
- description: Retourneert een Medewerkerrol met de gegeven identifier
+ summary: Retourneert een Medewerkerrol met de gegeven identifier
operationId: readMedewerkerrolById
parameters:
- name: id
@@ -526,7 +526,7 @@ paths:
put:
tags:
- 'Medewerkerrollen'
- description: Vervangen van een Medewerkerrol
+ summary: Vervangen van een Medewerkerrol
operationId: replaceMedewerkerrolById
parameters:
- name: 'id'
@@ -564,7 +564,7 @@ paths:
patch:
tags:
- 'Medewerkerrollen'
- description: Wijzigen van een Medewerkerrol
+ summary: Wijzigen van een Medewerkerrol
operationId: updateMedewerkerrolById
parameters:
- name: 'id'
@@ -603,7 +603,7 @@ paths:
get:
tags:
- 'Organisaties'
- description: Ophalen van Organisaties
+ summary: Ophalen van Organisaties
operationId: listOrganisaties
parameters:
- name: params
@@ -653,7 +653,7 @@ paths:
post:
tags:
- 'Organisaties'
- description: Voegt een nieuw(e) Organisatie toe.
+ summary: Voegt een nieuw(e) Organisatie toe.
operationId: createOrganisatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -693,7 +693,7 @@ paths:
put:
tags:
- 'Organisaties'
- description: |
+ summary: |
Vervangen van een Organisatie op basis van overeenkomstige sleutelvelden.
operationId: replaceOrganisatie
parameters:
@@ -728,7 +728,7 @@ paths:
patch:
tags:
- 'Organisaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Organisatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOrganisatie
@@ -765,7 +765,7 @@ paths:
get:
tags:
- 'Organisaties'
- description: Retourneert een Organisatie met de gegeven identifier
+ summary: Retourneert een Organisatie met de gegeven identifier
operationId: readOrganisatieById
parameters:
- name: id
@@ -802,7 +802,7 @@ paths:
put:
tags:
- 'Organisaties'
- description: Vervangen van een Organisatie
+ summary: Vervangen van een Organisatie
operationId: replaceOrganisatieById
parameters:
- name: 'id'
@@ -840,7 +840,7 @@ paths:
patch:
tags:
- 'Organisaties'
- description: Wijzigen van een Organisatie
+ summary: Wijzigen van een Organisatie
operationId: updateOrganisatieById
parameters:
- name: 'id'
@@ -879,7 +879,7 @@ paths:
get:
tags:
- 'OrganisatorischeEenheden'
- description: Ophalen van OrganisatorischeEenheden
+ summary: Ophalen van OrganisatorischeEenheden
operationId: listOrganisatorischeEenheden
parameters:
- name: params
@@ -929,7 +929,7 @@ paths:
post:
tags:
- 'OrganisatorischeEenheden'
- description: Voegt een nieuw(e) OrganisatorischeEenheid toe.
+ summary: Voegt een nieuw(e) OrganisatorischeEenheid toe.
operationId: createOrganisatorischeEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -969,7 +969,7 @@ paths:
put:
tags:
- 'OrganisatorischeEenheden'
- description: |
+ summary: |
Vervangen van een OrganisatorischeEenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceOrganisatorischeEenheid
parameters:
@@ -1004,7 +1004,7 @@ paths:
patch:
tags:
- 'OrganisatorischeEenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een OrganisatorischeEenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOrganisatorischeEenheid
@@ -1041,7 +1041,7 @@ paths:
get:
tags:
- 'OrganisatorischeEenheden'
- description: Retourneert een OrganisatorischeEenheid met de gegeven identifier
+ summary: Retourneert een OrganisatorischeEenheid met de gegeven identifier
operationId: readOrganisatorischeEenheidById
parameters:
- name: id
@@ -1078,7 +1078,7 @@ paths:
put:
tags:
- 'OrganisatorischeEenheden'
- description: Vervangen van een OrganisatorischeEenheid
+ summary: Vervangen van een OrganisatorischeEenheid
operationId: replaceOrganisatorischeEenheidById
parameters:
- name: 'id'
@@ -1116,7 +1116,7 @@ paths:
patch:
tags:
- 'OrganisatorischeEenheden'
- description: Wijzigen van een OrganisatorischeEenheid
+ summary: Wijzigen van een OrganisatorischeEenheid
operationId: updateOrganisatorischeEenheidById
parameters:
- name: 'id'
@@ -1155,7 +1155,7 @@ paths:
get:
tags:
- 'PersoneleFuncties'
- description: Ophalen van PersoneleFuncties
+ summary: Ophalen van PersoneleFuncties
operationId: listPersoneleFuncties
parameters:
- name: params
@@ -1205,7 +1205,7 @@ paths:
post:
tags:
- 'PersoneleFuncties'
- description: Voegt een nieuw(e) PersoneleFunctie toe.
+ summary: Voegt een nieuw(e) PersoneleFunctie toe.
operationId: createPersoneleFunctie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1245,7 +1245,7 @@ paths:
put:
tags:
- 'PersoneleFuncties'
- description: |
+ summary: |
Vervangen van een PersoneleFunctie op basis van overeenkomstige sleutelvelden.
operationId: replacePersoneleFunctie
parameters:
@@ -1280,7 +1280,7 @@ paths:
patch:
tags:
- 'PersoneleFuncties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een PersoneleFunctie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePersoneleFunctie
@@ -1317,7 +1317,7 @@ paths:
get:
tags:
- 'PersoneleFuncties'
- description: Retourneert een PersoneleFunctie met de gegeven identifier
+ summary: Retourneert een PersoneleFunctie met de gegeven identifier
operationId: readPersoneleFunctieById
parameters:
- name: id
@@ -1354,7 +1354,7 @@ paths:
put:
tags:
- 'PersoneleFuncties'
- description: Vervangen van een PersoneleFunctie
+ summary: Vervangen van een PersoneleFunctie
operationId: replacePersoneleFunctieById
parameters:
- name: 'id'
@@ -1392,7 +1392,7 @@ paths:
patch:
tags:
- 'PersoneleFuncties'
- description: Wijzigen van een PersoneleFunctie
+ summary: Wijzigen van een PersoneleFunctie
operationId: updatePersoneleFunctieById
parameters:
- name: 'id'
@@ -1464,10 +1464,26 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Organisatie.All.Read: alleen lezen van alle resources
+ Organisatie.All.ReadWrite: lezen en schrijven van alle resources
+ Organisatie.Medewerkers.Read: alleen lezen van Medewerkers
+ Organisatie.Medewerkers.ReadWrite: lezen en schrijven van Medewerkers
+ Organisatie.Medewerkerrollen.Read: alleen lezen van Medewerkerrollen
+ Organisatie.Medewerkerrollen.ReadWrite: lezen en schrijven van Medewerkerrollen
+ Organisatie.Organisaties.Read: alleen lezen van Organisaties
+ Organisatie.Organisaties.ReadWrite: lezen en schrijven van Organisaties
+ Organisatie.OrganisatorischeEenheden.Read: alleen lezen van OrganisatorischeEenheden
+ Organisatie.OrganisatorischeEenheden.ReadWrite: lezen en schrijven van OrganisatorischeEenheden
+ Organisatie.PersoneleFuncties.Read: alleen lezen van PersoneleFuncties
+ Organisatie.PersoneleFuncties.ReadWrite: lezen en schrijven van PersoneleFuncties
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Organisatie.All.Read: alleen lezen van alle resources
Organisatie.All.ReadWrite: lezen en schrijven van alle resources
@@ -1532,25 +1548,25 @@ components:
description: De rollen van de medewerker.
type: array
items:
- $ref: '#/components/schemas/PersoneleFunctie'
+ $ref: '#/components/schemas/PersoneleFunctie-sleutels'
organisatie:
allOf:
- - $ref: '#/components/schemas/Organisatie'
+ - $ref: '#/components/schemas/Organisatie-sleutels'
description: De organisatie waarvoor de medewerker werkt.
organisatorischeEenheden:
description: De organisatorische eenheid waarvoor de medewerker werzaamheden uitvoert.
type: array
items:
- $ref: '#/components/schemas/OrganisatorischeEenheid'
+ $ref: '#/components/schemas/OrganisatorischeEenheid-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
rollen:
description: De rollen van de medewerker.
type: array
items:
- $ref: '#/components/schemas/Medewerkerrol'
+ $ref: '#/components/schemas/Medewerkerrol-sleutels'
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -1577,7 +1593,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -1589,7 +1605,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -1625,11 +1641,7 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- PersoneleFunctiebericht:
- allOf:
- - $ref: '#/components/schemas/PersoneleFunctie'
- - $ref: '#/components/schemas/Bericht-basis'
- PersoneleFunctie:
+ PersoneleFunctie-sleutels:
type: object
properties:
id:
@@ -1648,43 +1660,106 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- naam:
+ Organisatie-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De naam van de functie.
- omschrijving:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: De beschrijving van de functie zoals in een FUBE is vastgelegd.
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ OrganisatorischeEenheid-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Medewerkerrol-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Medewerkerrolbericht:
+ allOf:
+ - $ref: '#/components/schemas/Medewerkerrol'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Medewerkerrol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort medewerker rol. Bijv. BHV-er, Vertrouwenspersoon, Scrummaster etc. Referentiedatasoort MEDEWERKERROLSOORT.
begindatum:
type: string
format: date
- description: De begindatum van de functie.
+ description: De begindatum van de rol.
einddatum:
type: string
format: date
- description: De einddatum van de functie.
- medewerkers:
- description: sleutels
- type: array
- items:
- $ref: '#/components/schemas/Medewerker-sleutels'
- organisatie:
+ description: De einddatum van de rol.
+ medewerker:
allOf:
- - $ref: '#/components/schemas/Organisatie'
- description: De organisatie waarbinnen de functie wordt uitgevoerd.
- salarisschaalBegin:
- type: number
- format: float
- description: het start salaris van de schaal bij aanvang contract.
- salarisschaalEind:
- type: number
- format: float
- description: het maximale salaris van de schaal bij aanvang contract.
- schaal:
- type: string
- format: any
- description: De salarisschaal waar de functie bij aanvang is ingeschaald.
+ - $ref: '#/components/schemas/Medewerker-sleutels'
+ description: De medewerker met deze rol.
Medewerker-sleutels:
type: object
properties:
@@ -1706,8 +1781,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort medewerker. Bijv. oproepkracht, inhuur, stagair etc.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort medewerker. Bijv. oproepkracht, inhuur, stagair etc. Referentiedatasoort MEDEWERKERSOORT.
Organisatiebericht:
allOf:
- $ref: '#/components/schemas/Organisatie'
@@ -1747,11 +1822,11 @@ components:
description: De organisatorische eenhedenvan de organisatie.
type: array
items:
- $ref: '#/components/schemas/OrganisatorischeEenheid'
+ $ref: '#/components/schemas/OrganisatorischeEenheid-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
OrganisatorischeEenheidbericht:
allOf:
- $ref: '#/components/schemas/OrganisatorischeEenheid'
@@ -1779,7 +1854,7 @@ components:
type: string
format: any
description: De naam van de organisatorische eenheid.
- bovenliggendeOrganisatorischeEenheid:
+ bovenliggendeOrganisatorischeEenheid-sleutels:
allOf:
- $ref: '#/components/schemas/OrganisatorischeEenheid-sleutels'
description: De organisatorische eenheid waarvan de organisatorische eenheid deel uitmaakt.
@@ -1800,26 +1875,11 @@ components:
allOf:
- $ref: '#/components/schemas/Organisatie-sleutels'
description: De organisatie waarvan de organisatorische eenheid deel uitmaakt.
- OrganisatorischeEenheid-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- Organisatie-sleutels:
+ PersoneleFunctiebericht:
+ allOf:
+ - $ref: '#/components/schemas/PersoneleFunctie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ PersoneleFunctie:
type: object
properties:
id:
@@ -1838,49 +1898,43 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
- Medewerkerrolbericht:
- allOf:
- - $ref: '#/components/schemas/Medewerkerrol'
- - $ref: '#/components/schemas/Bericht-basis'
- Medewerkerrol:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ naam:
type: string
format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ description: De naam van de functie.
+ omschrijving:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort medewerker rol. Bijv. BHV-er, Vertrouwenspersoon, Scrummaster etc. Referentiedatasoort MEDEWERKERROLSOORT.
+ description: De beschrijving van de functie zoals in een FUBE is vastgelegd.
begindatum:
type: string
format: date
- description: De begindatum van de rol.
+ description: De begindatum van de functie.
einddatum:
type: string
format: date
- description: De einddatum van de rol.
- medewerker:
+ description: De einddatum van de functie.
+ medewerkers:
+ description: De medewerkers met deze functie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Medewerker-sleutels'
+ organisatie:
allOf:
- - $ref: '#/components/schemas/Medewerker-sleutels'
- description: De medewerker met deze rol.
+ - $ref: '#/components/schemas/Organisatie-sleutels'
+ description: De organisatie waarbinnen de functie wordt uitgevoerd.
+ salarisschaalBegin:
+ type: number
+ format: float
+ description: het start salaris van de schaal bij aanvang contract.
+ salarisschaalEind:
+ type: number
+ format: float
+ description: het maximale salaris van de schaal bij aanvang contract.
+ schaal:
+ type: string
+ format: any
+ description: De salarisschaal waar de functie bij aanvang is ingeschaald.
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Overeenkomsten.yaml b/docs/Informatiedomeinen/Overeenkomsten.yaml
index a97af22..ecd4ca3 100644
--- a/docs/Informatiedomeinen/Overeenkomsten.yaml
+++ b/docs/Informatiedomeinen/Overeenkomsten.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://overeenkomsten.vera.io:{port}/{basePath}
description: Productieserver
@@ -55,7 +55,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -71,7 +71,7 @@ paths:
get:
tags:
- 'Arbeidsovereenkomsten'
- description: Ophalen van Arbeidsovereenkomsten
+ summary: Ophalen van Arbeidsovereenkomsten
operationId: listArbeidsovereenkomsten
parameters:
- name: params
@@ -121,7 +121,7 @@ paths:
post:
tags:
- 'Arbeidsovereenkomsten'
- description: Voegt een nieuw(e) Arbeidsovereenkomst toe.
+ summary: Voegt een nieuw(e) Arbeidsovereenkomst toe.
operationId: createArbeidsovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -161,7 +161,7 @@ paths:
put:
tags:
- 'Arbeidsovereenkomsten'
- description: |
+ summary: |
Vervangen van een Arbeidsovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceArbeidsovereenkomst
parameters:
@@ -196,7 +196,7 @@ paths:
patch:
tags:
- 'Arbeidsovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Arbeidsovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateArbeidsovereenkomst
@@ -233,7 +233,7 @@ paths:
get:
tags:
- 'Arbeidsovereenkomsten'
- description: Retourneert een Arbeidsovereenkomst met de gegeven identifier
+ summary: Retourneert een Arbeidsovereenkomst met de gegeven identifier
operationId: readArbeidsovereenkomstById
parameters:
- name: id
@@ -270,7 +270,7 @@ paths:
put:
tags:
- 'Arbeidsovereenkomsten'
- description: Vervangen van een Arbeidsovereenkomst
+ summary: Vervangen van een Arbeidsovereenkomst
operationId: replaceArbeidsovereenkomstById
parameters:
- name: 'id'
@@ -308,7 +308,7 @@ paths:
patch:
tags:
- 'Arbeidsovereenkomsten'
- description: Wijzigen van een Arbeidsovereenkomst
+ summary: Wijzigen van een Arbeidsovereenkomst
operationId: updateArbeidsovereenkomstById
parameters:
- name: 'id'
@@ -347,7 +347,7 @@ paths:
get:
tags:
- 'Huurgeschillen'
- description: Ophalen van Huurgeschillen
+ summary: Ophalen van Huurgeschillen
operationId: listHuurgeschillen
parameters:
- name: params
@@ -397,7 +397,7 @@ paths:
post:
tags:
- 'Huurgeschillen'
- description: Voegt een nieuw(e) Huurgeschil toe.
+ summary: Voegt een nieuw(e) Huurgeschil toe.
operationId: createHuurgeschil
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -437,7 +437,7 @@ paths:
put:
tags:
- 'Huurgeschillen'
- description: |
+ summary: |
Vervangen van een Huurgeschil op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurgeschil
parameters:
@@ -472,7 +472,7 @@ paths:
patch:
tags:
- 'Huurgeschillen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huurgeschil. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurgeschil
@@ -509,7 +509,7 @@ paths:
get:
tags:
- 'Huurgeschillen'
- description: Retourneert een Huurgeschil met de gegeven identifier
+ summary: Retourneert een Huurgeschil met de gegeven identifier
operationId: readHuurgeschilById
parameters:
- name: id
@@ -546,7 +546,7 @@ paths:
put:
tags:
- 'Huurgeschillen'
- description: Vervangen van een Huurgeschil
+ summary: Vervangen van een Huurgeschil
operationId: replaceHuurgeschilById
parameters:
- name: 'id'
@@ -584,7 +584,7 @@ paths:
patch:
tags:
- 'Huurgeschillen'
- description: Wijzigen van een Huurgeschil
+ summary: Wijzigen van een Huurgeschil
operationId: updateHuurgeschilById
parameters:
- name: 'id'
@@ -623,7 +623,7 @@ paths:
get:
tags:
- 'HuurgeschilActies'
- description: Ophalen van HuurgeschilActies
+ summary: Ophalen van HuurgeschilActies
operationId: listHuurgeschilActies
parameters:
- name: params
@@ -673,7 +673,7 @@ paths:
post:
tags:
- 'HuurgeschilActies'
- description: Voegt een nieuw(e) HuurgeschilActie toe.
+ summary: Voegt een nieuw(e) HuurgeschilActie toe.
operationId: createHuurgeschilActie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -713,7 +713,7 @@ paths:
put:
tags:
- 'HuurgeschilActies'
- description: |
+ summary: |
Vervangen van een HuurgeschilActie op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurgeschilActie
parameters:
@@ -748,7 +748,7 @@ paths:
patch:
tags:
- 'HuurgeschilActies'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een HuurgeschilActie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurgeschilActie
@@ -785,7 +785,7 @@ paths:
get:
tags:
- 'HuurgeschilActies'
- description: Retourneert een HuurgeschilActie met de gegeven identifier
+ summary: Retourneert een HuurgeschilActie met de gegeven identifier
operationId: readHuurgeschilActieById
parameters:
- name: id
@@ -822,7 +822,7 @@ paths:
put:
tags:
- 'HuurgeschilActies'
- description: Vervangen van een HuurgeschilActie
+ summary: Vervangen van een HuurgeschilActie
operationId: replaceHuurgeschilActieById
parameters:
- name: 'id'
@@ -860,7 +860,7 @@ paths:
patch:
tags:
- 'HuurgeschilActies'
- description: Wijzigen van een HuurgeschilActie
+ summary: Wijzigen van een HuurgeschilActie
operationId: updateHuurgeschilActieById
parameters:
- name: 'id'
@@ -899,7 +899,7 @@ paths:
get:
tags:
- 'HuurgeschilUitspraken'
- description: Ophalen van HuurgeschilUitspraken
+ summary: Ophalen van HuurgeschilUitspraken
operationId: listHuurgeschilUitspraken
parameters:
- name: params
@@ -949,7 +949,7 @@ paths:
post:
tags:
- 'HuurgeschilUitspraken'
- description: Voegt een nieuw(e) HuurgeschilUitspraak toe.
+ summary: Voegt een nieuw(e) HuurgeschilUitspraak toe.
operationId: createHuurgeschilUitspraak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -989,7 +989,7 @@ paths:
put:
tags:
- 'HuurgeschilUitspraken'
- description: |
+ summary: |
Vervangen van een HuurgeschilUitspraak op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurgeschilUitspraak
parameters:
@@ -1024,7 +1024,7 @@ paths:
patch:
tags:
- 'HuurgeschilUitspraken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een HuurgeschilUitspraak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurgeschilUitspraak
@@ -1061,7 +1061,7 @@ paths:
get:
tags:
- 'HuurgeschilUitspraken'
- description: Retourneert een HuurgeschilUitspraak met de gegeven identifier
+ summary: Retourneert een HuurgeschilUitspraak met de gegeven identifier
operationId: readHuurgeschilUitspraakById
parameters:
- name: id
@@ -1098,7 +1098,7 @@ paths:
put:
tags:
- 'HuurgeschilUitspraken'
- description: Vervangen van een HuurgeschilUitspraak
+ summary: Vervangen van een HuurgeschilUitspraak
operationId: replaceHuurgeschilUitspraakById
parameters:
- name: 'id'
@@ -1136,7 +1136,7 @@ paths:
patch:
tags:
- 'HuurgeschilUitspraken'
- description: Wijzigen van een HuurgeschilUitspraak
+ summary: Wijzigen van een HuurgeschilUitspraak
operationId: updateHuurgeschilUitspraakById
parameters:
- name: 'id'
@@ -1175,7 +1175,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Ophalen van Huuropzeggingen
+ summary: Ophalen van Huuropzeggingen
operationId: listHuuropzeggingen
parameters:
- name: params
@@ -1225,7 +1225,7 @@ paths:
post:
tags:
- 'Huuropzeggingen'
- description: Voegt een nieuw(e) Huuropzegging toe.
+ summary: Voegt een nieuw(e) Huuropzegging toe.
operationId: createHuuropzegging
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1265,7 +1265,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Vervangen van een Huuropzegging op basis van overeenkomstige sleutelvelden.
operationId: replaceHuuropzegging
parameters:
@@ -1300,7 +1300,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huuropzegging. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuuropzegging
@@ -1337,7 +1337,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Retourneert een Huuropzegging met de gegeven identifier
+ summary: Retourneert een Huuropzegging met de gegeven identifier
operationId: readHuuropzeggingById
parameters:
- name: id
@@ -1374,7 +1374,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: Vervangen van een Huuropzegging
+ summary: Vervangen van een Huuropzegging
operationId: replaceHuuropzeggingById
parameters:
- name: 'id'
@@ -1412,7 +1412,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: Wijzigen van een Huuropzegging
+ summary: Wijzigen van een Huuropzegging
operationId: updateHuuropzeggingById
parameters:
- name: 'id'
@@ -1451,7 +1451,7 @@ paths:
get:
tags:
- 'Huurovereenkomsten'
- description: Ophalen van Huurovereenkomsten
+ summary: Ophalen van Huurovereenkomsten
operationId: listHuurovereenkomsten
parameters:
- name: params
@@ -1501,7 +1501,7 @@ paths:
post:
tags:
- 'Huurovereenkomsten'
- description: Voegt een nieuw(e) Huurovereenkomst toe.
+ summary: Voegt een nieuw(e) Huurovereenkomst toe.
operationId: createHuurovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1541,7 +1541,7 @@ paths:
put:
tags:
- 'Huurovereenkomsten'
- description: |
+ summary: |
Vervangen van een Huurovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurovereenkomst
parameters:
@@ -1576,7 +1576,7 @@ paths:
patch:
tags:
- 'Huurovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huurovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurovereenkomst
@@ -1613,7 +1613,7 @@ paths:
get:
tags:
- 'Huurovereenkomsten'
- description: Retourneert een Huurovereenkomst met de gegeven identifier
+ summary: Retourneert een Huurovereenkomst met de gegeven identifier
operationId: readHuurovereenkomstById
parameters:
- name: id
@@ -1650,7 +1650,7 @@ paths:
put:
tags:
- 'Huurovereenkomsten'
- description: Vervangen van een Huurovereenkomst
+ summary: Vervangen van een Huurovereenkomst
operationId: replaceHuurovereenkomstById
parameters:
- name: 'id'
@@ -1688,7 +1688,7 @@ paths:
patch:
tags:
- 'Huurovereenkomsten'
- description: Wijzigen van een Huurovereenkomst
+ summary: Wijzigen van een Huurovereenkomst
operationId: updateHuurovereenkomstById
parameters:
- name: 'id'
@@ -1727,7 +1727,7 @@ paths:
get:
tags:
- 'Huurtoeslagen'
- description: Ophalen van Huurtoeslagen
+ summary: Ophalen van Huurtoeslagen
operationId: listHuurtoeslagen
parameters:
- name: params
@@ -1777,7 +1777,7 @@ paths:
post:
tags:
- 'Huurtoeslagen'
- description: Voegt een nieuw(e) Huurtoeslag toe.
+ summary: Voegt een nieuw(e) Huurtoeslag toe.
operationId: createHuurtoeslag
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1817,7 +1817,7 @@ paths:
put:
tags:
- 'Huurtoeslagen'
- description: |
+ summary: |
Vervangen van een Huurtoeslag op basis van overeenkomstige sleutelvelden.
operationId: replaceHuurtoeslag
parameters:
@@ -1852,7 +1852,7 @@ paths:
patch:
tags:
- 'Huurtoeslagen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huurtoeslag. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuurtoeslag
@@ -1889,7 +1889,7 @@ paths:
get:
tags:
- 'Huurtoeslagen'
- description: Retourneert een Huurtoeslag met de gegeven identifier
+ summary: Retourneert een Huurtoeslag met de gegeven identifier
operationId: readHuurtoeslagById
parameters:
- name: id
@@ -1926,7 +1926,7 @@ paths:
put:
tags:
- 'Huurtoeslagen'
- description: Vervangen van een Huurtoeslag
+ summary: Vervangen van een Huurtoeslag
operationId: replaceHuurtoeslagById
parameters:
- name: 'id'
@@ -1964,7 +1964,7 @@ paths:
patch:
tags:
- 'Huurtoeslagen'
- description: Wijzigen van een Huurtoeslag
+ summary: Wijzigen van een Huurtoeslag
operationId: updateHuurtoeslagById
parameters:
- name: 'id'
@@ -2003,7 +2003,7 @@ paths:
get:
tags:
- 'Inschrijvingen'
- description: Ophalen van Inschrijvingen
+ summary: Ophalen van Inschrijvingen
operationId: listInschrijvingen
parameters:
- name: params
@@ -2053,7 +2053,7 @@ paths:
post:
tags:
- 'Inschrijvingen'
- description: Voegt een nieuw(e) Inschrijving toe.
+ summary: Voegt een nieuw(e) Inschrijving toe.
operationId: createInschrijving
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2093,7 +2093,7 @@ paths:
put:
tags:
- 'Inschrijvingen'
- description: |
+ summary: |
Vervangen van een Inschrijving op basis van overeenkomstige sleutelvelden.
operationId: replaceInschrijving
parameters:
@@ -2128,7 +2128,7 @@ paths:
patch:
tags:
- 'Inschrijvingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inschrijving. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInschrijving
@@ -2165,7 +2165,7 @@ paths:
get:
tags:
- 'Inschrijvingen'
- description: Retourneert een Inschrijving met de gegeven identifier
+ summary: Retourneert een Inschrijving met de gegeven identifier
operationId: readInschrijvingById
parameters:
- name: id
@@ -2202,7 +2202,7 @@ paths:
put:
tags:
- 'Inschrijvingen'
- description: Vervangen van een Inschrijving
+ summary: Vervangen van een Inschrijving
operationId: replaceInschrijvingById
parameters:
- name: 'id'
@@ -2240,7 +2240,7 @@ paths:
patch:
tags:
- 'Inschrijvingen'
- description: Wijzigen van een Inschrijving
+ summary: Wijzigen van een Inschrijving
operationId: updateInschrijvingById
parameters:
- name: 'id'
@@ -2279,7 +2279,7 @@ paths:
get:
tags:
- 'Inspecties'
- description: Ophalen van Inspecties
+ summary: Ophalen van Inspecties
operationId: listInspecties
parameters:
- name: params
@@ -2329,7 +2329,7 @@ paths:
post:
tags:
- 'Inspecties'
- description: Voegt een nieuw(e) Inspectie toe.
+ summary: Voegt een nieuw(e) Inspectie toe.
operationId: createInspectie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2369,7 +2369,7 @@ paths:
put:
tags:
- 'Inspecties'
- description: |
+ summary: |
Vervangen van een Inspectie op basis van overeenkomstige sleutelvelden.
operationId: replaceInspectie
parameters:
@@ -2404,7 +2404,7 @@ paths:
patch:
tags:
- 'Inspecties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inspectie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInspectie
@@ -2441,7 +2441,7 @@ paths:
get:
tags:
- 'Inspecties'
- description: Retourneert een Inspectie met de gegeven identifier
+ summary: Retourneert een Inspectie met de gegeven identifier
operationId: readInspectieById
parameters:
- name: id
@@ -2478,7 +2478,7 @@ paths:
put:
tags:
- 'Inspecties'
- description: Vervangen van een Inspectie
+ summary: Vervangen van een Inspectie
operationId: replaceInspectieById
parameters:
- name: 'id'
@@ -2516,7 +2516,7 @@ paths:
patch:
tags:
- 'Inspecties'
- description: Wijzigen van een Inspectie
+ summary: Wijzigen van een Inspectie
operationId: updateInspectieById
parameters:
- name: 'id'
@@ -2555,7 +2555,7 @@ paths:
get:
tags:
- 'Koopovereenkomsten'
- description: Ophalen van Koopovereenkomsten
+ summary: Ophalen van Koopovereenkomsten
operationId: listKoopovereenkomsten
parameters:
- name: params
@@ -2605,7 +2605,7 @@ paths:
post:
tags:
- 'Koopovereenkomsten'
- description: Voegt een nieuw(e) Koopovereenkomst toe.
+ summary: Voegt een nieuw(e) Koopovereenkomst toe.
operationId: createKoopovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2645,7 +2645,7 @@ paths:
put:
tags:
- 'Koopovereenkomsten'
- description: |
+ summary: |
Vervangen van een Koopovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceKoopovereenkomst
parameters:
@@ -2680,7 +2680,7 @@ paths:
patch:
tags:
- 'Koopovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Koopovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKoopovereenkomst
@@ -2717,7 +2717,7 @@ paths:
get:
tags:
- 'Koopovereenkomsten'
- description: Retourneert een Koopovereenkomst met de gegeven identifier
+ summary: Retourneert een Koopovereenkomst met de gegeven identifier
operationId: readKoopovereenkomstById
parameters:
- name: id
@@ -2754,7 +2754,7 @@ paths:
put:
tags:
- 'Koopovereenkomsten'
- description: Vervangen van een Koopovereenkomst
+ summary: Vervangen van een Koopovereenkomst
operationId: replaceKoopovereenkomstById
parameters:
- name: 'id'
@@ -2792,7 +2792,7 @@ paths:
patch:
tags:
- 'Koopovereenkomsten'
- description: Wijzigen van een Koopovereenkomst
+ summary: Wijzigen van een Koopovereenkomst
operationId: updateKoopovereenkomstById
parameters:
- name: 'id'
@@ -2831,7 +2831,7 @@ paths:
get:
tags:
- 'Onderhoudsovereenkomsten'
- description: Ophalen van Onderhoudsovereenkomsten
+ summary: Ophalen van Onderhoudsovereenkomsten
operationId: listOnderhoudsovereenkomsten
parameters:
- name: params
@@ -2881,7 +2881,7 @@ paths:
post:
tags:
- 'Onderhoudsovereenkomsten'
- description: Voegt een nieuw(e) Onderhoudsovereenkomst toe.
+ summary: Voegt een nieuw(e) Onderhoudsovereenkomst toe.
operationId: createOnderhoudsovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2921,7 +2921,7 @@ paths:
put:
tags:
- 'Onderhoudsovereenkomsten'
- description: |
+ summary: |
Vervangen van een Onderhoudsovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsovereenkomst
parameters:
@@ -2956,7 +2956,7 @@ paths:
patch:
tags:
- 'Onderhoudsovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsovereenkomst
@@ -2993,7 +2993,7 @@ paths:
get:
tags:
- 'Onderhoudsovereenkomsten'
- description: Retourneert een Onderhoudsovereenkomst met de gegeven identifier
+ summary: Retourneert een Onderhoudsovereenkomst met de gegeven identifier
operationId: readOnderhoudsovereenkomstById
parameters:
- name: id
@@ -3030,7 +3030,7 @@ paths:
put:
tags:
- 'Onderhoudsovereenkomsten'
- description: Vervangen van een Onderhoudsovereenkomst
+ summary: Vervangen van een Onderhoudsovereenkomst
operationId: replaceOnderhoudsovereenkomstById
parameters:
- name: 'id'
@@ -3068,7 +3068,7 @@ paths:
patch:
tags:
- 'Onderhoudsovereenkomsten'
- description: Wijzigen van een Onderhoudsovereenkomst
+ summary: Wijzigen van een Onderhoudsovereenkomst
operationId: updateOnderhoudsovereenkomstById
parameters:
- name: 'id'
@@ -3107,7 +3107,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Ophalen van Overeenkomsten
+ summary: Ophalen van Overeenkomsten
operationId: listOvereenkomsten
parameters:
- name: params
@@ -3157,7 +3157,7 @@ paths:
post:
tags:
- 'Overeenkomsten'
- description: Voegt een nieuw(e) Overeenkomst toe.
+ summary: Voegt een nieuw(e) Overeenkomst toe.
operationId: createOvereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3197,7 +3197,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Vervangen van een Overeenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomst
parameters:
@@ -3232,7 +3232,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomst
@@ -3269,7 +3269,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Retourneert een Overeenkomst met de gegeven identifier
+ summary: Retourneert een Overeenkomst met de gegeven identifier
operationId: readOvereenkomstById
parameters:
- name: id
@@ -3306,7 +3306,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: Vervangen van een Overeenkomst
+ summary: Vervangen van een Overeenkomst
operationId: replaceOvereenkomstById
parameters:
- name: 'id'
@@ -3344,7 +3344,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: Wijzigen van een Overeenkomst
+ summary: Wijzigen van een Overeenkomst
operationId: updateOvereenkomstById
parameters:
- name: 'id'
@@ -3383,7 +3383,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Ophalen van Overeenkomstkoppelingen
+ summary: Ophalen van Overeenkomstkoppelingen
operationId: listOvereenkomstkoppelingen
parameters:
- name: params
@@ -3433,7 +3433,7 @@ paths:
post:
tags:
- 'Overeenkomstkoppelingen'
- description: Voegt een nieuw(e) Overeenkomstkoppeling toe.
+ summary: Voegt een nieuw(e) Overeenkomstkoppeling toe.
operationId: createOvereenkomstkoppeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3473,7 +3473,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Vervangen van een Overeenkomstkoppeling op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomstkoppeling
parameters:
@@ -3508,7 +3508,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomstkoppeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomstkoppeling
@@ -3545,7 +3545,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Retourneert een Overeenkomstkoppeling met de gegeven identifier
+ summary: Retourneert een Overeenkomstkoppeling met de gegeven identifier
operationId: readOvereenkomstkoppelingById
parameters:
- name: id
@@ -3582,7 +3582,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: Vervangen van een Overeenkomstkoppeling
+ summary: Vervangen van een Overeenkomstkoppeling
operationId: replaceOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -3620,7 +3620,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: Wijzigen van een Overeenkomstkoppeling
+ summary: Wijzigen van een Overeenkomstkoppeling
operationId: updateOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -3659,7 +3659,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Ophalen van Prijscomponenten
+ summary: Ophalen van Prijscomponenten
operationId: listPrijscomponenten
parameters:
- name: params
@@ -3709,7 +3709,7 @@ paths:
post:
tags:
- 'Prijscomponenten'
- description: Voegt een nieuw(e) Prijscomponent toe.
+ summary: Voegt een nieuw(e) Prijscomponent toe.
operationId: createPrijscomponent
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3749,7 +3749,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Vervangen van een Prijscomponent op basis van overeenkomstige sleutelvelden.
operationId: replacePrijscomponent
parameters:
@@ -3784,7 +3784,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Prijscomponent. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePrijscomponent
@@ -3821,7 +3821,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Retourneert een Prijscomponent met de gegeven identifier
+ summary: Retourneert een Prijscomponent met de gegeven identifier
operationId: readPrijscomponentById
parameters:
- name: id
@@ -3858,7 +3858,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: Vervangen van een Prijscomponent
+ summary: Vervangen van een Prijscomponent
operationId: replacePrijscomponentById
parameters:
- name: 'id'
@@ -3896,7 +3896,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: Wijzigen van een Prijscomponent
+ summary: Wijzigen van een Prijscomponent
operationId: updatePrijscomponentById
parameters:
- name: 'id'
@@ -3935,7 +3935,7 @@ paths:
get:
tags:
- 'Serviceovereenkomsten'
- description: Ophalen van Serviceovereenkomsten
+ summary: Ophalen van Serviceovereenkomsten
operationId: listServiceovereenkomsten
parameters:
- name: params
@@ -3985,7 +3985,7 @@ paths:
post:
tags:
- 'Serviceovereenkomsten'
- description: Voegt een nieuw(e) Serviceovereenkomst toe.
+ summary: Voegt een nieuw(e) Serviceovereenkomst toe.
operationId: createServiceovereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4025,7 +4025,7 @@ paths:
put:
tags:
- 'Serviceovereenkomsten'
- description: |
+ summary: |
Vervangen van een Serviceovereenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceServiceovereenkomst
parameters:
@@ -4060,7 +4060,7 @@ paths:
patch:
tags:
- 'Serviceovereenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Serviceovereenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateServiceovereenkomst
@@ -4097,7 +4097,7 @@ paths:
get:
tags:
- 'Serviceovereenkomsten'
- description: Retourneert een Serviceovereenkomst met de gegeven identifier
+ summary: Retourneert een Serviceovereenkomst met de gegeven identifier
operationId: readServiceovereenkomstById
parameters:
- name: id
@@ -4134,7 +4134,7 @@ paths:
put:
tags:
- 'Serviceovereenkomsten'
- description: Vervangen van een Serviceovereenkomst
+ summary: Vervangen van een Serviceovereenkomst
operationId: replaceServiceovereenkomstById
parameters:
- name: 'id'
@@ -4172,7 +4172,7 @@ paths:
patch:
tags:
- 'Serviceovereenkomsten'
- description: Wijzigen van een Serviceovereenkomst
+ summary: Wijzigen van een Serviceovereenkomst
operationId: updateServiceovereenkomstById
parameters:
- name: 'id'
@@ -4244,10 +4244,46 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Overeenkomsten.All.Read: alleen lezen van alle resources
+ Overeenkomsten.All.ReadWrite: lezen en schrijven van alle resources
+ Overeenkomsten.Arbeidsovereenkomsten.Read: alleen lezen van Arbeidsovereenkomsten
+ Overeenkomsten.Arbeidsovereenkomsten.ReadWrite: lezen en schrijven van Arbeidsovereenkomsten
+ Overeenkomsten.Huurgeschillen.Read: alleen lezen van Huurgeschillen
+ Overeenkomsten.Huurgeschillen.ReadWrite: lezen en schrijven van Huurgeschillen
+ Overeenkomsten.HuurgeschilActies.Read: alleen lezen van HuurgeschilActies
+ Overeenkomsten.HuurgeschilActies.ReadWrite: lezen en schrijven van HuurgeschilActies
+ Overeenkomsten.HuurgeschilUitspraken.Read: alleen lezen van HuurgeschilUitspraken
+ Overeenkomsten.HuurgeschilUitspraken.ReadWrite: lezen en schrijven van HuurgeschilUitspraken
+ Overeenkomsten.Huuropzeggingen.Read: alleen lezen van Huuropzeggingen
+ Overeenkomsten.Huuropzeggingen.ReadWrite: lezen en schrijven van Huuropzeggingen
+ Overeenkomsten.Huurovereenkomsten.Read: alleen lezen van Huurovereenkomsten
+ Overeenkomsten.Huurovereenkomsten.ReadWrite: lezen en schrijven van Huurovereenkomsten
+ Overeenkomsten.Huurtoeslagen.Read: alleen lezen van Huurtoeslagen
+ Overeenkomsten.Huurtoeslagen.ReadWrite: lezen en schrijven van Huurtoeslagen
+ Overeenkomsten.Inschrijvingen.Read: alleen lezen van Inschrijvingen
+ Overeenkomsten.Inschrijvingen.ReadWrite: lezen en schrijven van Inschrijvingen
+ Overeenkomsten.Inspecties.Read: alleen lezen van Inspecties
+ Overeenkomsten.Inspecties.ReadWrite: lezen en schrijven van Inspecties
+ Overeenkomsten.Koopovereenkomsten.Read: alleen lezen van Koopovereenkomsten
+ Overeenkomsten.Koopovereenkomsten.ReadWrite: lezen en schrijven van Koopovereenkomsten
+ Overeenkomsten.Onderhoudsovereenkomsten.Read: alleen lezen van Onderhoudsovereenkomsten
+ Overeenkomsten.Onderhoudsovereenkomsten.ReadWrite: lezen en schrijven van Onderhoudsovereenkomsten
+ Overeenkomsten.Overeenkomsten.Read: alleen lezen van Overeenkomsten
+ Overeenkomsten.Overeenkomsten.ReadWrite: lezen en schrijven van Overeenkomsten
+ Overeenkomsten.Overeenkomstkoppelingen.Read: alleen lezen van Overeenkomstkoppelingen
+ Overeenkomsten.Overeenkomstkoppelingen.ReadWrite: lezen en schrijven van Overeenkomstkoppelingen
+ Overeenkomsten.Prijscomponenten.Read: alleen lezen van Prijscomponenten
+ Overeenkomsten.Prijscomponenten.ReadWrite: lezen en schrijven van Prijscomponenten
+ Overeenkomsten.Serviceovereenkomsten.Read: alleen lezen van Serviceovereenkomsten
+ Overeenkomsten.Serviceovereenkomsten.ReadWrite: lezen en schrijven van Serviceovereenkomsten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Overeenkomsten.All.Read: alleen lezen van alle resources
Overeenkomsten.All.ReadWrite: lezen en schrijven van alle resources
@@ -4309,15 +4345,15 @@ components:
functie:
type: string
format: uri
- description: Referentie naar PersoneleFunctie in informatiedomein Organisatie
+ description: Referentie naar PersoneleFunctie-sleutels in informatiedomein Organisatie
medewerker:
type: string
format: uri
- description: Referentie naar Medewerker in informatiedomein Organisatie
+ description: Referentie naar Medewerker-sleutels in informatiedomein Organisatie
organisatorischeEenheid:
type: string
format: uri
- description: Referentie naar OrganisatorischeEenheid in informatiedomein Organisatie
+ description: Referentie naar OrganisatorischeEenheid-sleutels in informatiedomein Organisatie
parttimePercentage:
type: number
format: float
@@ -4377,7 +4413,7 @@ components:
description: De huurgeschil acties uitgevoerd door de medewerker behorende bij het huurgeschil.
type: array
items:
- $ref: '#/components/schemas/HuurgeschilActie'
+ $ref: '#/components/schemas/HuurgeschilActie-sleutels'
bedrag:
type: number
format: float
@@ -4387,7 +4423,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
hoorzittingdatum:
type: string
format: date
@@ -4398,7 +4434,7 @@ components:
description: Het nummer van het dossier van het huurgeschil dat naar de huurcommissie is gegaan.
huurovereenkomst:
allOf:
- - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
description: De huurovereenkomst waardoor het geschil is ontstaan.
matigen:
type: boolean
@@ -4412,7 +4448,7 @@ components:
description: De uitspraken die zijn gedaan door de huurcommissie.
type: array
items:
- $ref: '#/components/schemas/HuurgeschilUitspraak'
+ $ref: '#/components/schemas/HuurgeschilUitspraak-sleutels'
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4439,7 +4475,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -4451,7 +4487,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -4487,6 +4523,67 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ HuurgeschilActie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Overeenkomst-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
+ HuurgeschilUitspraak-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
HuurgeschilActiebericht:
allOf:
- $ref: '#/components/schemas/HuurgeschilActie'
@@ -4525,7 +4622,7 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Huurgeschil-sleutels:
type: object
properties:
@@ -4545,7 +4642,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Overeenkomst-basis:
+ HuurgeschilUitspraakbericht:
+ allOf:
+ - $ref: '#/components/schemas/HuurgeschilUitspraak'
+ - $ref: '#/components/schemas/Bericht-basis'
+ HuurgeschilUitspraak:
type: object
properties:
id:
@@ -4567,69 +4668,58 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het detail soort overeenkomst. Bijvoorbeeld BOG (Bedrijfs Onroerend Goed). Referentiedatasoort OVEREENKOMSTDETAILSOORT.
- bovenliggendeOvereenkomst:
+ description: Het soort uitspraak die is gedaan door de huurcommissie. Referentiedatasoort HUURGESCHILUITSPRAAKSOORT.
+ datum:
+ type: string
+ format: date
+ description: De datum waarop de uitspraak heeft plaats gevonden.
+ bedrag:
+ type: number
+ format: float
+ description: Het huurbedrag in euro's dat is overeengekomen bij de uitspraak.
+ huurgeschil:
allOf:
- - $ref: '#/components/schemas/Overeenkomst-sleutels'
- description: De gerelateerde overeenkomst, bijvoorbeeld indien dit een betaalovereenkomst betreft voor een bovenliggende huurovereenkomst.
+ - $ref: '#/components/schemas/Huurgeschil-sleutels'
+ description: Verwijzing naar het huurgeschil waarvoor de uitspraak is gedaan.
+ Huuropzeggingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Huuropzegging'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Huuropzegging:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De status van een huurovereenkomst. Dit kan een waarde bevatten zoals: overeenkomst beëindigd en huurder is vertrokken, of overeenkomst is momenteel in gebruik. Referentiedatasoort OVEREENKOMSTSTATUS.'
+ description: De status van de huuropzegging. Bijv. Aangemaakt, Goedgekeurd, Geannuleerd, Afgewezen, In behandeling, Afgehandeld. Referentiedatasoort HUUROPZEGGINGSTATUS.
begindatum:
type: string
format: date
- description: De begindatum van de overeenkomst.
+ description: De datum waarop de Opzegging is gedaan.
einddatum:
type: string
format: date
- description: De einddatum van de overeenkomst.
- conceptVersturingsdatum:
- type: string
- format: date-time
- description: De datum waarop een concept overeenkomst is verstuurd.
- verstuurdatum:
- type: string
- format: date-time
- description: De datum waarop de overeenkomst is verstuurd.
- versturenStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van het versturen van de overeenkomst. Referentiedatasoort OVEREENKOMSTVERSTURENSTATUS.
- bewakingsstatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De bewakingsstatus bij de overeenkomst die wordt gebruikt in verband met incasso en prolongatie. Deze status is van toepassing als een debiteur niet aan zijn betalingsverplichtingen kan voldoen. Referentiedatasoort BEWAKINGSSTATUS.
- betaalgegeven:
- type: string
- format: uri
- description: Referentie naar Betaalgegeven in informatiedomein Relaties
- betaalwijze:
+ description: De begindatum waarop de opzegging is afgerond
+ opzegdatum:
type: string
- format: uri
- description: Referentie naar Betaalwijze in informatiedomein Financien
- betaalwijzen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Betaalwijze in informatiedomein Financien
- contactmomenten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- eenheden:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ format: date
+ description: De datum per wanneer de opzegging in gaat.
eindeDetailReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4638,284 +4728,37 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEREDEN.
- garanties:
+ huurovereenkomst:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
+ description: De opgezegde huurovereenkomst.
+ inspectieafspraken:
type: array
items:
type: string
format: uri
- description: Referenties naar Garantie in informatiedomein Vastgoed
- incassomoment:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het moment waarop de incasso wordt gedaan. OBSOLETE. Referentiedatasoort INCASSOMOMENT.
- deprecated: true
- incassowijze:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De wijze van incasso waarop de huurovereenkomst wordt betaald. OBSOLETE. Referentiedatasoort INCASSOWIJZE.
- deprecated: true
- onderhoudsverzoeken:
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
+ nieuweAdressen:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
- prijscomponenten:
- description: De prijscomponenten behorende bij de huurprijs, koopprijs of maandelijkse lasten van de overeenkomst.
- type: array
- items:
- $ref: '#/components/schemas/Prijscomponent'
- redenOntbinding:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENONTBINDING.
- deprecated: true
+ description: Referenties naar RelatieAdres-sleutels in informatiedomein Relaties
+ onderhoudsverzoek:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
redenOpzegging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENOPZEGGING.
- deprecated: true
- redenVernietiging:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden van de vernietiging van de overeenkomst. OBSOLETE. Referentiedatasoort REDENVERNIETIGING.
+ description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE Referentiedatasoort REDENOPZEGGING.
deprecated: true
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- versturen:
- type: boolean
- description: De aanduiding of een afschrift van de overeenkomst moet worden gestuurd naar de relatie
- volgnummer:
- type: string
- format: any
- description: Het volgnummer van de overeenkomst.
- Overeenkomst-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Overeenkomstbericht:
- allOf:
- - $ref: '#/components/schemas/Overeenkomst'
- - $ref: '#/components/schemas/Bericht-basis'
- Overeenkomst:
- oneOf:
- - $ref: '#/components/schemas/Arbeidsovereenkomst'
- - $ref: '#/components/schemas/Huurovereenkomst'
- - $ref: '#/components/schemas/Inschrijving'
- - $ref: '#/components/schemas/Koopovereenkomst'
- - $ref: '#/components/schemas/Onderhoudsovereenkomst'
- - $ref: '#/components/schemas/Serviceovereenkomst'
- Prijscomponentbericht:
- allOf:
- - $ref: '#/components/schemas/Prijscomponent'
- - $ref: '#/components/schemas/Bericht-basis'
- Prijscomponent:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De bedrijfsspecifieke naam van het prijscomponent
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan om welk soort prijscomponent het betreft. Bijvoorbeeld een component voor een eenheid, of een component voor een overeenkomst. Referentiedatasoort PRIJSCOMPONENTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan om welk detail soort prijscomponent het betreft. Bijvoorbeeld of het om service kosten gaat. Referentiedatasoort PRIJSCOMPONENTDETAILSOORT.
- subsidieSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan of het prijscomponent onderdeel kan zijn van een subsidieregeling. Vooralsnog alleen van toepassing op de wet op de huurtoeslag. Referentiedatasoort PRIJSCOMPONENTSUBSIDIESOORT.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van het prijscomponent. Dit is de datum waarop het prijscomponent van toepassing is.
- einddatum:
- type: string
- format: date-time
- description: De datum die aangeeft dat het prijscomponent niet meer van toepassing is. Er is dan een nieuwer prijscomponent van toepassing.
- bedrag:
- type: number
- format: float
- description: Het bedrag in euro's van het prijscomponent exclusief BTW.
- bedragInclusiefBtw:
- type: number
- format: float
- description: Het bedrag in euro's van het prijscomponent inclusief BTW.
- btw:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De BTW van het prijscomponent. Referentiedatasoort BTW.
- eenheid:
- type: string
- format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
- overeenkomst:
- allOf:
- - $ref: '#/components/schemas/Overeenkomst-sleutels'
- description: De overeenkomst waaraan het prijscomponent.
- wijzigingsreden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Geeft aan wat de reden was voor het aanpassen van het prijscomponent. Referentiedatasoort PRIJSCOMPONENTWIJZIGINGSREDEN.
- HuurgeschilUitspraakbericht:
- allOf:
- - $ref: '#/components/schemas/HuurgeschilUitspraak'
- - $ref: '#/components/schemas/Bericht-basis'
- HuurgeschilUitspraak:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort uitspraak die is gedaan door de huurcommissie. Referentiedatasoort HUURGESCHILUITSPRAAKSOORT.
- datum:
- type: string
- format: date
- description: De datum waarop de uitspraak heeft plaats gevonden.
- bedrag:
- type: number
- format: float
- description: Het huurbedrag in euro's dat is overeengekomen bij de uitspraak.
- huurgeschil:
- allOf:
- - $ref: '#/components/schemas/Huurgeschil-sleutels'
- description: Verwijzing naar het huurgeschil waarvoor de uitspraak is gedaan.
- Huuropzeggingbericht:
- allOf:
- - $ref: '#/components/schemas/Huuropzegging'
- - $ref: '#/components/schemas/Bericht-basis'
- Huuropzegging:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de huuropzegging. Bijv. Aangemaakt, Goedgekeurd, Geannuleerd, Afgewezen, In behandeling, Afgehandeld. Referentiedatasoort HUUROPZEGGINGSTATUS.
- begindatum:
- type: string
- format: date
- description: De datum waarop de Opzegging is gedaan.
- einddatum:
- type: string
- format: date
- description: De begindatum waarop de opzegging is afgerond
- opzegdatum:
- type: string
- format: date
- description: De datum per wanneer de opzegging in gaat.
- eindeDetailReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEDETAILREDEN.
- eindeReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEREDEN.
- huurovereenkomst:
- allOf:
- - $ref: '#/components/schemas/Overeenkomst'
- description: De opgezegde huurovereenkomst.
- inspectieafspraken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
- nieuweAdressen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar RelatieAdres in informatiedomein Relaties
- onderhoudsverzoek:
- type: string
- format: uri
- description: Referentie naar Onderhoudsverzoek in informatiedomein Onderhoud
- redenOpzegging:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE Referentiedatasoort REDENOPZEGGING.
- deprecated: true
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Huurovereenkomstbericht:
allOf:
- $ref: '#/components/schemas/Huurovereenkomst'
@@ -4945,7 +4788,7 @@ components:
afwijkendeBetaler:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
afwijkendeBetalerIncassowijze:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4965,12 +4808,12 @@ components:
description: Verwijzing naar eventuele huurgeschillen van toepassing op de huurovereenkomst.
type: array
items:
- $ref: '#/components/schemas/Huurgeschil'
+ $ref: '#/components/schemas/Huurgeschil-sleutels'
huurtoeslagen:
description: De huurtoeslagen behorende bij de huurovereenkomst.
type: array
items:
- $ref: '#/components/schemas/Huurtoeslag'
+ $ref: '#/components/schemas/Huurtoeslag-sleutels'
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5008,6 +4851,25 @@ components:
type: number
format: float
description: De rente van de waarborgsom op de overeenkomst. Deze waarde wordt in Euro's aangegeven en is cumulatief over de volledige looptijd van de huurovereenkomst.
+ Huurtoeslag-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Huurtoeslagbericht:
allOf:
- $ref: '#/components/schemas/Huurtoeslag'
@@ -5033,7 +4895,7 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
huurovereenkomst:
allOf:
- - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
description: Het huurovereenkomst behorende bij de huurtoeslag.
maand:
type: integer
@@ -5109,17 +4971,17 @@ components:
afspraak:
type: string
format: uri
- description: Referentie naar Afspraak in informatiedomein Relaties
+ description: Referentie naar Afspraak-sleutels in informatiedomein Relaties
overeenkomst:
allOf:
- - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
description: De overeenkomst die geïnspecteerd wordt.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Koopovereenkomstbericht:
allOf:
- $ref: '#/components/schemas/Koopovereenkomst'
@@ -5172,26 +5034,205 @@ components:
bouwkundigElement:
type: string
format: uri
- description: Referentie naar BouwkundigElement in informatiedomein Vastgoed
+ description: Referentie naar BouwkundigElement-sleutels in informatiedomein Vastgoed
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
collectiefObject:
type: string
format: uri
- description: Referentie naar CollectiefObject in informatiedomein Vastgoed
+ description: Referentie naar CollectiefObject-sleutels in informatiedomein Vastgoed
orders:
type: array
items:
type: string
format: uri
- description: Referenties naar Onderhoudsorder in informatiedomein Onderhoud
+ description: Referenties naar Onderhoudsorder-sleutels in informatiedomein Onderhoud
specialismen:
description: Het specialismen die de opdrachtnemer kan uitvoeren. Voorbeelden zijn Timmerman, Loodgieter, etc. Referentiedatasoort ONDERHOUDSPECIALISME.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ Overeenkomst-basis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het detail soort overeenkomst. Bijvoorbeeld BOG (Bedrijfs Onroerend Goed). Referentiedatasoort OVEREENKOMSTDETAILSOORT.
+ bovenliggendeOvereenkomst:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
+ description: De gerelateerde overeenkomst, bijvoorbeeld indien dit een betaalovereenkomst betreft voor een bovenliggende huurovereenkomst.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De status van een huurovereenkomst. Dit kan een waarde bevatten zoals: overeenkomst beëindigd en huurder is vertrokken, of overeenkomst is momenteel in gebruik. Referentiedatasoort OVEREENKOMSTSTATUS.'
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de overeenkomst.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de overeenkomst.
+ conceptVersturingsdatum:
+ type: string
+ format: date-time
+ description: De datum waarop een concept overeenkomst is verstuurd.
+ verstuurdatum:
+ type: string
+ format: date-time
+ description: De datum waarop de overeenkomst is verstuurd.
+ versturenStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het versturen van de overeenkomst. Referentiedatasoort OVEREENKOMSTVERSTURENSTATUS.
+ bewakingsstatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De bewakingsstatus bij de overeenkomst die wordt gebruikt in verband met incasso en prolongatie. Deze status is van toepassing als een debiteur niet aan zijn betalingsverplichtingen kan voldoen. Referentiedatasoort BEWAKINGSSTATUS.
+ betaalgegeven:
+ type: string
+ format: uri
+ description: Referentie naar Betaalgegeven-sleutels in informatiedomein Relaties
+ betaalwijze:
+ type: string
+ format: uri
+ description: Referentie naar Betaalwijze-sleutels in informatiedomein Financien
+ betaalwijzen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Betaalwijze-sleutels in informatiedomein Financien
+ contactmomenten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ eenheden:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ eindeDetailReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEDETAILREDEN.
+ eindeReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden voor beëindiging van de overeenkomst. Referentiedatasoort EINDEREDEN.
+ garanties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Garantie-sleutels in informatiedomein Vastgoed
+ incassomoment:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het moment waarop de incasso wordt gedaan. OBSOLETE. Referentiedatasoort INCASSOMOMENT.
+ deprecated: true
+ incassowijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De wijze van incasso waarop de huurovereenkomst wordt betaald. OBSOLETE. Referentiedatasoort INCASSOWIJZE.
+ deprecated: true
+ onderhoudsverzoeken:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ prijscomponenten:
+ description: De prijscomponenten behorende bij de huurprijs, koopprijs of maandelijkse lasten van de overeenkomst.
+ type: array
+ items:
+ $ref: '#/components/schemas/Prijscomponent-sleutels'
+ redenOntbinding:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENONTBINDING.
+ deprecated: true
+ redenOpzegging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden van de voortijdige ontbinding van de overeenkomst. OBSOLETE. Referentiedatasoort REDENOPZEGGING.
+ deprecated: true
+ redenVernietiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De reden van de vernietiging van de overeenkomst. OBSOLETE. Referentiedatasoort REDENVERNIETIGING.
+ deprecated: true
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ versturen:
+ type: boolean
+ description: De aanduiding of een afschrift van de overeenkomst moet worden gestuurd naar de relatie
+ volgnummer:
+ type: string
+ format: any
+ description: Het volgnummer van de overeenkomst.
+ Prijscomponent-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Overeenkomstbericht:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Overeenkomst:
+ oneOf:
+ - $ref: '#/components/schemas/Arbeidsovereenkomst'
+ - $ref: '#/components/schemas/Huurovereenkomst'
+ - $ref: '#/components/schemas/Inschrijving'
+ - $ref: '#/components/schemas/Koopovereenkomst'
+ - $ref: '#/components/schemas/Onderhoudsovereenkomst'
+ - $ref: '#/components/schemas/Serviceovereenkomst'
Overeenkomstkoppelingbericht:
allOf:
- $ref: '#/components/schemas/Overeenkomstkoppeling'
@@ -5228,10 +5269,81 @@ components:
format: date
description: De einddatum van de overeenkomst.
overeenkomsten:
- description: sleutels
+ description: De overeenkomsten die gekoppeld worden.
type: array
items:
- $ref: '#/components/schemas/Overeenkomst'
+ $ref: '#/components/schemas/Overeenkomst-sleutels'
+ Prijscomponentbericht:
+ allOf:
+ - $ref: '#/components/schemas/Prijscomponent'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Prijscomponent:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De bedrijfsspecifieke naam van het prijscomponent
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan om welk soort prijscomponent het betreft. Bijvoorbeeld een component voor een eenheid, of een component voor een overeenkomst. Referentiedatasoort PRIJSCOMPONENTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan om welk detail soort prijscomponent het betreft. Bijvoorbeeld of het om service kosten gaat. Referentiedatasoort PRIJSCOMPONENTDETAILSOORT.
+ subsidieSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan of het prijscomponent onderdeel kan zijn van een subsidieregeling. Vooralsnog alleen van toepassing op de wet op de huurtoeslag. Referentiedatasoort PRIJSCOMPONENTSUBSIDIESOORT.
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum van het prijscomponent. Dit is de datum waarop het prijscomponent van toepassing is.
+ einddatum:
+ type: string
+ format: date-time
+ description: De datum die aangeeft dat het prijscomponent niet meer van toepassing is. Er is dan een nieuwer prijscomponent van toepassing.
+ bedrag:
+ type: number
+ format: float
+ description: Het bedrag in euro's van het prijscomponent exclusief BTW.
+ bedragInclusiefBtw:
+ type: number
+ format: float
+ description: Het bedrag in euro's van het prijscomponent inclusief BTW.
+ btw:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De BTW van het prijscomponent. Referentiedatasoort BTW.
+ eenheid:
+ type: string
+ format: uri
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
+ overeenkomst:
+ allOf:
+ - $ref: '#/components/schemas/Overeenkomst-sleutels'
+ description: De overeenkomst waaraan het prijscomponent.
+ wijzigingsreden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft aan wat de reden was voor het aanpassen van het prijscomponent. Referentiedatasoort PRIJSCOMPONENTWIJZIGINGSREDEN.
Serviceovereenkomstbericht:
allOf:
- $ref: '#/components/schemas/Serviceovereenkomst'
diff --git a/docs/Informatiedomeinen/Projectontwikkeling.yaml b/docs/Informatiedomeinen/Projectontwikkeling.yaml
index 59e1e76..6218461 100644
--- a/docs/Informatiedomeinen/Projectontwikkeling.yaml
+++ b/docs/Informatiedomeinen/Projectontwikkeling.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://projectontwikkeling.vera.io:{port}/{basePath}
description: Productieserver
@@ -43,7 +43,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -59,7 +59,7 @@ paths:
get:
tags:
- 'Projecten'
- description: Ophalen van Projecten
+ summary: Ophalen van Projecten
operationId: listProjecten
parameters:
- name: params
@@ -109,7 +109,7 @@ paths:
post:
tags:
- 'Projecten'
- description: Voegt een nieuw(e) Project toe.
+ summary: Voegt een nieuw(e) Project toe.
operationId: createProject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -149,7 +149,7 @@ paths:
put:
tags:
- 'Projecten'
- description: |
+ summary: |
Vervangen van een Project op basis van overeenkomstige sleutelvelden.
operationId: replaceProject
parameters:
@@ -184,7 +184,7 @@ paths:
patch:
tags:
- 'Projecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Project. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProject
@@ -221,7 +221,7 @@ paths:
get:
tags:
- 'Projecten'
- description: Retourneert een Project met de gegeven identifier
+ summary: Retourneert een Project met de gegeven identifier
operationId: readProjectById
parameters:
- name: id
@@ -258,7 +258,7 @@ paths:
put:
tags:
- 'Projecten'
- description: Vervangen van een Project
+ summary: Vervangen van een Project
operationId: replaceProjectById
parameters:
- name: 'id'
@@ -296,7 +296,7 @@ paths:
patch:
tags:
- 'Projecten'
- description: Wijzigen van een Project
+ summary: Wijzigen van een Project
operationId: updateProjectById
parameters:
- name: 'id'
@@ -335,7 +335,7 @@ paths:
get:
tags:
- 'Projectbestedingen'
- description: Ophalen van Projectbestedingen
+ summary: Ophalen van Projectbestedingen
operationId: listProjectbestedingen
parameters:
- name: params
@@ -385,7 +385,7 @@ paths:
post:
tags:
- 'Projectbestedingen'
- description: Voegt een nieuw(e) Projectbesteding toe.
+ summary: Voegt een nieuw(e) Projectbesteding toe.
operationId: createProjectbesteding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -425,7 +425,7 @@ paths:
put:
tags:
- 'Projectbestedingen'
- description: |
+ summary: |
Vervangen van een Projectbesteding op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectbesteding
parameters:
@@ -460,7 +460,7 @@ paths:
patch:
tags:
- 'Projectbestedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectbesteding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectbesteding
@@ -497,7 +497,7 @@ paths:
get:
tags:
- 'Projectbestedingen'
- description: Retourneert een Projectbesteding met de gegeven identifier
+ summary: Retourneert een Projectbesteding met de gegeven identifier
operationId: readProjectbestedingById
parameters:
- name: id
@@ -534,7 +534,7 @@ paths:
put:
tags:
- 'Projectbestedingen'
- description: Vervangen van een Projectbesteding
+ summary: Vervangen van een Projectbesteding
operationId: replaceProjectbestedingById
parameters:
- name: 'id'
@@ -572,7 +572,7 @@ paths:
patch:
tags:
- 'Projectbestedingen'
- description: Wijzigen van een Projectbesteding
+ summary: Wijzigen van een Projectbesteding
operationId: updateProjectbestedingById
parameters:
- name: 'id'
@@ -611,7 +611,7 @@ paths:
get:
tags:
- 'Projectbudgetregels'
- description: Ophalen van Projectbudgetregels
+ summary: Ophalen van Projectbudgetregels
operationId: listProjectbudgetregels
parameters:
- name: params
@@ -661,7 +661,7 @@ paths:
post:
tags:
- 'Projectbudgetregels'
- description: Voegt een nieuw(e) Projectbudgetregel toe.
+ summary: Voegt een nieuw(e) Projectbudgetregel toe.
operationId: createProjectbudgetregel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -701,7 +701,7 @@ paths:
put:
tags:
- 'Projectbudgetregels'
- description: |
+ summary: |
Vervangen van een Projectbudgetregel op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectbudgetregel
parameters:
@@ -736,7 +736,7 @@ paths:
patch:
tags:
- 'Projectbudgetregels'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectbudgetregel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectbudgetregel
@@ -773,7 +773,7 @@ paths:
get:
tags:
- 'Projectbudgetregels'
- description: Retourneert een Projectbudgetregel met de gegeven identifier
+ summary: Retourneert een Projectbudgetregel met de gegeven identifier
operationId: readProjectbudgetregelById
parameters:
- name: id
@@ -810,7 +810,7 @@ paths:
put:
tags:
- 'Projectbudgetregels'
- description: Vervangen van een Projectbudgetregel
+ summary: Vervangen van een Projectbudgetregel
operationId: replaceProjectbudgetregelById
parameters:
- name: 'id'
@@ -848,7 +848,7 @@ paths:
patch:
tags:
- 'Projectbudgetregels'
- description: Wijzigen van een Projectbudgetregel
+ summary: Wijzigen van een Projectbudgetregel
operationId: updateProjectbudgetregelById
parameters:
- name: 'id'
@@ -887,7 +887,7 @@ paths:
get:
tags:
- 'Projectdoelstellingen'
- description: Ophalen van Projectdoelstellingen
+ summary: Ophalen van Projectdoelstellingen
operationId: listProjectdoelstellingen
parameters:
- name: params
@@ -937,7 +937,7 @@ paths:
post:
tags:
- 'Projectdoelstellingen'
- description: Voegt een nieuw(e) Projectdoelstelling toe.
+ summary: Voegt een nieuw(e) Projectdoelstelling toe.
operationId: createProjectdoelstelling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -977,7 +977,7 @@ paths:
put:
tags:
- 'Projectdoelstellingen'
- description: |
+ summary: |
Vervangen van een Projectdoelstelling op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectdoelstelling
parameters:
@@ -1012,7 +1012,7 @@ paths:
patch:
tags:
- 'Projectdoelstellingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectdoelstelling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectdoelstelling
@@ -1049,7 +1049,7 @@ paths:
get:
tags:
- 'Projectdoelstellingen'
- description: Retourneert een Projectdoelstelling met de gegeven identifier
+ summary: Retourneert een Projectdoelstelling met de gegeven identifier
operationId: readProjectdoelstellingById
parameters:
- name: id
@@ -1086,7 +1086,7 @@ paths:
put:
tags:
- 'Projectdoelstellingen'
- description: Vervangen van een Projectdoelstelling
+ summary: Vervangen van een Projectdoelstelling
operationId: replaceProjectdoelstellingById
parameters:
- name: 'id'
@@ -1124,7 +1124,7 @@ paths:
patch:
tags:
- 'Projectdoelstellingen'
- description: Wijzigen van een Projectdoelstelling
+ summary: Wijzigen van een Projectdoelstelling
operationId: updateProjectdoelstellingById
parameters:
- name: 'id'
@@ -1163,7 +1163,7 @@ paths:
get:
tags:
- 'Projectfasen'
- description: Ophalen van Projectfasen
+ summary: Ophalen van Projectfasen
operationId: listProjectfasen
parameters:
- name: params
@@ -1213,7 +1213,7 @@ paths:
post:
tags:
- 'Projectfasen'
- description: Voegt een nieuw(e) Projectfase toe.
+ summary: Voegt een nieuw(e) Projectfase toe.
operationId: createProjectfase
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1253,7 +1253,7 @@ paths:
put:
tags:
- 'Projectfasen'
- description: |
+ summary: |
Vervangen van een Projectfase op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectfase
parameters:
@@ -1288,7 +1288,7 @@ paths:
patch:
tags:
- 'Projectfasen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectfase. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectfase
@@ -1325,7 +1325,7 @@ paths:
get:
tags:
- 'Projectfasen'
- description: Retourneert een Projectfase met de gegeven identifier
+ summary: Retourneert een Projectfase met de gegeven identifier
operationId: readProjectfaseById
parameters:
- name: id
@@ -1362,7 +1362,7 @@ paths:
put:
tags:
- 'Projectfasen'
- description: Vervangen van een Projectfase
+ summary: Vervangen van een Projectfase
operationId: replaceProjectfaseById
parameters:
- name: 'id'
@@ -1400,7 +1400,7 @@ paths:
patch:
tags:
- 'Projectfasen'
- description: Wijzigen van een Projectfase
+ summary: Wijzigen van een Projectfase
operationId: updateProjectfaseById
parameters:
- name: 'id'
@@ -1439,7 +1439,7 @@ paths:
get:
tags:
- 'Projectfasebesluiten'
- description: Ophalen van Projectfasebesluiten
+ summary: Ophalen van Projectfasebesluiten
operationId: listProjectfasebesluiten
parameters:
- name: params
@@ -1489,7 +1489,7 @@ paths:
post:
tags:
- 'Projectfasebesluiten'
- description: Voegt een nieuw(e) Projectfasebesluit toe.
+ summary: Voegt een nieuw(e) Projectfasebesluit toe.
operationId: createProjectfasebesluit
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1529,7 +1529,7 @@ paths:
put:
tags:
- 'Projectfasebesluiten'
- description: |
+ summary: |
Vervangen van een Projectfasebesluit op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectfasebesluit
parameters:
@@ -1564,7 +1564,7 @@ paths:
patch:
tags:
- 'Projectfasebesluiten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectfasebesluit. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectfasebesluit
@@ -1601,7 +1601,7 @@ paths:
get:
tags:
- 'Projectfasebesluiten'
- description: Retourneert een Projectfasebesluit met de gegeven identifier
+ summary: Retourneert een Projectfasebesluit met de gegeven identifier
operationId: readProjectfasebesluitById
parameters:
- name: id
@@ -1638,7 +1638,7 @@ paths:
put:
tags:
- 'Projectfasebesluiten'
- description: Vervangen van een Projectfasebesluit
+ summary: Vervangen van een Projectfasebesluit
operationId: replaceProjectfasebesluitById
parameters:
- name: 'id'
@@ -1676,7 +1676,7 @@ paths:
patch:
tags:
- 'Projectfasebesluiten'
- description: Wijzigen van een Projectfasebesluit
+ summary: Wijzigen van een Projectfasebesluit
operationId: updateProjectfasebesluitById
parameters:
- name: 'id'
@@ -1715,7 +1715,7 @@ paths:
get:
tags:
- 'Projectorders'
- description: Ophalen van Projectorders
+ summary: Ophalen van Projectorders
operationId: listProjectorders
parameters:
- name: params
@@ -1765,7 +1765,7 @@ paths:
post:
tags:
- 'Projectorders'
- description: Voegt een nieuw(e) Projectorder toe.
+ summary: Voegt een nieuw(e) Projectorder toe.
operationId: createProjectorder
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1805,7 +1805,7 @@ paths:
put:
tags:
- 'Projectorders'
- description: |
+ summary: |
Vervangen van een Projectorder op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectorder
parameters:
@@ -1840,7 +1840,7 @@ paths:
patch:
tags:
- 'Projectorders'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectorder. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectorder
@@ -1877,7 +1877,7 @@ paths:
get:
tags:
- 'Projectorders'
- description: Retourneert een Projectorder met de gegeven identifier
+ summary: Retourneert een Projectorder met de gegeven identifier
operationId: readProjectorderById
parameters:
- name: id
@@ -1914,7 +1914,7 @@ paths:
put:
tags:
- 'Projectorders'
- description: Vervangen van een Projectorder
+ summary: Vervangen van een Projectorder
operationId: replaceProjectorderById
parameters:
- name: 'id'
@@ -1952,7 +1952,7 @@ paths:
patch:
tags:
- 'Projectorders'
- description: Wijzigen van een Projectorder
+ summary: Wijzigen van een Projectorder
operationId: updateProjectorderById
parameters:
- name: 'id'
@@ -1991,7 +1991,7 @@ paths:
get:
tags:
- 'Projectrollen'
- description: Ophalen van Projectrollen
+ summary: Ophalen van Projectrollen
operationId: listProjectrollen
parameters:
- name: params
@@ -2041,7 +2041,7 @@ paths:
post:
tags:
- 'Projectrollen'
- description: Voegt een nieuw(e) Projectrol toe.
+ summary: Voegt een nieuw(e) Projectrol toe.
operationId: createProjectrol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2081,7 +2081,7 @@ paths:
put:
tags:
- 'Projectrollen'
- description: |
+ summary: |
Vervangen van een Projectrol op basis van overeenkomstige sleutelvelden.
operationId: replaceProjectrol
parameters:
@@ -2116,7 +2116,7 @@ paths:
patch:
tags:
- 'Projectrollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projectrol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjectrol
@@ -2153,7 +2153,7 @@ paths:
get:
tags:
- 'Projectrollen'
- description: Retourneert een Projectrol met de gegeven identifier
+ summary: Retourneert een Projectrol met de gegeven identifier
operationId: readProjectrolById
parameters:
- name: id
@@ -2190,7 +2190,7 @@ paths:
put:
tags:
- 'Projectrollen'
- description: Vervangen van een Projectrol
+ summary: Vervangen van een Projectrol
operationId: replaceProjectrolById
parameters:
- name: 'id'
@@ -2228,7 +2228,7 @@ paths:
patch:
tags:
- 'Projectrollen'
- description: Wijzigen van een Projectrol
+ summary: Wijzigen van een Projectrol
operationId: updateProjectrolById
parameters:
- name: 'id'
@@ -2267,7 +2267,7 @@ paths:
get:
tags:
- 'Projecttaken'
- description: Ophalen van Projecttaken
+ summary: Ophalen van Projecttaken
operationId: listProjecttaken
parameters:
- name: params
@@ -2317,7 +2317,7 @@ paths:
post:
tags:
- 'Projecttaken'
- description: Voegt een nieuw(e) Projecttaak toe.
+ summary: Voegt een nieuw(e) Projecttaak toe.
operationId: createProjecttaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2357,7 +2357,7 @@ paths:
put:
tags:
- 'Projecttaken'
- description: |
+ summary: |
Vervangen van een Projecttaak op basis van overeenkomstige sleutelvelden.
operationId: replaceProjecttaak
parameters:
@@ -2392,7 +2392,7 @@ paths:
patch:
tags:
- 'Projecttaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Projecttaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateProjecttaak
@@ -2429,7 +2429,7 @@ paths:
get:
tags:
- 'Projecttaken'
- description: Retourneert een Projecttaak met de gegeven identifier
+ summary: Retourneert een Projecttaak met de gegeven identifier
operationId: readProjecttaakById
parameters:
- name: id
@@ -2466,7 +2466,7 @@ paths:
put:
tags:
- 'Projecttaken'
- description: Vervangen van een Projecttaak
+ summary: Vervangen van een Projecttaak
operationId: replaceProjecttaakById
parameters:
- name: 'id'
@@ -2504,7 +2504,7 @@ paths:
patch:
tags:
- 'Projecttaken'
- description: Wijzigen van een Projecttaak
+ summary: Wijzigen van een Projecttaak
operationId: updateProjecttaakById
parameters:
- name: 'id'
@@ -2576,10 +2576,34 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Projectontwikkeling.All.Read: alleen lezen van alle resources
+ Projectontwikkeling.All.ReadWrite: lezen en schrijven van alle resources
+ Projectontwikkeling.Projecten.Read: alleen lezen van Projecten
+ Projectontwikkeling.Projecten.ReadWrite: lezen en schrijven van Projecten
+ Projectontwikkeling.Projectbestedingen.Read: alleen lezen van Projectbestedingen
+ Projectontwikkeling.Projectbestedingen.ReadWrite: lezen en schrijven van Projectbestedingen
+ Projectontwikkeling.Projectbudgetregels.Read: alleen lezen van Projectbudgetregels
+ Projectontwikkeling.Projectbudgetregels.ReadWrite: lezen en schrijven van Projectbudgetregels
+ Projectontwikkeling.Projectdoelstellingen.Read: alleen lezen van Projectdoelstellingen
+ Projectontwikkeling.Projectdoelstellingen.ReadWrite: lezen en schrijven van Projectdoelstellingen
+ Projectontwikkeling.Projectfasen.Read: alleen lezen van Projectfasen
+ Projectontwikkeling.Projectfasen.ReadWrite: lezen en schrijven van Projectfasen
+ Projectontwikkeling.Projectfasebesluiten.Read: alleen lezen van Projectfasebesluiten
+ Projectontwikkeling.Projectfasebesluiten.ReadWrite: lezen en schrijven van Projectfasebesluiten
+ Projectontwikkeling.Projectorders.Read: alleen lezen van Projectorders
+ Projectontwikkeling.Projectorders.ReadWrite: lezen en schrijven van Projectorders
+ Projectontwikkeling.Projectrollen.Read: alleen lezen van Projectrollen
+ Projectontwikkeling.Projectrollen.ReadWrite: lezen en schrijven van Projectrollen
+ Projectontwikkeling.Projecttaken.Read: alleen lezen van Projecttaken
+ Projectontwikkeling.Projecttaken.ReadWrite: lezen en schrijven van Projecttaken
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Projectontwikkeling.All.Read: alleen lezen van alle resources
Projectontwikkeling.All.ReadWrite: lezen en schrijven van alle resources
@@ -2665,38 +2689,38 @@ components:
items:
type: string
format: uri
- description: Referenties naar Aanbesteding in informatiedomein Financien
+ description: Referenties naar Aanbesteding-sleutels in informatiedomein Financien
clusters:
type: array
items:
type: string
format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
doelstelling:
allOf:
- - $ref: '#/components/schemas/Projectdoelstelling'
+ - $ref: '#/components/schemas/Projectdoelstelling-sleutels'
description: De set criteria die samen de doelstelling van het project en de kaders waarbinnen het project gerealiseerd moet worden, representeert.
dossier:
type: string
format: uri
- description: Referentie naar Dossier in informatiedomein Dossier
+ description: Referentie naar Dossier-sleutels in informatiedomein Dossier
eenheden:
type: array
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
fasen:
description: De fasen die het project doorloopt of heeft doorlopen. Omdat iedere fase een begin- en een einddatum heeft, kan op ieder moment worden bepaald in welke fase het project bevindt. Een project bevindt zich bijvoorbeeld in de Initiatieffase of in de Realisatiefase.
type: array
items:
- $ref: '#/components/schemas/Projectfase'
+ $ref: '#/components/schemas/Projectfase-sleutels'
percelen:
type: array
items:
type: string
format: uri
- description: Referenties naar KadasterPerceel in informatiedomein Vastgoed
+ description: Referenties naar KadasterPerceel-sleutels in informatiedomein Vastgoed
regiesoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2705,7 +2729,7 @@ components:
description: De rol die een aan een project verbonden relatie (een natuurlijk persoon of rechtspersoon) heeft binnen de context van het project.
type: array
items:
- $ref: '#/components/schemas/Projectrol'
+ $ref: '#/components/schemas/Projectrol-sleutels'
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -2732,7 +2756,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -2744,7 +2768,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -2799,11 +2823,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projectdoelstellingbericht:
- allOf:
- - $ref: '#/components/schemas/Projectdoelstelling'
- - $ref: '#/components/schemas/Bericht-basis'
- Projectdoelstelling:
+ Projectdoelstelling-sleutels:
type: object
properties:
id:
@@ -2822,96 +2842,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- gewensteBegindatum:
- type: string
- format: date-time
- description: De tot doel gestelde begindatum van het project.
- gewensteEinddatum:
- type: string
- format: date-time
- description: De tot doel gestelde einddatum van het project.
- aantalGetransformeerdeEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal eenheden na transformatie.
- aantalTeBouwenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal nieuw te bouwen eenheden.
- aantalTeRenoverenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal te renoveren eenheden.
- aantalTeSlopenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal te slopen eenheden.
- aantalTeTransformerenEenheden:
- type: integer
- format: int32
- description: Het verwachte aantal te transformeren eenheden.
- beleidswaarde:
- type: string
- format: uri
- description: Referentie naar Beleidswaarde in informatiedomein Vastgoed
- brutoAanvangsrendement:
- type: number
- format: float
- description: De (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst gedeeld door de totale investeringskosten. Meestal afgekort tot BAR.
- gemBVOPerEenheid:
- type: integer
- format: int32
- description: De gemiddelde bruto vloeroppervlakte per eenheid van het op te leveren vastgoed.
- gemGBOPerEenheid:
- type: integer
- format: int32
- description: De gemiddelde gebruiksoppervlakte per eenheid van het op te leveren vastgoed.
- gemiddeldeEnergieindex:
- type: integer
- format: int32
- description: De gemiddelde energie index per eenheid van het op te leveren vastgoed.
- gemiddeldeHuurprijs:
- type: number
- format: float
- description: De gemiddelde netto huurprijs per eenheid van het op te leveren vastgoed.
- gemiddeldeWoningwaarderingsPunten:
- type: number
- format: float
- description: Het gemiddeld aantal WWS-punten per eenheid van het op te leveren vastgoed.
- gemVVOPerEenheid:
- type: integer
- format: int32
- description: De gemiddelde verhuurbare vloeroppervlakte per eenheid van het op te leveren vastgoed.
- initieleBudgetregels:
- description: Het voor het project benodigde budget en eventueel de beoogde opbrengsten, opgesplitst in een of meerdere projectbudgetregels.
- type: array
- items:
- $ref: '#/components/schemas/Projectbudgetregel'
- internalRateOfReturn:
- type: number
- format: float
- description: De rentevoet waarbij de som van de contante waarden van de verwachte toekomstige opbrengsten gelijk is aan de investering. Meestal afgekort tot IRR.
- maatschappelijkLabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort het project tot de DAEB-tak of tot de niet-DAEB-tak. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
- marktwaarde:
- type: string
- format: uri
- description: Referentie naar Marktwaarde in informatiedomein Vastgoed
- nettoAanvangsrendement:
- type: number
- format: float
- description: De verwachte (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst minus de exploitatiekosten gedeeld door de totale investeringskosten. Meestal afgekort tot NAR.
- project:
- allOf:
- - $ref: '#/components/schemas/Project-sleutels'
- description: Het project waar de doelstelling betrekking op heeft.
- Projectbudgetregelbericht:
- allOf:
- - $ref: '#/components/schemas/Projectbudgetregel'
- - $ref: '#/components/schemas/Bericht-basis'
- Projectbudgetregel:
+ Projectfase-sleutels:
type: object
properties:
id:
@@ -2929,77 +2860,8 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Via Projectbudgetregelsoort wordt het onderscheid gemaakt tussen Prognose-bedragen en Budget-bedragen, die daardoor naast elkaar gepresenteerd kunnen worden. Referentiedatasoort PROJECTBUDGETREGELSOORT.
- regelsoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: In combinatie met bovenliggendeBudgetregel kan met behulp van het attribuut projectbudgetregelregelsoort een hiërarchische structuur binnen budgetregels worden weergegeven. Hierbij worden detail-, en subtotaalregels onderscheiden. Ook wordt via de regelsoort het onderscheid tussen kosten en opbrengsten aangegeven. Referentiedatasoort PROJECTBUDGETREGELREGELSOORT.
- omschrijving:
- type: string
- format: any
- description: De omschrijving of naam van de projectbudgetregel.
- bovenliggendeBudgetregel:
- allOf:
- - $ref: '#/components/schemas/Projectbudgetregel-sleutels'
- description: De budgetregel die hiërarchisch boven de budgetregel ligt.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de budgetregel, bijvoorbeeld aangevraagd, bijgesteld, vrijgegeven, goedgekeurd. Door de attributen status en soort te combineren, en met begin- en einddatums, kan de gehele cyclus van een budgetregel in de tijd worden gevolgd (van goedgekeurde prognose via bijgestelde prognose en aangevraagd budget naar vrijgegeven budget). Referentiedatasoort PROJECTBUDGETREGELSTATUS.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van de projectbudgetregel.
- einddatum:
- type: string
- format: date-time
- description: De einddatum van de projectbudgetregel.
- datumAanvraag:
- type: string
- format: date-time
- description: De datum waarop een aanvraag wordt gedaan voor goedkeuring van een budgetregel, bijvoorbeeld voor een bijgestelde prognose of voor aanvullend budget.
- datumGoedkeuring:
- type: string
- format: date-time
- description: De datum waarom goedkeuring is verkregen voor een aanvraag, van bijvoorbeeld een bijgestelde prognose of aanvullend budget.
- bedrag:
- type: number
- format: float
- description: Bedrag exclusief BTW. van de budgetregel.
- bestedingen:
- description: sleutels
- type: array
- items:
- $ref: '#/components/schemas/Projectbesteding'
- btwTarief:
- type: string
- format: uri
- description: Referentie naar BtwTarief in informatiedomein Financien
- doelstelling:
- allOf:
- - $ref: '#/components/schemas/Projectdoelstelling-sleutels'
- description: De (financiële) kaders waarbinnen het project gerealiseerd moet worden. Afhankelijk van het soort project kan dit op hoog aggregatieniveau (een of enkele budgetregels met totalen) of in meer details (uitgesplitst in meer detailregels in een hiërarchische structuur).
- fase:
- allOf:
- - $ref: '#/components/schemas/Projectfase'
- description: De projectfase waarvoor de budgetregel geldig is.
- fasebesluit:
- allOf:
- - $ref: '#/components/schemas/Projectfasebesluit'
- description: Het fasebesluit waarin de budgetregel ter goedkeuring is voorgelegd aan de opdrachtgever.
- grootboekrekening:
- type: string
- format: uri
- description: Referentie naar Grootboekrekening in informatiedomein Financien
- order:
- allOf:
- - $ref: '#/components/schemas/Projectorder'
- description: De inkooporder die is verstrekt met een verwijzing naar de projectbudgetregel. De kosten van de order zullen, met andere woorden, ten laste komen van de budgetregel.
- Projectbudgetregel-sleutels:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ Projectrol-sleutels:
type: object
properties:
id:
@@ -3079,7 +2941,7 @@ components:
description: De meeteenheid waarin de besteding wordt gemeten. Bijv. uur, liter etc. Referentiedatasoort MEETEENHEID.
order:
allOf:
- - $ref: '#/components/schemas/Projectorder'
+ - $ref: '#/components/schemas/Projectorder-sleutels'
description: De projectorder die ten grondslag ligt aan de besteding, indien werkzaamheden door een externe partij zijn uitvoerd.
reistijd:
type: string
@@ -3088,13 +2950,9 @@ components:
description: De reistijd.
taak:
allOf:
- - $ref: '#/components/schemas/Projecttaak'
+ - $ref: '#/components/schemas/Projecttaak-sleutels'
description: De taak die de werkzaamheden omschrijft waarvoor de besteding is geregistreerd.
- Projectorderbericht:
- allOf:
- - $ref: '#/components/schemas/Projectorder'
- - $ref: '#/components/schemas/Bericht-basis'
- Projectorder:
+ Projectbudgetregel-sleutels:
type: object
properties:
id:
@@ -3113,33 +2971,26 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- afrekenwijze:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De wijze waarop de projectorder wordt afgerekend (of niet). Bijvoorbeeld: Nacalculatie regie, Nacalculatie eenheidsprijzen, Vaste prijs, Afkoop, Garantie Referentiedatasoort AFREKENWIJZESOORT.'
- bestedingen:
- description: De besteding(en) die via de order zijn geregistreerd.
- type: array
- items:
- $ref: '#/components/schemas/Projectbesteding-sleutels'
- budgetregels:
- description: De projectbudgetregel(s) waarmee dekking is verkregen voor de projectorder.
- type: array
- items:
- $ref: '#/components/schemas/Projectbudgetregel-sleutels'
- inkoopopdracht:
+ Projectorder-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: uri
- description: Referentie naar Inkoopopdracht in informatiedomein Financien
- overeenkomst:
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- taak:
- allOf:
- - $ref: '#/components/schemas/Projecttaak'
- description: De taak die de werkzaamheden omschrijft waarvoor de projectorder is verstrekt.
- Projectbesteding-sleutels:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Projecttaak-sleutels:
type: object
properties:
id:
@@ -3158,11 +3009,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projecttaakbericht:
+ Projectbudgetregelbericht:
allOf:
- - $ref: '#/components/schemas/Projecttaak'
+ - $ref: '#/components/schemas/Projectbudgetregel'
- $ref: '#/components/schemas/Bericht-basis'
- Projecttaak:
+ Projectbudgetregel:
type: object
properties:
id:
@@ -3184,74 +3035,218 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Om een ordening te kunnen maken in de vele mogelijke taken die binnen een projectfase uitgevoerd worden, kan een taak een projecttaaksoort krijgen. Bijvoorbeeld: Controlerende taken, Uitvoerende taken, Administratieve taken. Referentiedatasoort PROJECTTAAKSOORT.'
- detailSoort:
- allOf:
+ description: Via Projectbudgetregelsoort wordt het onderscheid gemaakt tussen Prognose-bedragen en Budget-bedragen, die daardoor naast elkaar gepresenteerd kunnen worden. Referentiedatasoort PROJECTBUDGETREGELSOORT.
+ regelsoort:
+ allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Nadere aanduiding van een projecttaaksoort. Bijvoorbeeld: Maken communicatieplan, Opleveren DO, Inrichten modelwoning, Uitvoeren draagvlakmeting, Toezicht op de bouw, Actualiseren MJOP, Informeren bewoners, Verlenen decharge projectteam, Uitvoeren bewonersenquête Referentiedatasoort PROJECTTAAKDETAILSOORT.'
+ description: In combinatie met bovenliggendeBudgetregel kan met behulp van het attribuut projectbudgetregelregelsoort een hiërarchische structuur binnen budgetregels worden weergegeven. Hierbij worden detail-, en subtotaalregels onderscheiden. Ook wordt via de regelsoort het onderscheid tussen kosten en opbrengsten aangegeven. Referentiedatasoort PROJECTBUDGETREGELREGELSOORT.
omschrijving:
type: string
format: any
- description: De omschrijving of naam van de taak.
+ description: De omschrijving of naam van de projectbudgetregel.
+ bovenliggendeBudgetregel:
+ allOf:
+ - $ref: '#/components/schemas/Projectbudgetregel-sleutels'
+ description: De budgetregel die hiërarchisch boven de budgetregel ligt.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de budgetregel, bijvoorbeeld aangevraagd, bijgesteld, vrijgegeven, goedgekeurd. Door de attributen status en soort te combineren, en met begin- en einddatums, kan de gehele cyclus van een budgetregel in de tijd worden gevolgd (van goedgekeurde prognose via bijgestelde prognose en aangevraagd budget naar vrijgegeven budget). Referentiedatasoort PROJECTBUDGETREGELSTATUS.
begindatum:
type: string
format: date-time
- description: De werkelijke begindatum van uitvoering van de taak.
+ description: De begindatum van de projectbudgetregel.
einddatum:
type: string
format: date-time
- description: De werkelijke einddatum van uitvoering van de taak.
- gewensteBegindatum:
+ description: De einddatum van de projectbudgetregel.
+ datumAanvraag:
type: string
format: date-time
- description: De gewenste begindatum van uitvoering van de taak.
- gewensteEinddatum:
+ description: De datum waarop een aanvraag wordt gedaan voor goedkeuring van een budgetregel, bijvoorbeeld voor een bijgestelde prognose of voor aanvullend budget.
+ datumGoedkeuring:
type: string
format: date-time
- description: De gewenste einddatum van uitvoering van de taak.
+ description: De datum waarom goedkeuring is verkregen voor een aanvraag, van bijvoorbeeld een bijgestelde prognose of aanvullend budget.
+ bedrag:
+ type: number
+ format: float
+ description: Bedrag exclusief BTW. van de budgetregel.
bestedingen:
- description: De besteding(en) die tijdens of als gevolg van het uitvoeren van de taak zijn geregistreerd.
+ description: De projectbesteding(en) die zijn gedaan met een verwijzing naar de projectbudgetregel. De kosten van de bestedingen zullen, met andere woorden, ten laste komen van de budgetregel.
type: array
items:
$ref: '#/components/schemas/Projectbesteding-sleutels'
- clusters:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Cluster in informatiedomein Vastgoed
- eenheden:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ btwTarief:
+ type: string
+ format: uri
+ description: Referentie naar BtwTarief-sleutels in informatiedomein Financien
+ doelstelling:
+ allOf:
+ - $ref: '#/components/schemas/Projectdoelstelling-sleutels'
+ description: De (financiële) kaders waarbinnen het project gerealiseerd moet worden. Afhankelijk van het soort project kan dit op hoog aggregatieniveau (een of enkele budgetregels met totalen) of in meer details (uitgesplitst in meer detailregels in een hiërarchische structuur).
fase:
allOf:
- - $ref: '#/components/schemas/Projectfase'
- description: De fase waarbinnen de taak wordt uitgevoerd.
- kwaliteitsmetingen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Kwaliteitsmetingsverzoek in informatiedomein Kwaliteit
- orders:
- description: De order(s) die is of zijn verstrekt tijdens of als gevolg van het uitvoeren van de taak.
- type: array
- items:
- $ref: '#/components/schemas/Projectorder-sleutels'
- percelen:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar KadasterPerceel in informatiedomein Vastgoed
- rollen:
- description: De projectrol (i.c. een relatie die in de context van de taak een bepaalde rol vervult) die bij uitvoering van de taak een functie heeft.
+ - $ref: '#/components/schemas/Projectfase-sleutels'
+ description: De projectfase waarvoor de budgetregel geldig is.
+ fasebesluit:
+ allOf:
+ - $ref: '#/components/schemas/Projectfasebesluit-sleutels'
+ description: Het fasebesluit waarin de budgetregel ter goedkeuring is voorgelegd aan de opdrachtgever.
+ grootboekrekening:
+ type: string
+ format: uri
+ description: Referentie naar Grootboekrekening-sleutels in informatiedomein Financien
+ order:
+ allOf:
+ - $ref: '#/components/schemas/Projectorder-sleutels'
+ description: De inkooporder die is verstrekt met een verwijzing naar de projectbudgetregel. De kosten van de order zullen, met andere woorden, ten laste komen van de budgetregel.
+ Projectbesteding-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Projectfasebesluit-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Projectdoelstellingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Projectdoelstelling'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Projectdoelstelling:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ gewensteBegindatum:
+ type: string
+ format: date-time
+ description: De tot doel gestelde begindatum van het project.
+ gewensteEinddatum:
+ type: string
+ format: date-time
+ description: De tot doel gestelde einddatum van het project.
+ aantalGetransformeerdeEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal eenheden na transformatie.
+ aantalTeBouwenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal nieuw te bouwen eenheden.
+ aantalTeRenoverenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal te renoveren eenheden.
+ aantalTeSlopenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal te slopen eenheden.
+ aantalTeTransformerenEenheden:
+ type: integer
+ format: int32
+ description: Het verwachte aantal te transformeren eenheden.
+ beleidswaarde:
+ type: string
+ format: uri
+ description: Referentie naar Beleidswaarde-sleutels in informatiedomein Vastgoed
+ brutoAanvangsrendement:
+ type: number
+ format: float
+ description: De (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst gedeeld door de totale investeringskosten. Meestal afgekort tot BAR.
+ gemBVOPerEenheid:
+ type: integer
+ format: int32
+ description: De gemiddelde bruto vloeroppervlakte per eenheid van het op te leveren vastgoed.
+ gemGBOPerEenheid:
+ type: integer
+ format: int32
+ description: De gemiddelde gebruiksoppervlakte per eenheid van het op te leveren vastgoed.
+ gemiddeldeEnergieindex:
+ type: integer
+ format: int32
+ description: De gemiddelde energie index per eenheid van het op te leveren vastgoed.
+ gemiddeldeHuurprijs:
+ type: number
+ format: float
+ description: De gemiddelde netto huurprijs per eenheid van het op te leveren vastgoed.
+ gemiddeldeWoningwaarderingsPunten:
+ type: number
+ format: float
+ description: Het gemiddeld aantal WWS-punten per eenheid van het op te leveren vastgoed.
+ gemVVOPerEenheid:
+ type: integer
+ format: int32
+ description: De gemiddelde verhuurbare vloeroppervlakte per eenheid van het op te leveren vastgoed.
+ initieleBudgetregels:
+ description: Het voor het project benodigde budget en eventueel de beoogde opbrengsten, opgesplitst in een of meerdere projectbudgetregels.
type: array
items:
- $ref: '#/components/schemas/Projectrol'
+ $ref: '#/components/schemas/Projectbudgetregel-sleutels'
+ internalRateOfReturn:
+ type: number
+ format: float
+ description: De rentevoet waarbij de som van de contante waarden van de verwachte toekomstige opbrengsten gelijk is aan de investering. Meestal afgekort tot IRR.
+ maatschappelijkLabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort het project tot de DAEB-tak of tot de niet-DAEB-tak. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
+ marktwaarde:
+ type: string
+ format: uri
+ description: Referentie naar Marktwaarde-sleutels in informatiedomein Vastgoed
+ nettoAanvangsrendement:
+ type: number
+ format: float
+ description: De verwachte (markt)waarde van het project uitgedrukt als percentage van de huuropbrengst minus de exploitatiekosten gedeeld door de totale investeringskosten. Meestal afgekort tot NAR.
+ project:
+ allOf:
+ - $ref: '#/components/schemas/Project-sleutels'
+ description: Het project waar de doelstelling betrekking op heeft.
Projectfasebericht:
allOf:
- $ref: '#/components/schemas/Projectfase'
@@ -3297,7 +3292,7 @@ components:
description: De gewenste, of beoogde, einddatum van de projectfase.
besluit:
allOf:
- - $ref: '#/components/schemas/Projectfasebesluit'
+ - $ref: '#/components/schemas/Projectfasebesluit-sleutels'
description: Het Projectfasebesluit-document waarmee het einde van een projectfase wordt gemarkeerd.
budgetregels:
description: De budgetregels die bij de projectfase horen. Iedere fase wordt afgesloten met een fasebesluit waarin alle budgetregels binnen de fase worden beëindigd. Een nieuwe verzameling budgetregels wordt gekoppeld aan de volgende fase. Zo heeft iedere projectfase een eigen verzameling budgetregels.
@@ -3312,7 +3307,7 @@ components:
description: De rol(len) van de aan de projectfase verbonden relatie(s) heeft. Zo kan dezelfde relatie binnen een project verschillende rollen vervullen afhankelijk van de projectfase.
type: array
items:
- $ref: '#/components/schemas/Projectrol'
+ $ref: '#/components/schemas/Projectrol-sleutels'
taken:
description: De projecttaken die horen bij de fase.
type: array
@@ -3366,7 +3361,11 @@ components:
allOf:
- $ref: '#/components/schemas/Projectfase-sleutels'
description: De fase waarop het fasebesluit betrekking heeft.
- Projectfase-sleutels:
+ Projectorderbericht:
+ allOf:
+ - $ref: '#/components/schemas/Projectorder'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Projectorder:
type: object
properties:
id:
@@ -3384,7 +3383,33 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ afrekenwijze:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De wijze waarop de projectorder wordt afgerekend (of niet). Bijvoorbeeld: Nacalculatie regie, Nacalculatie eenheidsprijzen, Vaste prijs, Afkoop, Garantie Referentiedatasoort AFREKENWIJZESOORT.'
+ bestedingen:
+ description: De besteding(en) die via de order zijn geregistreerd.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectbesteding-sleutels'
+ budgetregels:
+ description: De projectbudgetregel(s) waarmee dekking is verkregen voor de projectorder.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectbudgetregel-sleutels'
+ inkoopopdracht:
+ type: string
+ format: uri
+ description: Referentie naar Inkoopopdracht-sleutels in informatiedomein Financien
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ taak:
+ allOf:
+ - $ref: '#/components/schemas/Projecttaak-sleutels'
+ description: De taak die de werkzaamheden omschrijft waarvoor de projectorder is verstrekt.
Projectrolbericht:
allOf:
- $ref: '#/components/schemas/Projectrol'
@@ -3436,13 +3461,17 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
taken:
description: De taak of taken waarbij de projectrol (i.c. een relatie die in de context van de taak een bepaalde rol vervult) een functie heeft.
type: array
items:
$ref: '#/components/schemas/Projecttaak-sleutels'
- Projecttaak-sleutels:
+ Projecttaakbericht:
+ allOf:
+ - $ref: '#/components/schemas/Projecttaak'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Projecttaak:
type: object
properties:
id:
@@ -3461,44 +3490,77 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projectorder-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Om een ordening te kunnen maken in de vele mogelijke taken die binnen een projectfase uitgevoerd worden, kan een taak een projecttaaksoort krijgen. Bijvoorbeeld: Controlerende taken, Uitvoerende taken, Administratieve taken. Referentiedatasoort PROJECTTAAKSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Nadere aanduiding van een projecttaaksoort. Bijvoorbeeld: Maken communicatieplan, Opleveren DO, Inrichten modelwoning, Uitvoeren draagvlakmeting, Toezicht op de bouw, Actualiseren MJOP, Informeren bewoners, Verlenen decharge projectteam, Uitvoeren bewonersenquête Referentiedatasoort PROJECTTAAKDETAILSOORT.'
+ omschrijving:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Projectdoelstelling-sleutels:
- type: object
- properties:
- id:
+ description: De omschrijving of naam van de taak.
+ begindatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
+ format: date-time
+ description: De werkelijke begindatum van uitvoering van de taak.
+ einddatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ format: date-time
+ description: De werkelijke einddatum van uitvoering van de taak.
+ gewensteBegindatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ format: date-time
+ description: De gewenste begindatum van uitvoering van de taak.
+ gewensteEinddatum:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ format: date-time
+ description: De gewenste einddatum van uitvoering van de taak.
+ bestedingen:
+ description: De besteding(en) die tijdens of als gevolg van het uitvoeren van de taak zijn geregistreerd.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectbesteding-sleutels'
+ clusters:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Cluster-sleutels in informatiedomein Vastgoed
+ eenheden:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
+ fase:
+ allOf:
+ - $ref: '#/components/schemas/Projectfase-sleutels'
+ description: De fase waarbinnen de taak wordt uitgevoerd.
+ kwaliteitsmetingen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Kwaliteitsmetingsverzoek-sleutels in informatiedomein Kwaliteit
+ orders:
+ description: De order(s) die is of zijn verstrekt tijdens of als gevolg van het uitvoeren van de taak.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectorder-sleutels'
+ percelen:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar KadasterPerceel-sleutels in informatiedomein Vastgoed
+ rollen:
+ description: De projectrol (i.c. een relatie die in de context van de taak een bepaalde rol vervult) die bij uitvoering van de taak een functie heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Projectrol-sleutels'
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Relaties.yaml b/docs/Informatiedomeinen/Relaties.yaml
index ee22106..8329cf7 100644
--- a/docs/Informatiedomeinen/Relaties.yaml
+++ b/docs/Informatiedomeinen/Relaties.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://relaties.vera.io:{port}/{basePath}
description: Productieserver
@@ -63,7 +63,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -79,7 +79,7 @@ paths:
get:
tags:
- 'Accounts'
- description: Ophalen van Accounts
+ summary: Ophalen van Accounts
operationId: listAccounts
parameters:
- name: params
@@ -129,7 +129,7 @@ paths:
post:
tags:
- 'Accounts'
- description: Voegt een nieuw(e) Account toe.
+ summary: Voegt een nieuw(e) Account toe.
operationId: createAccount
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -169,7 +169,7 @@ paths:
put:
tags:
- 'Accounts'
- description: |
+ summary: |
Vervangen van een Account op basis van overeenkomstige sleutelvelden.
operationId: replaceAccount
parameters:
@@ -204,7 +204,7 @@ paths:
patch:
tags:
- 'Accounts'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Account. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAccount
@@ -241,7 +241,7 @@ paths:
get:
tags:
- 'Accounts'
- description: Retourneert een Account met de gegeven identifier
+ summary: Retourneert een Account met de gegeven identifier
operationId: readAccountById
parameters:
- name: id
@@ -278,7 +278,7 @@ paths:
put:
tags:
- 'Accounts'
- description: Vervangen van een Account
+ summary: Vervangen van een Account
operationId: replaceAccountById
parameters:
- name: 'id'
@@ -316,7 +316,7 @@ paths:
patch:
tags:
- 'Accounts'
- description: Wijzigen van een Account
+ summary: Wijzigen van een Account
operationId: updateAccountById
parameters:
- name: 'id'
@@ -355,7 +355,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Ophalen van Afspraken
+ summary: Ophalen van Afspraken
operationId: listAfspraken
parameters:
- name: params
@@ -405,7 +405,7 @@ paths:
post:
tags:
- 'Afspraken'
- description: Voegt een nieuw(e) Afspraak toe.
+ summary: Voegt een nieuw(e) Afspraak toe.
operationId: createAfspraak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -445,7 +445,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: |
+ summary: |
Vervangen van een Afspraak op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraak
parameters:
@@ -480,7 +480,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Afspraak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraak
@@ -517,7 +517,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Retourneert een Afspraak met de gegeven identifier
+ summary: Retourneert een Afspraak met de gegeven identifier
operationId: readAfspraakById
parameters:
- name: id
@@ -554,7 +554,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: Vervangen van een Afspraak
+ summary: Vervangen van een Afspraak
operationId: replaceAfspraakById
parameters:
- name: 'id'
@@ -592,7 +592,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: Wijzigen van een Afspraak
+ summary: Wijzigen van een Afspraak
operationId: updateAfspraakById
parameters:
- name: 'id'
@@ -631,7 +631,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Ophalen van AfspraakOpties
+ summary: Ophalen van AfspraakOpties
operationId: listAfspraakOpties
parameters:
- name: params
@@ -681,7 +681,7 @@ paths:
post:
tags:
- 'AfspraakOpties'
- description: Voegt een nieuw(e) AfspraakOptie toe.
+ summary: Voegt een nieuw(e) AfspraakOptie toe.
operationId: createAfspraakOptie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -721,7 +721,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Vervangen van een AfspraakOptie op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraakOptie
parameters:
@@ -756,7 +756,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een AfspraakOptie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraakOptie
@@ -793,7 +793,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Retourneert een AfspraakOptie met de gegeven identifier
+ summary: Retourneert een AfspraakOptie met de gegeven identifier
operationId: readAfspraakOptieById
parameters:
- name: id
@@ -830,7 +830,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: Vervangen van een AfspraakOptie
+ summary: Vervangen van een AfspraakOptie
operationId: replaceAfspraakOptieById
parameters:
- name: 'id'
@@ -868,7 +868,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: Wijzigen van een AfspraakOptie
+ summary: Wijzigen van een AfspraakOptie
operationId: updateAfspraakOptieById
parameters:
- name: 'id'
@@ -907,7 +907,7 @@ paths:
get:
tags:
- 'Afspraakverzoeken'
- description: Ophalen van Afspraakverzoeken
+ summary: Ophalen van Afspraakverzoeken
operationId: listAfspraakverzoeken
parameters:
- name: params
@@ -957,7 +957,7 @@ paths:
post:
tags:
- 'Afspraakverzoeken'
- description: Voegt een nieuw(e) Afspraakverzoek toe.
+ summary: Voegt een nieuw(e) Afspraakverzoek toe.
operationId: createAfspraakverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -997,7 +997,7 @@ paths:
put:
tags:
- 'Afspraakverzoeken'
- description: |
+ summary: |
Vervangen van een Afspraakverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraakverzoek
parameters:
@@ -1032,7 +1032,7 @@ paths:
patch:
tags:
- 'Afspraakverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Afspraakverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraakverzoek
@@ -1069,7 +1069,7 @@ paths:
get:
tags:
- 'Afspraakverzoeken'
- description: Retourneert een Afspraakverzoek met de gegeven identifier
+ summary: Retourneert een Afspraakverzoek met de gegeven identifier
operationId: readAfspraakverzoekById
parameters:
- name: id
@@ -1106,7 +1106,7 @@ paths:
put:
tags:
- 'Afspraakverzoeken'
- description: Vervangen van een Afspraakverzoek
+ summary: Vervangen van een Afspraakverzoek
operationId: replaceAfspraakverzoekById
parameters:
- name: 'id'
@@ -1144,7 +1144,7 @@ paths:
patch:
tags:
- 'Afspraakverzoeken'
- description: Wijzigen van een Afspraakverzoek
+ summary: Wijzigen van een Afspraakverzoek
operationId: updateAfspraakverzoekById
parameters:
- name: 'id'
@@ -1183,7 +1183,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Ophalen van Betaalgegevens
+ summary: Ophalen van Betaalgegevens
operationId: listBetaalgegevens
parameters:
- name: params
@@ -1233,7 +1233,7 @@ paths:
post:
tags:
- 'Betaalgegevens'
- description: Voegt een nieuw(e) Betaalgegeven toe.
+ summary: Voegt een nieuw(e) Betaalgegeven toe.
operationId: createBetaalgegeven
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1273,7 +1273,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Vervangen van een Betaalgegeven op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalgegeven
parameters:
@@ -1308,7 +1308,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalgegeven. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalgegeven
@@ -1345,7 +1345,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Retourneert een Betaalgegeven met de gegeven identifier
+ summary: Retourneert een Betaalgegeven met de gegeven identifier
operationId: readBetaalgegevenById
parameters:
- name: id
@@ -1382,7 +1382,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: Vervangen van een Betaalgegeven
+ summary: Vervangen van een Betaalgegeven
operationId: replaceBetaalgegevenById
parameters:
- name: 'id'
@@ -1420,7 +1420,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: Wijzigen van een Betaalgegeven
+ summary: Wijzigen van een Betaalgegeven
operationId: updateBetaalgegevenById
parameters:
- name: 'id'
@@ -1459,7 +1459,7 @@ paths:
get:
tags:
- 'Contactgegevens'
- description: Ophalen van Contactgegevens
+ summary: Ophalen van Contactgegevens
operationId: listContactgegevens
parameters:
- name: params
@@ -1509,7 +1509,7 @@ paths:
post:
tags:
- 'Contactgegevens'
- description: Voegt een nieuw(e) Contactgegeven toe.
+ summary: Voegt een nieuw(e) Contactgegeven toe.
operationId: createContactgegeven
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1549,7 +1549,7 @@ paths:
put:
tags:
- 'Contactgegevens'
- description: |
+ summary: |
Vervangen van een Contactgegeven op basis van overeenkomstige sleutelvelden.
operationId: replaceContactgegeven
parameters:
@@ -1584,7 +1584,7 @@ paths:
patch:
tags:
- 'Contactgegevens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Contactgegeven. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateContactgegeven
@@ -1621,7 +1621,7 @@ paths:
get:
tags:
- 'Contactgegevens'
- description: Retourneert een Contactgegeven met de gegeven identifier
+ summary: Retourneert een Contactgegeven met de gegeven identifier
operationId: readContactgegevenById
parameters:
- name: id
@@ -1658,7 +1658,7 @@ paths:
put:
tags:
- 'Contactgegevens'
- description: Vervangen van een Contactgegeven
+ summary: Vervangen van een Contactgegeven
operationId: replaceContactgegevenById
parameters:
- name: 'id'
@@ -1696,7 +1696,7 @@ paths:
patch:
tags:
- 'Contactgegevens'
- description: Wijzigen van een Contactgegeven
+ summary: Wijzigen van een Contactgegeven
operationId: updateContactgegevenById
parameters:
- name: 'id'
@@ -1735,7 +1735,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Ophalen van Contactmomenten
+ summary: Ophalen van Contactmomenten
operationId: listContactmomenten
parameters:
- name: params
@@ -1785,7 +1785,7 @@ paths:
post:
tags:
- 'Contactmomenten'
- description: Voegt een nieuw(e) Contactmoment toe.
+ summary: Voegt een nieuw(e) Contactmoment toe.
operationId: createContactmoment
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1825,7 +1825,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Vervangen van een Contactmoment op basis van overeenkomstige sleutelvelden.
operationId: replaceContactmoment
parameters:
@@ -1860,7 +1860,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Contactmoment. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateContactmoment
@@ -1897,7 +1897,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Retourneert een Contactmoment met de gegeven identifier
+ summary: Retourneert een Contactmoment met de gegeven identifier
operationId: readContactmomentById
parameters:
- name: id
@@ -1934,7 +1934,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: Vervangen van een Contactmoment
+ summary: Vervangen van een Contactmoment
operationId: replaceContactmomentById
parameters:
- name: 'id'
@@ -1972,7 +1972,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: Wijzigen van een Contactmoment
+ summary: Wijzigen van een Contactmoment
operationId: updateContactmomentById
parameters:
- name: 'id'
@@ -2011,7 +2011,7 @@ paths:
get:
tags:
- 'Inkomens'
- description: Ophalen van Inkomens
+ summary: Ophalen van Inkomens
operationId: listInkomens
parameters:
- name: params
@@ -2061,7 +2061,7 @@ paths:
post:
tags:
- 'Inkomens'
- description: Voegt een nieuw(e) Inkomen toe.
+ summary: Voegt een nieuw(e) Inkomen toe.
operationId: createInkomen
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2101,7 +2101,7 @@ paths:
put:
tags:
- 'Inkomens'
- description: |
+ summary: |
Vervangen van een Inkomen op basis van overeenkomstige sleutelvelden.
operationId: replaceInkomen
parameters:
@@ -2136,7 +2136,7 @@ paths:
patch:
tags:
- 'Inkomens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkomen. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkomen
@@ -2173,7 +2173,7 @@ paths:
get:
tags:
- 'Inkomens'
- description: Retourneert een Inkomen met de gegeven identifier
+ summary: Retourneert een Inkomen met de gegeven identifier
operationId: readInkomenById
parameters:
- name: id
@@ -2210,7 +2210,7 @@ paths:
put:
tags:
- 'Inkomens'
- description: Vervangen van een Inkomen
+ summary: Vervangen van een Inkomen
operationId: replaceInkomenById
parameters:
- name: 'id'
@@ -2248,7 +2248,7 @@ paths:
patch:
tags:
- 'Inkomens'
- description: Wijzigen van een Inkomen
+ summary: Wijzigen van een Inkomen
operationId: updateInkomenById
parameters:
- name: 'id'
@@ -2287,7 +2287,7 @@ paths:
get:
tags:
- 'NatuurlijkPersonen'
- description: Ophalen van NatuurlijkPersonen
+ summary: Ophalen van NatuurlijkPersonen
operationId: listNatuurlijkPersonen
parameters:
- name: params
@@ -2337,7 +2337,7 @@ paths:
post:
tags:
- 'NatuurlijkPersonen'
- description: Voegt een nieuw(e) NatuurlijkPersoon toe.
+ summary: Voegt een nieuw(e) NatuurlijkPersoon toe.
operationId: createNatuurlijkPersoon
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2377,7 +2377,7 @@ paths:
put:
tags:
- 'NatuurlijkPersonen'
- description: |
+ summary: |
Vervangen van een NatuurlijkPersoon op basis van overeenkomstige sleutelvelden.
operationId: replaceNatuurlijkPersoon
parameters:
@@ -2412,7 +2412,7 @@ paths:
patch:
tags:
- 'NatuurlijkPersonen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een NatuurlijkPersoon. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateNatuurlijkPersoon
@@ -2449,7 +2449,7 @@ paths:
get:
tags:
- 'NatuurlijkPersonen'
- description: Retourneert een NatuurlijkPersoon met de gegeven identifier
+ summary: Retourneert een NatuurlijkPersoon met de gegeven identifier
operationId: readNatuurlijkPersoonById
parameters:
- name: id
@@ -2486,7 +2486,7 @@ paths:
put:
tags:
- 'NatuurlijkPersonen'
- description: Vervangen van een NatuurlijkPersoon
+ summary: Vervangen van een NatuurlijkPersoon
operationId: replaceNatuurlijkPersoonById
parameters:
- name: 'id'
@@ -2524,7 +2524,7 @@ paths:
patch:
tags:
- 'NatuurlijkPersonen'
- description: Wijzigen van een NatuurlijkPersoon
+ summary: Wijzigen van een NatuurlijkPersoon
operationId: updateNatuurlijkPersoonById
parameters:
- name: 'id'
@@ -2563,7 +2563,7 @@ paths:
get:
tags:
- 'Onderhoudsleveranciers'
- description: Ophalen van Onderhoudsleveranciers
+ summary: Ophalen van Onderhoudsleveranciers
operationId: listOnderhoudsleveranciers
parameters:
- name: params
@@ -2613,7 +2613,7 @@ paths:
post:
tags:
- 'Onderhoudsleveranciers'
- description: Voegt een nieuw(e) Onderhoudsleverancier toe.
+ summary: Voegt een nieuw(e) Onderhoudsleverancier toe.
operationId: createOnderhoudsleverancier
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2653,7 +2653,7 @@ paths:
put:
tags:
- 'Onderhoudsleveranciers'
- description: |
+ summary: |
Vervangen van een Onderhoudsleverancier op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsleverancier
parameters:
@@ -2688,7 +2688,7 @@ paths:
patch:
tags:
- 'Onderhoudsleveranciers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsleverancier. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsleverancier
@@ -2725,7 +2725,7 @@ paths:
get:
tags:
- 'Onderhoudsleveranciers'
- description: Retourneert een Onderhoudsleverancier met de gegeven identifier
+ summary: Retourneert een Onderhoudsleverancier met de gegeven identifier
operationId: readOnderhoudsleverancierById
parameters:
- name: id
@@ -2762,7 +2762,7 @@ paths:
put:
tags:
- 'Onderhoudsleveranciers'
- description: Vervangen van een Onderhoudsleverancier
+ summary: Vervangen van een Onderhoudsleverancier
operationId: replaceOnderhoudsleverancierById
parameters:
- name: 'id'
@@ -2800,7 +2800,7 @@ paths:
patch:
tags:
- 'Onderhoudsleveranciers'
- description: Wijzigen van een Onderhoudsleverancier
+ summary: Wijzigen van een Onderhoudsleverancier
operationId: updateOnderhoudsleverancierById
parameters:
- name: 'id'
@@ -2839,7 +2839,7 @@ paths:
get:
tags:
- 'Opleidingen'
- description: Ophalen van Opleidingen
+ summary: Ophalen van Opleidingen
operationId: listOpleidingen
parameters:
- name: params
@@ -2889,7 +2889,7 @@ paths:
post:
tags:
- 'Opleidingen'
- description: Voegt een nieuw(e) Opleiding toe.
+ summary: Voegt een nieuw(e) Opleiding toe.
operationId: createOpleiding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2929,7 +2929,7 @@ paths:
put:
tags:
- 'Opleidingen'
- description: |
+ summary: |
Vervangen van een Opleiding op basis van overeenkomstige sleutelvelden.
operationId: replaceOpleiding
parameters:
@@ -2964,7 +2964,7 @@ paths:
patch:
tags:
- 'Opleidingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Opleiding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOpleiding
@@ -3001,7 +3001,7 @@ paths:
get:
tags:
- 'Opleidingen'
- description: Retourneert een Opleiding met de gegeven identifier
+ summary: Retourneert een Opleiding met de gegeven identifier
operationId: readOpleidingById
parameters:
- name: id
@@ -3038,7 +3038,7 @@ paths:
put:
tags:
- 'Opleidingen'
- description: Vervangen van een Opleiding
+ summary: Vervangen van een Opleiding
operationId: replaceOpleidingById
parameters:
- name: 'id'
@@ -3076,7 +3076,7 @@ paths:
patch:
tags:
- 'Opleidingen'
- description: Wijzigen van een Opleiding
+ summary: Wijzigen van een Opleiding
operationId: updateOpleidingById
parameters:
- name: 'id'
@@ -3115,7 +3115,7 @@ paths:
get:
tags:
- 'Rechtspersonen'
- description: Ophalen van Rechtspersonen
+ summary: Ophalen van Rechtspersonen
operationId: listRechtspersonen
parameters:
- name: params
@@ -3165,7 +3165,7 @@ paths:
post:
tags:
- 'Rechtspersonen'
- description: Voegt een nieuw(e) Rechtspersoon toe.
+ summary: Voegt een nieuw(e) Rechtspersoon toe.
operationId: createRechtspersoon
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3205,7 +3205,7 @@ paths:
put:
tags:
- 'Rechtspersonen'
- description: |
+ summary: |
Vervangen van een Rechtspersoon op basis van overeenkomstige sleutelvelden.
operationId: replaceRechtspersoon
parameters:
@@ -3240,7 +3240,7 @@ paths:
patch:
tags:
- 'Rechtspersonen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Rechtspersoon. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRechtspersoon
@@ -3277,7 +3277,7 @@ paths:
get:
tags:
- 'Rechtspersonen'
- description: Retourneert een Rechtspersoon met de gegeven identifier
+ summary: Retourneert een Rechtspersoon met de gegeven identifier
operationId: readRechtspersoonById
parameters:
- name: id
@@ -3314,7 +3314,7 @@ paths:
put:
tags:
- 'Rechtspersonen'
- description: Vervangen van een Rechtspersoon
+ summary: Vervangen van een Rechtspersoon
operationId: replaceRechtspersoonById
parameters:
- name: 'id'
@@ -3352,7 +3352,7 @@ paths:
patch:
tags:
- 'Rechtspersonen'
- description: Wijzigen van een Rechtspersoon
+ summary: Wijzigen van een Rechtspersoon
operationId: updateRechtspersoonById
parameters:
- name: 'id'
@@ -3391,7 +3391,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Ophalen van Relaties
+ summary: Ophalen van Relaties
operationId: listRelaties
parameters:
- name: params
@@ -3441,7 +3441,7 @@ paths:
post:
tags:
- 'Relaties'
- description: Voegt een nieuw(e) Relatie toe.
+ summary: Voegt een nieuw(e) Relatie toe.
operationId: createRelatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3481,7 +3481,7 @@ paths:
put:
tags:
- 'Relaties'
- description: |
+ summary: |
Vervangen van een Relatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatie
parameters:
@@ -3516,7 +3516,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatie
@@ -3553,7 +3553,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Retourneert een Relatie met de gegeven identifier
+ summary: Retourneert een Relatie met de gegeven identifier
operationId: readRelatieById
parameters:
- name: id
@@ -3590,7 +3590,7 @@ paths:
put:
tags:
- 'Relaties'
- description: Vervangen van een Relatie
+ summary: Vervangen van een Relatie
operationId: replaceRelatieById
parameters:
- name: 'id'
@@ -3628,7 +3628,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: Wijzigen van een Relatie
+ summary: Wijzigen van een Relatie
operationId: updateRelatieById
parameters:
- name: 'id'
@@ -3667,7 +3667,7 @@ paths:
get:
tags:
- 'RelatieAdressen'
- description: Ophalen van RelatieAdressen
+ summary: Ophalen van RelatieAdressen
operationId: listRelatieAdressen
parameters:
- name: params
@@ -3717,7 +3717,7 @@ paths:
post:
tags:
- 'RelatieAdressen'
- description: Voegt een nieuw(e) RelatieAdres toe.
+ summary: Voegt een nieuw(e) RelatieAdres toe.
operationId: createRelatieAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3757,7 +3757,7 @@ paths:
put:
tags:
- 'RelatieAdressen'
- description: |
+ summary: |
Vervangen van een RelatieAdres op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatieAdres
parameters:
@@ -3792,7 +3792,7 @@ paths:
patch:
tags:
- 'RelatieAdressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een RelatieAdres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatieAdres
@@ -3829,7 +3829,7 @@ paths:
get:
tags:
- 'RelatieAdressen'
- description: Retourneert een RelatieAdres met de gegeven identifier
+ summary: Retourneert een RelatieAdres met de gegeven identifier
operationId: readRelatieAdresById
parameters:
- name: id
@@ -3866,7 +3866,7 @@ paths:
put:
tags:
- 'RelatieAdressen'
- description: Vervangen van een RelatieAdres
+ summary: Vervangen van een RelatieAdres
operationId: replaceRelatieAdresById
parameters:
- name: 'id'
@@ -3904,7 +3904,7 @@ paths:
patch:
tags:
- 'RelatieAdressen'
- description: Wijzigen van een RelatieAdres
+ summary: Wijzigen van een RelatieAdres
operationId: updateRelatieAdresById
parameters:
- name: 'id'
@@ -3943,7 +3943,7 @@ paths:
get:
tags:
- 'Relatiegroepen'
- description: Ophalen van Relatiegroepen
+ summary: Ophalen van Relatiegroepen
operationId: listRelatiegroepen
parameters:
- name: params
@@ -3993,7 +3993,7 @@ paths:
post:
tags:
- 'Relatiegroepen'
- description: Voegt een nieuw(e) Relatiegroep toe.
+ summary: Voegt een nieuw(e) Relatiegroep toe.
operationId: createRelatiegroep
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4033,7 +4033,7 @@ paths:
put:
tags:
- 'Relatiegroepen'
- description: |
+ summary: |
Vervangen van een Relatiegroep op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatiegroep
parameters:
@@ -4068,7 +4068,7 @@ paths:
patch:
tags:
- 'Relatiegroepen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatiegroep. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatiegroep
@@ -4105,7 +4105,7 @@ paths:
get:
tags:
- 'Relatiegroepen'
- description: Retourneert een Relatiegroep met de gegeven identifier
+ summary: Retourneert een Relatiegroep met de gegeven identifier
operationId: readRelatiegroepById
parameters:
- name: id
@@ -4142,7 +4142,7 @@ paths:
put:
tags:
- 'Relatiegroepen'
- description: Vervangen van een Relatiegroep
+ summary: Vervangen van een Relatiegroep
operationId: replaceRelatiegroepById
parameters:
- name: 'id'
@@ -4180,7 +4180,7 @@ paths:
patch:
tags:
- 'Relatiegroepen'
- description: Wijzigen van een Relatiegroep
+ summary: Wijzigen van een Relatiegroep
operationId: updateRelatiegroepById
parameters:
- name: 'id'
@@ -4219,7 +4219,7 @@ paths:
get:
tags:
- 'Relatierollen'
- description: Ophalen van Relatierollen
+ summary: Ophalen van Relatierollen
operationId: listRelatierollen
parameters:
- name: params
@@ -4269,7 +4269,7 @@ paths:
post:
tags:
- 'Relatierollen'
- description: Voegt een nieuw(e) Relatierol toe.
+ summary: Voegt een nieuw(e) Relatierol toe.
operationId: createRelatierol
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4309,7 +4309,7 @@ paths:
put:
tags:
- 'Relatierollen'
- description: |
+ summary: |
Vervangen van een Relatierol op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatierol
parameters:
@@ -4344,7 +4344,7 @@ paths:
patch:
tags:
- 'Relatierollen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatierol. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatierol
@@ -4381,7 +4381,7 @@ paths:
get:
tags:
- 'Relatierollen'
- description: Retourneert een Relatierol met de gegeven identifier
+ summary: Retourneert een Relatierol met de gegeven identifier
operationId: readRelatierolById
parameters:
- name: id
@@ -4418,7 +4418,7 @@ paths:
put:
tags:
- 'Relatierollen'
- description: Vervangen van een Relatierol
+ summary: Vervangen van een Relatierol
operationId: replaceRelatierolById
parameters:
- name: 'id'
@@ -4456,7 +4456,7 @@ paths:
patch:
tags:
- 'Relatierollen'
- description: Wijzigen van een Relatierol
+ summary: Wijzigen van een Relatierol
operationId: updateRelatierolById
parameters:
- name: 'id'
@@ -4495,7 +4495,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Ophalen van Signaleringen
+ summary: Ophalen van Signaleringen
operationId: listSignaleringen
parameters:
- name: params
@@ -4545,7 +4545,7 @@ paths:
post:
tags:
- 'Signaleringen'
- description: Voegt een nieuw(e) Signalering toe.
+ summary: Voegt een nieuw(e) Signalering toe.
operationId: createSignalering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4585,7 +4585,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Vervangen van een Signalering op basis van overeenkomstige sleutelvelden.
operationId: replaceSignalering
parameters:
@@ -4620,7 +4620,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Signalering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSignalering
@@ -4657,7 +4657,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Retourneert een Signalering met de gegeven identifier
+ summary: Retourneert een Signalering met de gegeven identifier
operationId: readSignaleringById
parameters:
- name: id
@@ -4694,7 +4694,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: Vervangen van een Signalering
+ summary: Vervangen van een Signalering
operationId: replaceSignaleringById
parameters:
- name: 'id'
@@ -4732,7 +4732,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: Wijzigen van een Signalering
+ summary: Wijzigen van een Signalering
operationId: updateSignaleringById
parameters:
- name: 'id'
@@ -4771,7 +4771,7 @@ paths:
get:
tags:
- 'Telefoonnummers'
- description: Ophalen van Telefoonnummers
+ summary: Ophalen van Telefoonnummers
operationId: listTelefoonnummers
parameters:
- name: params
@@ -4821,7 +4821,7 @@ paths:
post:
tags:
- 'Telefoonnummers'
- description: Voegt een nieuw(e) Telefoonnummer toe.
+ summary: Voegt een nieuw(e) Telefoonnummer toe.
operationId: createTelefoonnummer
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4861,7 +4861,7 @@ paths:
put:
tags:
- 'Telefoonnummers'
- description: |
+ summary: |
Vervangen van een Telefoonnummer op basis van overeenkomstige sleutelvelden.
operationId: replaceTelefoonnummer
parameters:
@@ -4896,7 +4896,7 @@ paths:
patch:
tags:
- 'Telefoonnummers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Telefoonnummer. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateTelefoonnummer
@@ -4933,7 +4933,7 @@ paths:
get:
tags:
- 'Telefoonnummers'
- description: Retourneert een Telefoonnummer met de gegeven identifier
+ summary: Retourneert een Telefoonnummer met de gegeven identifier
operationId: readTelefoonnummerById
parameters:
- name: id
@@ -4970,7 +4970,7 @@ paths:
put:
tags:
- 'Telefoonnummers'
- description: Vervangen van een Telefoonnummer
+ summary: Vervangen van een Telefoonnummer
operationId: replaceTelefoonnummerById
parameters:
- name: 'id'
@@ -5008,7 +5008,7 @@ paths:
patch:
tags:
- 'Telefoonnummers'
- description: Wijzigen van een Telefoonnummer
+ summary: Wijzigen van een Telefoonnummer
operationId: updateTelefoonnummerById
parameters:
- name: 'id'
@@ -5047,7 +5047,7 @@ paths:
get:
tags:
- 'Woonsituaties'
- description: Ophalen van Woonsituaties
+ summary: Ophalen van Woonsituaties
operationId: listWoonsituaties
parameters:
- name: params
@@ -5097,7 +5097,7 @@ paths:
post:
tags:
- 'Woonsituaties'
- description: Voegt een nieuw(e) Woonsituatie toe.
+ summary: Voegt een nieuw(e) Woonsituatie toe.
operationId: createWoonsituatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5137,7 +5137,7 @@ paths:
put:
tags:
- 'Woonsituaties'
- description: |
+ summary: |
Vervangen van een Woonsituatie op basis van overeenkomstige sleutelvelden.
operationId: replaceWoonsituatie
parameters:
@@ -5172,7 +5172,7 @@ paths:
patch:
tags:
- 'Woonsituaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Woonsituatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoonsituatie
@@ -5209,7 +5209,7 @@ paths:
get:
tags:
- 'Woonsituaties'
- description: Retourneert een Woonsituatie met de gegeven identifier
+ summary: Retourneert een Woonsituatie met de gegeven identifier
operationId: readWoonsituatieById
parameters:
- name: id
@@ -5246,7 +5246,7 @@ paths:
put:
tags:
- 'Woonsituaties'
- description: Vervangen van een Woonsituatie
+ summary: Vervangen van een Woonsituatie
operationId: replaceWoonsituatieById
parameters:
- name: 'id'
@@ -5284,7 +5284,7 @@ paths:
patch:
tags:
- 'Woonsituaties'
- description: Wijzigen van een Woonsituatie
+ summary: Wijzigen van een Woonsituatie
operationId: updateWoonsituatieById
parameters:
- name: 'id'
@@ -5356,10 +5356,54 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Relaties.All.Read: alleen lezen van alle resources
+ Relaties.All.ReadWrite: lezen en schrijven van alle resources
+ Relaties.Accounts.Read: alleen lezen van Accounts
+ Relaties.Accounts.ReadWrite: lezen en schrijven van Accounts
+ Relaties.Afspraken.Read: alleen lezen van Afspraken
+ Relaties.Afspraken.ReadWrite: lezen en schrijven van Afspraken
+ Relaties.AfspraakOpties.Read: alleen lezen van AfspraakOpties
+ Relaties.AfspraakOpties.ReadWrite: lezen en schrijven van AfspraakOpties
+ Relaties.Afspraakverzoeken.Read: alleen lezen van Afspraakverzoeken
+ Relaties.Afspraakverzoeken.ReadWrite: lezen en schrijven van Afspraakverzoeken
+ Relaties.Betaalgegevens.Read: alleen lezen van Betaalgegevens
+ Relaties.Betaalgegevens.ReadWrite: lezen en schrijven van Betaalgegevens
+ Relaties.Contactgegevens.Read: alleen lezen van Contactgegevens
+ Relaties.Contactgegevens.ReadWrite: lezen en schrijven van Contactgegevens
+ Relaties.Contactmomenten.Read: alleen lezen van Contactmomenten
+ Relaties.Contactmomenten.ReadWrite: lezen en schrijven van Contactmomenten
+ Relaties.Inkomens.Read: alleen lezen van Inkomens
+ Relaties.Inkomens.ReadWrite: lezen en schrijven van Inkomens
+ Relaties.NatuurlijkPersonen.Read: alleen lezen van NatuurlijkPersonen
+ Relaties.NatuurlijkPersonen.ReadWrite: lezen en schrijven van NatuurlijkPersonen
+ Relaties.Onderhoudsleveranciers.Read: alleen lezen van Onderhoudsleveranciers
+ Relaties.Onderhoudsleveranciers.ReadWrite: lezen en schrijven van Onderhoudsleveranciers
+ Relaties.Opleidingen.Read: alleen lezen van Opleidingen
+ Relaties.Opleidingen.ReadWrite: lezen en schrijven van Opleidingen
+ Relaties.Rechtspersonen.Read: alleen lezen van Rechtspersonen
+ Relaties.Rechtspersonen.ReadWrite: lezen en schrijven van Rechtspersonen
+ Relaties.Relaties.Read: alleen lezen van Relaties
+ Relaties.Relaties.ReadWrite: lezen en schrijven van Relaties
+ Relaties.RelatieAdressen.Read: alleen lezen van RelatieAdressen
+ Relaties.RelatieAdressen.ReadWrite: lezen en schrijven van RelatieAdressen
+ Relaties.Relatiegroepen.Read: alleen lezen van Relatiegroepen
+ Relaties.Relatiegroepen.ReadWrite: lezen en schrijven van Relatiegroepen
+ Relaties.Relatierollen.Read: alleen lezen van Relatierollen
+ Relaties.Relatierollen.ReadWrite: lezen en schrijven van Relatierollen
+ Relaties.Signaleringen.Read: alleen lezen van Signaleringen
+ Relaties.Signaleringen.ReadWrite: lezen en schrijven van Signaleringen
+ Relaties.Telefoonnummers.Read: alleen lezen van Telefoonnummers
+ Relaties.Telefoonnummers.ReadWrite: lezen en schrijven van Telefoonnummers
+ Relaties.Woonsituaties.Read: alleen lezen van Woonsituaties
+ Relaties.Woonsituaties.ReadWrite: lezen en schrijven van Woonsituaties
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Relaties.All.Read: alleen lezen van alle resources
Relaties.All.ReadWrite: lezen en schrijven van alle resources
@@ -5450,7 +5494,7 @@ components:
description: De gebruikersnaam van de registratie.
relatie:
allOf:
- - $ref: '#/components/schemas/Relatie'
+ - $ref: '#/components/schemas/Relatie-sleutels'
description: De relatie behorend bij de registratie.
wachtwoorddatum:
type: string
@@ -5482,7 +5526,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -5494,7 +5538,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -5530,7 +5574,7 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Relatie-basis:
+ Relatie-sleutels:
type: object
properties:
id:
@@ -5557,137 +5601,6 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de relatie, bijv. In het geval van een VVE kan deze de status slapend of actief hebben. Referentiedatasoort RELATIESTATUS.
- adressen:
- description: De adressen behorend bij de relatie.
- type: array
- items:
- $ref: '#/components/schemas/RelatieAdres'
- afspraken:
- description: De afspraken behorend bij de relatie.
- type: array
- items:
- $ref: '#/components/schemas/Afspraak'
- betaalgegevens:
- description: De betaalgegevens behorend bij de relatie. Bijvoorbeeld het rekeningnummer.
- type: array
- items:
- $ref: '#/components/schemas/Betaalgegeven'
- communicatievoorkeur:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het communicatiekanaal waarop de relatie bij voorkeur benaderd wil worden. Bijvoorbeeld: Telefoon, E-mail, Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
- contactgegevens:
- description: De contactgegevens van de relatie.
- type: array
- items:
- $ref: '#/components/schemas/Contactgegeven'
- contactmomenten:
- description: De contactmomenten behorend bij de relatie.
- type: array
- items:
- $ref: '#/components/schemas/Contactmoment'
- groepen:
- description: De relatiegroepen waar de relatie toe behoort.
- type: array
- items:
- $ref: '#/components/schemas/Relatiegroep'
- inspecties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Inspectie in informatiedomein Overeenkomsten
- onderhoudsverzoeken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Onderhoudsverzoek in informatiedomein Onderhoud
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- rollen:
- description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
- type: array
- items:
- $ref: '#/components/schemas/Relatierol'
- RelatieAdresbericht:
- allOf:
- - $ref: '#/components/schemas/RelatieAdres'
- - $ref: '#/components/schemas/Bericht-basis'
- RelatieAdres:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort adres van de relatie. Bijvoorbeeld: Woonadres, postadres, bezoekadres en factuuradres. Referentiedatasoort RELATIEADRESSOORT.'
- begindatum:
- type: string
- format: date
- description: De begindatum waarop de relatie bij het adres hoort.
- einddatum:
- type: string
- format: date
- description: De einddatum waarop de relatie niet meer bij het adres hoort.
- adres:
- type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie behorend bij het adres.
- Relatie-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -5712,15 +5625,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Relatiebericht:
- allOf:
- - $ref: '#/components/schemas/Relatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Relatie:
- oneOf:
- - $ref: '#/components/schemas/NatuurlijkPersoon'
- - $ref: '#/components/schemas/Rechtspersoon'
- - $ref: '#/components/schemas/Relatiegroep'
Afspraakbericht:
allOf:
- $ref: '#/components/schemas/Afspraak'
@@ -5774,18 +5678,18 @@ components:
description: Tekstveld waarin contactgegevens van een alternatieve contactpersoon opgenomen kunnen worden. Voorbeeld is het verzoek van een huurder (student) waarbij hij aangeeft contact op te nemen met zijn ouders voor de afhandeling van het verzoek.
contactgegeven:
allOf:
- - $ref: '#/components/schemas/Contactgegeven'
+ - $ref: '#/components/schemas/Contactgegeven-sleutels'
description: Het contactgegeven van de relatie welke van toepassing is voor de afspraak.
locatie:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
relaties:
description: De relatie waarmee de afspraak is gemaakt. Bijv. de huurder, medewerker etc.
type: array
items:
$ref: '#/components/schemas/Relatie-sleutels'
- Contactgegeven-basis:
+ Contactgegeven-sleutels:
type: object
properties:
id:
@@ -5808,43 +5712,15 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
- omschrijving:
- type: string
- format: any
- description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie behorend bij het contactgegeven.
- relatierol:
- allOf:
- - $ref: '#/components/schemas/Relatierol'
- description: De relatie rol van de relatie behorend bij het contactgegeven.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
- voorkeur:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
- waarde:
- type: string
- format: any
- description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
- Relatierolbericht:
+ AfspraakOptiebericht:
allOf:
- - $ref: '#/components/schemas/Relatierol'
+ - $ref: '#/components/schemas/AfspraakOptie'
- $ref: '#/components/schemas/Bericht-basis'
- Relatierol:
+ AfspraakOptie:
type: object
properties:
id:
@@ -5863,50 +5739,59 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort rol van de relatie. Bijvoorbeeld Klant, Prospect, Leverancier, Medewerker, Team etc. Referentiedatasoort RELATIEROLSOORT.
- naam:
- type: string
- format: any
- description: De naam van de relatie rol.
- omschrijving:
+ begindatum:
type: string
- format: any
- description: De omschrijving van de relatie rol.
- begindatum:
- type: string
- format: date
- description: begindatum van de rol
+ format: date-time
+ description: De datum en tijd waarop de afspraak plaatsvindt.
einddatum:
type: string
- format: date
- description: einddatum van de rol
- contactgegevens:
- description: De contactgegevens van een relatie in een bepaalde rol.
- type: array
- items:
- $ref: '#/components/schemas/Contactgegeven-sleutels'
- contactmomenten:
- description: De contactmomenten die de relatie vanuit een rol heeft.
- type: array
- items:
- $ref: '#/components/schemas/Contactmoment'
- relatie:
+ format: date-time
+ description: De datum en tijd tot wanneer de afspraak loopt.
+ bloktijdBegin:
+ type: string
+ format: date-time
+ description: De datum en tijd die het begin van een blok markeert waarbinnen de afspraak bij voorkeur start. Pas als de afspraak daadwerkelijk ingepland is, is er ook een afspraak begindatum bekend.
+ bloktijdEind:
+ type: string
+ format: date-time
+ description: De datum en tijd die het eind van een blok markeert waarbinnen de afspraak bij voorkeur start.
+ afspraak:
allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie waarvoor de rol van toepassing is.
- relatieAdressen:
- description: De adresssen van de relatie die voor de rol van toepassing zijn
+ - $ref: '#/components/schemas/Afspraak-sleutels'
+ duur:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: De verwachte duur van de afspraak die gemaakt moet worden.
+ locatie:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ onderhoudsorder:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudsorder-sleutels in informatiedomein Onderhoud
+ onderhoudstaak:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudstaak-sleutels in informatiedomein Onderhoud
+ onderhoudsverzoek:
+ type: string
+ format: uri
+ description: Referentie naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ planningscore:
+ type: number
+ format: float
+ relaties:
+ description: De relaties waarvoor de afspraak optie van toepassing is.
type: array
items:
- $ref: '#/components/schemas/RelatieAdres'
- rolRelatie:
+ $ref: '#/components/schemas/Relatie-sleutels'
+ specialisme:
allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
- description: De relatie die aangeeft waar de relatie en rol koppeling van toepassing is. Dit attribuut geeft aan dat de aangegeven relatie de rol binnen bijvoorbeeld een relatiegroep heeft. Het attribuut relatie is dan bijvoorbeeld een persoon uit een huishouden en de rolRelatie is dan bijvoorbeeld de relatiegroep die het huishouden voorstelt.
- Contactgegeven-sleutels:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Referentiedatasoort ONDERHOUDSPECIALISME.
+ Afspraak-sleutels:
type: object
properties:
id:
@@ -5925,27 +5810,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc.
- Contactgegevenbericht:
- allOf:
- - $ref: '#/components/schemas/Contactgegeven'
- - $ref: '#/components/schemas/Bericht-basis'
- Contactgegeven:
- oneOf:
- - $ref: '#/components/schemas/Telefoonnummer'
- - $ref: '#/components/schemas/Contactgegeven-basis'
- Contactmomentbericht:
+ Afspraakverzoekbericht:
allOf:
- - $ref: '#/components/schemas/Contactmoment'
+ - $ref: '#/components/schemas/Afspraakverzoek'
- $ref: '#/components/schemas/Bericht-basis'
- Contactmoment:
+ Afspraakverzoek:
type: object
properties:
id:
@@ -5963,44 +5832,58 @@ components:
code:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
- type: string
- format: any
- description: De omschrijving van het contactmoment
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort detail van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTDETAILSOORT.
- datum:
+ description: 'Soort van de afspraak: bijvoorbeeld voorinspectie. Referentiedatasoort AFSPRAAKVERZOEKSOORT.'
+ duur:
type: string
- format: date-time
- description: De datum en tijd waarop contact is geweest.
- dossier:
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: Duur van de afspraak.
+ termijn:
+ type: string
+ format: duration
+ pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
+ description: Termijn waarbinnende afspraak moet plaatsvinden.
+ adres:
type: string
format: uri
- description: Referentie naar Dossier in informatiedomein Dossier
- kanaal:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het kanaal via welke het contact heeft gelopen. Bijvoorbeeld: Telefoon, email, balie, internet. Referentiedatasoort COMMUNICATIEKANAAL.'
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ opties:
+ description: De mogelijke momenten waarop de afspraak kan worden gemaakt.
+ type: array
+ items:
+ $ref: '#/components/schemas/AfspraakOptie-sleutels'
relaties:
- description: De relatie waarmee contact is geweest. Bijv. een huurder, medewerker etc.
+ description: De betrokken relaties voor de te maken afspraak. Bijv. de huurder, medewerker etc.
type: array
items:
$ref: '#/components/schemas/Relatie-sleutels'
- richting:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De communicatierichting behorend bij het contact. Bijvoorbeeld: Uitgaand of ingaand. Referentiedatasoort COMMUNICATIERICHTING.'
- zaak:
+ volgorde:
+ type: integer
+ format: int32
+ description: De volgorde waarin de specifieke afspraak dient te worden uitgevoerd ten opzichte van andere afspraakverzoeken.
+ AfspraakOptie-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: uri
- description: Referentie naar Zaak in informatiedomein Dossier
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Betaalgegevenbericht:
allOf:
- $ref: '#/components/schemas/Betaalgegeven'
@@ -6049,7 +5932,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Incassomachtiging in informatiedomein Financien
+ description: Referenties naar Incassomachtiging-sleutels in informatiedomein Financien
incassowijze:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -6058,7 +5941,7 @@ components:
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
primair:
type: boolean
description: De aanduiding dat het betaalgegeven het primaire betaalgegeven betreft.
@@ -6073,33 +5956,79 @@ components:
rekeningPlaats:
type: string
format: uri
- description: Referentie naar Woonplaats in informatiedomein Vastgoed
+ description: Referentie naar Woonplaats-sleutels in informatiedomein Vastgoed
relatie:
allOf:
- $ref: '#/components/schemas/Relatie-sleutels'
description: De relatie behorend bij het betaalgegeven.
- Relatiegroepbericht:
+ Contactgegeven-basis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
+ omschrijving:
+ type: string
+ format: any
+ description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij het contactgegeven.
+ relatierol:
+ allOf:
+ - $ref: '#/components/schemas/Relatierol-sleutels'
+ description: De relatie rol van de relatie behorend bij het contactgegeven.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
+ voorkeur:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
+ waarde:
+ type: string
+ format: any
+ description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
+ Contactgegevenbericht:
allOf:
- - $ref: '#/components/schemas/Relatiegroep'
+ - $ref: '#/components/schemas/Contactgegeven'
- $ref: '#/components/schemas/Bericht-basis'
- Relatiegroep:
- allOf:
- - $ref: '#/components/schemas/Relatie-basis'
- - type: object
- properties:
- naam:
- type: string
- format: any
- description: De naam van de relatiegroep.
- relaties:
- type: array
- items:
- $ref: '#/components/schemas/Relatie-sleutels'
- AfspraakOptiebericht:
+ Contactgegeven:
+ oneOf:
+ - $ref: '#/components/schemas/Telefoonnummer'
+ - $ref: '#/components/schemas/Contactgegeven-basis'
+ Contactmomentbericht:
allOf:
- - $ref: '#/components/schemas/AfspraakOptie'
+ - $ref: '#/components/schemas/Contactmoment'
- $ref: '#/components/schemas/Bericht-basis'
- AfspraakOptie:
+ Contactmoment:
type: object
properties:
id:
@@ -6118,113 +6047,43 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date-time
- description: De datum en tijd waarop de afspraak plaatsvindt.
- einddatum:
+ omschrijving:
type: string
- format: date-time
- description: De datum en tijd tot wanneer de afspraak loopt.
- bloktijdBegin:
+ format: any
+ description: De omschrijving van het contactmoment
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort detail van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTDETAILSOORT.
+ datum:
type: string
format: date-time
- description: De datum en tijd die het begin van een blok markeert waarbinnen de afspraak bij voorkeur start. Pas als de afspraak daadwerkelijk ingepland is, is er ook een afspraak begindatum bekend.
- bloktijdEind:
- type: string
- format: date-time
- description: De datum en tijd die het eind van een blok markeert waarbinnen de afspraak bij voorkeur start.
- afspraak:
- allOf:
- - $ref: '#/components/schemas/Afspraak'
- duur:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: De verwachte duur van de afspraak die gemaakt moet worden.
- locatie:
- type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- onderhoudsorder:
- type: string
- format: uri
- description: Referentie naar Onderhoudsorder in informatiedomein Onderhoud
- onderhoudstaak:
- type: string
- format: uri
- description: Referentie naar Onderhoudstaak in informatiedomein Onderhoud
- onderhoudsverzoek:
+ description: De datum en tijd waarop contact is geweest.
+ dossier:
type: string
format: uri
- description: Referentie naar Onderhoudsverzoek in informatiedomein Onderhoud
- planningscore:
- type: number
- format: float
+ description: Referentie naar Dossier-sleutels in informatiedomein Dossier
+ kanaal:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het kanaal via welke het contact heeft gelopen. Bijvoorbeeld: Telefoon, email, balie, internet. Referentiedatasoort COMMUNICATIEKANAAL.'
relaties:
- description: De relaties waarvoor de afspraak optie van toepassing is.
+ description: De relatie waarmee contact is geweest. Bijv. een huurder, medewerker etc.
type: array
items:
- $ref: '#/components/schemas/Relatie'
- specialisme:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Referentiedatasoort ONDERHOUDSPECIALISME.
- Afspraakverzoekbericht:
- allOf:
- - $ref: '#/components/schemas/Afspraakverzoek'
- - $ref: '#/components/schemas/Bericht-basis'
- Afspraakverzoek:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken).
- soort:
+ $ref: '#/components/schemas/Relatie-sleutels'
+ richting:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Soort van de afspraak: bijvoorbeeld voorinspectie. Referentiedatasoort AFSPRAAKVERZOEKSOORT.'
- duur:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: Duur van de afspraak.
- termijn:
- type: string
- format: duration
- pattern: '^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$'
- description: Termijn waarbinnende afspraak moet plaatsvinden.
- adres:
+ description: 'De communicatierichting behorend bij het contact. Bijvoorbeeld: Uitgaand of ingaand. Referentiedatasoort COMMUNICATIERICHTING.'
+ zaak:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- opties:
- description: De mogelijke momenten waarop de afspraak kan worden gemaakt.
- type: array
- items:
- $ref: '#/components/schemas/AfspraakOptie'
- relaties:
- description: De betrokken relaties voor de te maken afspraak. Bijv. de huurder, medewerker etc.
- type: array
- items:
- $ref: '#/components/schemas/Relatie'
- volgorde:
- type: integer
- format: int32
- description: De volgorde waarin de specifieke afspraak dient te worden uitgevoerd ten opzichte van andere afspraakverzoeken.
+ description: Referentie naar Zaak-sleutels in informatiedomein Dossier
Inkomenbericht:
allOf:
- $ref: '#/components/schemas/Inkomen'
@@ -6248,10 +6107,22 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort inkomen. Bijv. netto of bruto maand of jaarinkomen. Referentiedatasoort INKOMENSSOORT.
controledatum:
type: string
format: date-time
description: De datum en tijd waarop de inkomensgegevens zijn gecontroleerd.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
+ bedrag:
+ type: number
+ format: float
+ description: Het bedrag van het inkomen.
bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -6259,28 +6130,36 @@ components:
brutoJaarinkomen:
type: number
format: float
- description: Het bruto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
brutoMaandinkomen:
type: number
format: float
- description: Het bruto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
inkomensverklaringsoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het soort inkomensverklaring waaruit het inkomen is overgenomen. Bijv. Jaaropgave, Inkomensverklaring belastingdienst etc. Referentiedatasoort INKOMENSVERKLARINGSOORT.
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor het inkomen geldig is.
nettoJaarinkomen:
type: number
format: float
- description: Het netto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het netto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
nettoMaandinkomen:
type: number
format: float
- description: Het netto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het netto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
relaties:
- description: sleutels
+ description: De relaties behorend bij het inkomen. Bijv. de woningzoekende, huurder, controleur etc.
type: array
items:
- $ref: '#/components/schemas/Relatie'
+ $ref: '#/components/schemas/Relatie-sleutels'
NatuurlijkPersoonbericht:
allOf:
- $ref: '#/components/schemas/NatuurlijkPersoon'
@@ -6307,7 +6186,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Aanbieding in informatiedomein Woonruimteverdeling
+ description: Referenties naar Aanbieding-sleutels in informatiedomein Woonruimteverdeling
aanhef:
type: string
format: any
@@ -6336,33 +6215,33 @@ components:
description: De inkomens van de natuurlijk persoon.
type: array
items:
- $ref: '#/components/schemas/Inkomen'
+ $ref: '#/components/schemas/Inkomen-sleutels'
nationaliteit:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: De nationaliteit van de natuurlijk persoon. Referentiedatasoort NATIONALITEIT.
opleiding:
allOf:
- - $ref: '#/components/schemas/Opleiding'
+ - $ref: '#/components/schemas/Opleiding-sleutels'
description: Het opleidingsgegeven van de natuurlijk persoon. OBSOLETE
deprecated: true
opleidingen:
description: De opleidingsgegevens van de natuurlijk persoon.
type: array
items:
- $ref: '#/components/schemas/Opleiding'
+ $ref: '#/components/schemas/Opleiding-sleutels'
reacties:
type: array
items:
type: string
format: uri
- description: Referenties naar Reactie in informatiedomein Woonruimteverdeling
+ description: Referenties naar Reactie-sleutels in informatiedomein Woonruimteverdeling
regelingen:
type: array
items:
type: string
format: uri
- description: Referenties naar Regeling in informatiedomein Woonruimteverdeling
+ description: Referenties naar Regeling-sleutels in informatiedomein Woonruimteverdeling
roepnaam:
type: string
format: any
@@ -6371,13 +6250,13 @@ components:
description: De signaleringen behorend bij de natuurlijk persoon.
type: array
items:
- $ref: '#/components/schemas/Signalering'
+ $ref: '#/components/schemas/Signalering-sleutels'
toewijzingen:
type: array
items:
type: string
format: uri
- description: Referenties naar Toewijzing in informatiedomein Woonruimteverdeling
+ description: Referenties naar Toewijzing-sleutels in informatiedomein Woonruimteverdeling
tussenvoegsels:
type: string
format: any
@@ -6399,16 +6278,12 @@ components:
items:
type: string
format: uri
- description: Referenties naar Voorrangsregeling in informatiedomein Woonruimteverdeling
+ description: Referenties naar Voorrangsregeling-sleutels in informatiedomein Woonruimteverdeling
woonsituatie:
allOf:
- - $ref: '#/components/schemas/Woonsituatie'
+ - $ref: '#/components/schemas/Woonsituatie-sleutels'
description: De huidige woonsituatie van de woningzoekende. Bevat of iemand starter of doorstromer is en informatie over de huidige huurovereenkomst en woning.
- Opleidingbericht:
- allOf:
- - $ref: '#/components/schemas/Opleiding'
- - $ref: '#/components/schemas/Bericht-basis'
- Opleiding:
+ Inkomen-sleutels:
type: object
properties:
id:
@@ -6427,39 +6302,30 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- studentnummer:
+ Opleiding-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: Het studentnummer van de relatie
- begindatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De begindatum waarop de studie is begonnen.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: date
- description: De einddatum waarop de studie is beëindigd.
- instelling:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De opleidingsinstelling die aangeeft waar de relatie de studie volgt. We hanteren hiervoor de BRIN. Referentiedatasoort OPLEIDINGSINSTELLING.
- niveau:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het hoogst genoten opleidingsniveau van de relatie. Bijvoorbeeld: HBO of Universitair. Referentiedatasoort OPLEIDINGSNIVEAU.'
- plaats:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
format: any
- description: De plaats waar de relatie de studie volgt.
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie'
- description: De relatie die de opleiding volgt.
- Signaleringbericht:
- allOf:
- - $ref: '#/components/schemas/Signalering'
- - $ref: '#/components/schemas/Bericht-basis'
- Signalering:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ studentnummer:
+ type: string
+ format: any
+ description: Het studentnummer van de relatie
+ Signalering-sleutels:
type: object
properties:
id:
@@ -6478,43 +6344,44 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort signaal. Bijvoorbeeld: Huurschuld, overlast of wietplantage. Referentiedatasoort SIGNALERINGSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het reden van het signaal. Referentiedatasoort SIGNALERINGDETAILSOORT.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De status van de signalering. Bijvoorbeeld: Actief, vervallen of passief. Referentiedatasoort SIGNALERINGSTATUS.'
- detailStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De detailstatus van de signalering. Bijvoorbeeld: Ontruiming, vertrokken. Referentiedatasoort SIGNALERINGDETAILSTATUS.'
- begindatum:
+ Woonsituatie-sleutels:
+ type: object
+ properties:
+ id:
type: string
- format: date-time
- description: De begindatum van de signalering.
- einddatum:
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date-time
- description: De einddatum van de signalering.
- adres:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- relatie:
- allOf:
- - $ref: '#/components/schemas/Relatie'
- description: De relatie behorend bij de signalering.
- Woonsituatiebericht:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Onderhoudsleverancierbericht:
allOf:
- - $ref: '#/components/schemas/Woonsituatie'
+ - $ref: '#/components/schemas/Onderhoudsleverancier'
- $ref: '#/components/schemas/Bericht-basis'
- Woonsituatie:
+ Onderhoudsleverancier:
+ allOf:
+ - $ref: '#/components/schemas/Rechtspersoon-basis'
+ - type: object
+ properties:
+ specialismen:
+ description: Het specialismen die de opdrachtnemer kan uitvoeren. Voorbeelden zijn Timmerman, Loodgieter, etc. Referentiedatasoort ONDERHOUDSPECIALISME.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ Opleidingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Opleiding'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Opleiding:
type: object
properties:
id:
@@ -6533,48 +6400,38 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort woonsituatie: Starter, Doorstromer. Referentiedatasoort WOONSITUATIESOORT.'
+ studentnummer:
+ type: string
+ format: any
+ description: Het studentnummer van de relatie
begindatum:
type: string
format: date
- description: De begindatum waarop de woonsituatie is begonnen. Bijvoorbeeld de ingangsdatum van het huidige huur- of koopcontract of de inschrijfdatum op het adres bij het BRP.
+ description: De begindatum waarop de studie is begonnen.
einddatum:
type: string
format: date
- description: De einddatum waarop de woonsituatie is beëindigd.
- eenheid:
- type: string
- format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
- overeenkomst:
+ description: De einddatum waarop de studie is beëindigd.
+ authentiekGegeven:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- relatie:
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
+ instelling:
allOf:
- - $ref: '#/components/schemas/Relatie'
- description: De hoofdaanvrager waartoe de woonsituatie behoort.
- vestiging:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De opleidingsinstelling die aangeeft waar de relatie de studie volgt. We hanteren hiervoor de BRIN. Referentiedatasoort OPLEIDINGSINSTELLING.
+ niveau:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De vestiging die de huidige woning exploiteerd. Referentiedatasoort VESTIGING.
- Onderhoudsleverancierbericht:
- allOf:
- - $ref: '#/components/schemas/Onderhoudsleverancier'
- - $ref: '#/components/schemas/Bericht-basis'
- Onderhoudsleverancier:
- allOf:
- - $ref: '#/components/schemas/Rechtspersoon-basis'
- - type: object
- properties:
- specialismen:
- description: Het specialismen die de opdrachtnemer kan uitvoeren. Voorbeelden zijn Timmerman, Loodgieter, etc. Referentiedatasoort ONDERHOUDSPECIALISME.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
+ description: 'Het hoogst genoten opleidingsniveau van de relatie. Bijvoorbeeld: HBO of Universitair. Referentiedatasoort OPLEIDINGSNIVEAU.'
+ plaats:
+ type: string
+ format: any
+ description: De plaats waar de relatie de studie volgt.
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie die de opleiding volgt.
Rechtspersoon-basis:
allOf:
- $ref: '#/components/schemas/Relatie-basis'
@@ -6604,7 +6461,7 @@ components:
description: De contactpersonen behorend bij de rechtspersoon.
type: array
items:
- $ref: '#/components/schemas/Relatie'
+ $ref: '#/components/schemas/Relatie-sleutels'
Rechtspersoonbericht:
allOf:
- $ref: '#/components/schemas/Rechtspersoon'
@@ -6613,10 +6470,393 @@ components:
allOf:
- $ref: '#/components/schemas/Rechtspersoon-basis'
- type: object
- Telefoonnummerbericht:
- allOf:
- - $ref: '#/components/schemas/Telefoonnummer'
- - $ref: '#/components/schemas/Bericht-basis'
+ Relatie-basis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de relatie, bijv. In het geval van een VVE kan deze de status slapend of actief hebben. Referentiedatasoort RELATIESTATUS.
+ adressen:
+ description: De adressen behorend bij de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/RelatieAdres-sleutels'
+ afspraken:
+ description: De afspraken behorend bij de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Afspraak-sleutels'
+ betaalgegevens:
+ description: De betaalgegevens behorend bij de relatie. Bijvoorbeeld het rekeningnummer.
+ type: array
+ items:
+ $ref: '#/components/schemas/Betaalgegeven-sleutels'
+ communicatievoorkeur:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het communicatiekanaal waarop de relatie bij voorkeur benaderd wil worden. Bijvoorbeeld: Telefoon, E-mail, Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
+ contactgegevens:
+ description: De contactgegevens van de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactgegeven-sleutels'
+ contactmomenten:
+ description: De contactmomenten behorend bij de relatie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactmoment-sleutels'
+ groepen:
+ description: De relatiegroepen waar de relatie toe behoort.
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatiegroep-sleutels'
+ inspecties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Inspectie-sleutels in informatiedomein Overeenkomsten
+ onderhoudsverzoeken:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Onderhoudsverzoek-sleutels in informatiedomein Onderhoud
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ RelatieAdres-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort adres van de relatie. Bijvoorbeeld: Woonadres, postadres, bezoekadres en factuuradres. Referentiedatasoort RELATIEADRESSOORT.'
+ Betaalgegeven-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ iban:
+ type: string
+ format: any
+ description: Het International Bank Account Number. Identificeert elke rekeninghouder, inclusief bank en vestigingsland.
+ rekeningnummer:
+ type: string
+ format: any
+ description: Het rekeningnummer.
+ Contactmoment-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
+ Relatiegroep-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ Relatiebericht:
+ allOf:
+ - $ref: '#/components/schemas/Relatie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Relatie:
+ oneOf:
+ - $ref: '#/components/schemas/NatuurlijkPersoon'
+ - $ref: '#/components/schemas/Rechtspersoon'
+ - $ref: '#/components/schemas/Relatiegroep'
+ RelatieAdresbericht:
+ allOf:
+ - $ref: '#/components/schemas/RelatieAdres'
+ - $ref: '#/components/schemas/Bericht-basis'
+ RelatieAdres:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort adres van de relatie. Bijvoorbeeld: Woonadres, postadres, bezoekadres en factuuradres. Referentiedatasoort RELATIEADRESSOORT.'
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum waarop de relatie bij het adres hoort.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum waarop de relatie niet meer bij het adres hoort.
+ adres:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij het adres.
+ Relatiegroepbericht:
+ allOf:
+ - $ref: '#/components/schemas/Relatiegroep'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Relatiegroep:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-basis'
+ - type: object
+ properties:
+ naam:
+ type: string
+ format: any
+ description: De naam van de relatiegroep.
+ relaties:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatie-sleutels'
+ Relatierolbericht:
+ allOf:
+ - $ref: '#/components/schemas/Relatierol'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Relatierol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort rol van de relatie. Bijvoorbeeld Klant, Prospect, Leverancier, Medewerker, Team etc. Referentiedatasoort RELATIEROLSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van de relatie rol.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de relatie rol.
+ begindatum:
+ type: string
+ format: date
+ description: begindatum van de rol
+ einddatum:
+ type: string
+ format: date
+ description: einddatum van de rol
+ contactgegevens:
+ description: De contactgegevens van een relatie in een bepaalde rol.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactgegeven-sleutels'
+ contactmomenten:
+ description: De contactmomenten die de relatie vanuit een rol heeft.
+ type: array
+ items:
+ $ref: '#/components/schemas/Contactmoment-sleutels'
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie waarvoor de rol van toepassing is.
+ relatieAdressen:
+ description: De adresssen van de relatie die voor de rol van toepassing zijn
+ type: array
+ items:
+ $ref: '#/components/schemas/RelatieAdres-sleutels'
+ rolRelatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie die aangeeft waar de relatie en rol koppeling van toepassing is. Dit attribuut geeft aan dat de aangegeven relatie de rol binnen bijvoorbeeld een relatiegroep heeft. Het attribuut relatie is dan bijvoorbeeld een persoon uit een huishouden en de rolRelatie is dan bijvoorbeeld de relatiegroep die het huishouden voorstelt.
+ Signaleringbericht:
+ allOf:
+ - $ref: '#/components/schemas/Signalering'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Signalering:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort signaal. Bijvoorbeeld: Huurschuld, overlast of wietplantage. Referentiedatasoort SIGNALERINGSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het reden van het signaal. Referentiedatasoort SIGNALERINGDETAILSOORT.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De status van de signalering. Bijvoorbeeld: Actief, vervallen of passief. Referentiedatasoort SIGNALERINGSTATUS.'
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De detailstatus van de signalering. Bijvoorbeeld: Ontruiming, vertrokken. Referentiedatasoort SIGNALERINGDETAILSTATUS.'
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum van de signalering.
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum van de signalering.
+ adres:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij de signalering.
+ Telefoonnummerbericht:
+ allOf:
+ - $ref: '#/components/schemas/Telefoonnummer'
+ - $ref: '#/components/schemas/Bericht-basis'
Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Contactgegeven-basis'
@@ -6643,6 +6883,61 @@ components:
type: string
format: any
description: Het netnummer van het telefoonnummer.
+ Woonsituatiebericht:
+ allOf:
+ - $ref: '#/components/schemas/Woonsituatie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Woonsituatie:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort woonsituatie: Starter, Doorstromer. Referentiedatasoort WOONSITUATIESOORT.'
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum waarop de woonsituatie is begonnen. Bijvoorbeeld de ingangsdatum van het huidige huur- of koopcontract of de inschrijfdatum op het adres bij het BRP.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum waarop de woonsituatie is beëindigd.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
+ eenheid:
+ type: string
+ format: uri
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De hoofdaanvrager waartoe de woonsituatie behoort.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging die de huidige woning exploiteerd. Referentiedatasoort VESTIGING.
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Vastgoed.yaml b/docs/Informatiedomeinen/Vastgoed.yaml
index bf5d744..f4f755d 100644
--- a/docs/Informatiedomeinen/Vastgoed.yaml
+++ b/docs/Informatiedomeinen/Vastgoed.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://vastgoed.vera.io:{port}/{basePath}
description: Productieserver
@@ -109,7 +109,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -125,7 +125,7 @@ paths:
get:
tags:
- 'Adressen'
- description: Ophalen van Adressen
+ summary: Ophalen van Adressen
operationId: listAdressen
parameters:
- name: params
@@ -175,7 +175,7 @@ paths:
post:
tags:
- 'Adressen'
- description: Voegt een nieuw(e) Adres toe.
+ summary: Voegt een nieuw(e) Adres toe.
operationId: createAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -215,7 +215,7 @@ paths:
put:
tags:
- 'Adressen'
- description: |
+ summary: |
Vervangen van een Adres op basis van overeenkomstige sleutelvelden.
operationId: replaceAdres
parameters:
@@ -250,7 +250,7 @@ paths:
patch:
tags:
- 'Adressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Adres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAdres
@@ -287,7 +287,7 @@ paths:
get:
tags:
- 'Adressen'
- description: Retourneert een Adres met de gegeven identifier
+ summary: Retourneert een Adres met de gegeven identifier
operationId: readAdresById
parameters:
- name: id
@@ -324,7 +324,7 @@ paths:
put:
tags:
- 'Adressen'
- description: Vervangen van een Adres
+ summary: Vervangen van een Adres
operationId: replaceAdresById
parameters:
- name: 'id'
@@ -362,7 +362,7 @@ paths:
patch:
tags:
- 'Adressen'
- description: Wijzigen van een Adres
+ summary: Wijzigen van een Adres
operationId: updateAdresById
parameters:
- name: 'id'
@@ -401,7 +401,7 @@ paths:
get:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Ophalen van AdresseerbareObjectenBasisregistratie
+ summary: Ophalen van AdresseerbareObjectenBasisregistratie
operationId: listAdresseerbareObjectenBasisregistratie
parameters:
- name: params
@@ -451,7 +451,7 @@ paths:
post:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Voegt een nieuw(e) AdresseerbaarObjectBasisregistratie toe.
+ summary: Voegt een nieuw(e) AdresseerbaarObjectBasisregistratie toe.
operationId: createAdresseerbaarObjectBasisregistratie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -491,7 +491,7 @@ paths:
put:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: |
+ summary: |
Vervangen van een AdresseerbaarObjectBasisregistratie op basis van overeenkomstige sleutelvelden.
operationId: replaceAdresseerbaarObjectBasisregistratie
parameters:
@@ -526,7 +526,7 @@ paths:
patch:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een AdresseerbaarObjectBasisregistratie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAdresseerbaarObjectBasisregistratie
@@ -563,7 +563,7 @@ paths:
get:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Retourneert een AdresseerbaarObjectBasisregistratie met de gegeven identifier
+ summary: Retourneert een AdresseerbaarObjectBasisregistratie met de gegeven identifier
operationId: readAdresseerbaarObjectBasisregistratieById
parameters:
- name: id
@@ -600,7 +600,7 @@ paths:
put:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Vervangen van een AdresseerbaarObjectBasisregistratie
+ summary: Vervangen van een AdresseerbaarObjectBasisregistratie
operationId: replaceAdresseerbaarObjectBasisregistratieById
parameters:
- name: 'id'
@@ -638,7 +638,7 @@ paths:
patch:
tags:
- 'AdresseerbareObjectenBasisregistratie'
- description: Wijzigen van een AdresseerbaarObjectBasisregistratie
+ summary: Wijzigen van een AdresseerbaarObjectBasisregistratie
operationId: updateAdresseerbaarObjectBasisregistratieById
parameters:
- name: 'id'
@@ -677,7 +677,7 @@ paths:
get:
tags:
- 'BagAdressen'
- description: Ophalen van BagAdressen
+ summary: Ophalen van BagAdressen
operationId: listBagAdressen
parameters:
- name: params
@@ -727,7 +727,7 @@ paths:
post:
tags:
- 'BagAdressen'
- description: Voegt een nieuw(e) BagAdres toe.
+ summary: Voegt een nieuw(e) BagAdres toe.
operationId: createBagAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -767,7 +767,7 @@ paths:
put:
tags:
- 'BagAdressen'
- description: |
+ summary: |
Vervangen van een BagAdres op basis van overeenkomstige sleutelvelden.
operationId: replaceBagAdres
parameters:
@@ -802,7 +802,7 @@ paths:
patch:
tags:
- 'BagAdressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BagAdres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBagAdres
@@ -839,7 +839,7 @@ paths:
get:
tags:
- 'BagAdressen'
- description: Retourneert een BagAdres met de gegeven identifier
+ summary: Retourneert een BagAdres met de gegeven identifier
operationId: readBagAdresById
parameters:
- name: id
@@ -876,7 +876,7 @@ paths:
put:
tags:
- 'BagAdressen'
- description: Vervangen van een BagAdres
+ summary: Vervangen van een BagAdres
operationId: replaceBagAdresById
parameters:
- name: 'id'
@@ -914,7 +914,7 @@ paths:
patch:
tags:
- 'BagAdressen'
- description: Wijzigen van een BagAdres
+ summary: Wijzigen van een BagAdres
operationId: updateBagAdresById
parameters:
- name: 'id'
@@ -953,7 +953,7 @@ paths:
get:
tags:
- 'BagPanden'
- description: Ophalen van BagPanden
+ summary: Ophalen van BagPanden
operationId: listBagPanden
parameters:
- name: params
@@ -1003,7 +1003,7 @@ paths:
post:
tags:
- 'BagPanden'
- description: Voegt een nieuw(e) BagPand toe.
+ summary: Voegt een nieuw(e) BagPand toe.
operationId: createBagPand
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1043,7 +1043,7 @@ paths:
put:
tags:
- 'BagPanden'
- description: |
+ summary: |
Vervangen van een BagPand op basis van overeenkomstige sleutelvelden.
operationId: replaceBagPand
parameters:
@@ -1078,7 +1078,7 @@ paths:
patch:
tags:
- 'BagPanden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BagPand. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBagPand
@@ -1115,7 +1115,7 @@ paths:
get:
tags:
- 'BagPanden'
- description: Retourneert een BagPand met de gegeven identifier
+ summary: Retourneert een BagPand met de gegeven identifier
operationId: readBagPandById
parameters:
- name: id
@@ -1152,7 +1152,7 @@ paths:
put:
tags:
- 'BagPanden'
- description: Vervangen van een BagPand
+ summary: Vervangen van een BagPand
operationId: replaceBagPandById
parameters:
- name: 'id'
@@ -1190,7 +1190,7 @@ paths:
patch:
tags:
- 'BagPanden'
- description: Wijzigen van een BagPand
+ summary: Wijzigen van een BagPand
operationId: updateBagPandById
parameters:
- name: 'id'
@@ -1229,7 +1229,7 @@ paths:
get:
tags:
- 'BagWoonplaatsen'
- description: Ophalen van BagWoonplaatsen
+ summary: Ophalen van BagWoonplaatsen
operationId: listBagWoonplaatsen
parameters:
- name: params
@@ -1279,7 +1279,7 @@ paths:
post:
tags:
- 'BagWoonplaatsen'
- description: Voegt een nieuw(e) BagWoonplaats toe.
+ summary: Voegt een nieuw(e) BagWoonplaats toe.
operationId: createBagWoonplaats
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1319,7 +1319,7 @@ paths:
put:
tags:
- 'BagWoonplaatsen'
- description: |
+ summary: |
Vervangen van een BagWoonplaats op basis van overeenkomstige sleutelvelden.
operationId: replaceBagWoonplaats
parameters:
@@ -1354,7 +1354,7 @@ paths:
patch:
tags:
- 'BagWoonplaatsen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BagWoonplaats. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBagWoonplaats
@@ -1391,7 +1391,7 @@ paths:
get:
tags:
- 'BagWoonplaatsen'
- description: Retourneert een BagWoonplaats met de gegeven identifier
+ summary: Retourneert een BagWoonplaats met de gegeven identifier
operationId: readBagWoonplaatsById
parameters:
- name: id
@@ -1428,7 +1428,7 @@ paths:
put:
tags:
- 'BagWoonplaatsen'
- description: Vervangen van een BagWoonplaats
+ summary: Vervangen van een BagWoonplaats
operationId: replaceBagWoonplaatsById
parameters:
- name: 'id'
@@ -1466,7 +1466,7 @@ paths:
patch:
tags:
- 'BagWoonplaatsen'
- description: Wijzigen van een BagWoonplaats
+ summary: Wijzigen van een BagWoonplaats
operationId: updateBagWoonplaatsById
parameters:
- name: 'id'
@@ -1505,7 +1505,7 @@ paths:
get:
tags:
- 'Beleidswaarden'
- description: Ophalen van Beleidswaarden
+ summary: Ophalen van Beleidswaarden
operationId: listBeleidswaarden
parameters:
- name: params
@@ -1555,7 +1555,7 @@ paths:
post:
tags:
- 'Beleidswaarden'
- description: Voegt een nieuw(e) Beleidswaarde toe.
+ summary: Voegt een nieuw(e) Beleidswaarde toe.
operationId: createBeleidswaarde
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1595,7 +1595,7 @@ paths:
put:
tags:
- 'Beleidswaarden'
- description: |
+ summary: |
Vervangen van een Beleidswaarde op basis van overeenkomstige sleutelvelden.
operationId: replaceBeleidswaarde
parameters:
@@ -1630,7 +1630,7 @@ paths:
patch:
tags:
- 'Beleidswaarden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Beleidswaarde. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBeleidswaarde
@@ -1667,7 +1667,7 @@ paths:
get:
tags:
- 'Beleidswaarden'
- description: Retourneert een Beleidswaarde met de gegeven identifier
+ summary: Retourneert een Beleidswaarde met de gegeven identifier
operationId: readBeleidswaardeById
parameters:
- name: id
@@ -1704,7 +1704,7 @@ paths:
put:
tags:
- 'Beleidswaarden'
- description: Vervangen van een Beleidswaarde
+ summary: Vervangen van een Beleidswaarde
operationId: replaceBeleidswaardeById
parameters:
- name: 'id'
@@ -1742,7 +1742,7 @@ paths:
patch:
tags:
- 'Beleidswaarden'
- description: Wijzigen van een Beleidswaarde
+ summary: Wijzigen van een Beleidswaarde
operationId: updateBeleidswaardeById
parameters:
- name: 'id'
@@ -1781,7 +1781,7 @@ paths:
get:
tags:
- 'Bouwdelen'
- description: Ophalen van Bouwdelen
+ summary: Ophalen van Bouwdelen
operationId: listBouwdelen
parameters:
- name: params
@@ -1831,7 +1831,7 @@ paths:
post:
tags:
- 'Bouwdelen'
- description: Voegt een nieuw(e) Bouwdeel toe.
+ summary: Voegt een nieuw(e) Bouwdeel toe.
operationId: createBouwdeel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1871,7 +1871,7 @@ paths:
put:
tags:
- 'Bouwdelen'
- description: |
+ summary: |
Vervangen van een Bouwdeel op basis van overeenkomstige sleutelvelden.
operationId: replaceBouwdeel
parameters:
@@ -1906,7 +1906,7 @@ paths:
patch:
tags:
- 'Bouwdelen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Bouwdeel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBouwdeel
@@ -1943,7 +1943,7 @@ paths:
get:
tags:
- 'Bouwdelen'
- description: Retourneert een Bouwdeel met de gegeven identifier
+ summary: Retourneert een Bouwdeel met de gegeven identifier
operationId: readBouwdeelById
parameters:
- name: id
@@ -1980,7 +1980,7 @@ paths:
put:
tags:
- 'Bouwdelen'
- description: Vervangen van een Bouwdeel
+ summary: Vervangen van een Bouwdeel
operationId: replaceBouwdeelById
parameters:
- name: 'id'
@@ -2018,7 +2018,7 @@ paths:
patch:
tags:
- 'Bouwdelen'
- description: Wijzigen van een Bouwdeel
+ summary: Wijzigen van een Bouwdeel
operationId: updateBouwdeelById
parameters:
- name: 'id'
@@ -2057,7 +2057,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Ophalen van BouwkundigElementen
+ summary: Ophalen van BouwkundigElementen
operationId: listBouwkundigElementen
parameters:
- name: params
@@ -2107,7 +2107,7 @@ paths:
post:
tags:
- 'BouwkundigElementen'
- description: Voegt een nieuw(e) BouwkundigElement toe.
+ summary: Voegt een nieuw(e) BouwkundigElement toe.
operationId: createBouwkundigElement
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2147,7 +2147,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Vervangen van een BouwkundigElement op basis van overeenkomstige sleutelvelden.
operationId: replaceBouwkundigElement
parameters:
@@ -2182,7 +2182,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BouwkundigElement. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBouwkundigElement
@@ -2219,7 +2219,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Retourneert een BouwkundigElement met de gegeven identifier
+ summary: Retourneert een BouwkundigElement met de gegeven identifier
operationId: readBouwkundigElementById
parameters:
- name: id
@@ -2256,7 +2256,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: Vervangen van een BouwkundigElement
+ summary: Vervangen van een BouwkundigElement
operationId: replaceBouwkundigElementById
parameters:
- name: 'id'
@@ -2294,7 +2294,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: Wijzigen van een BouwkundigElement
+ summary: Wijzigen van een BouwkundigElement
operationId: updateBouwkundigElementById
parameters:
- name: 'id'
@@ -2333,7 +2333,7 @@ paths:
get:
tags:
- 'BuitenlandsAdressen'
- description: Ophalen van BuitenlandsAdressen
+ summary: Ophalen van BuitenlandsAdressen
operationId: listBuitenlandsAdressen
parameters:
- name: params
@@ -2383,7 +2383,7 @@ paths:
post:
tags:
- 'BuitenlandsAdressen'
- description: Voegt een nieuw(e) BuitenlandsAdres toe.
+ summary: Voegt een nieuw(e) BuitenlandsAdres toe.
operationId: createBuitenlandsAdres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2423,7 +2423,7 @@ paths:
put:
tags:
- 'BuitenlandsAdressen'
- description: |
+ summary: |
Vervangen van een BuitenlandsAdres op basis van overeenkomstige sleutelvelden.
operationId: replaceBuitenlandsAdres
parameters:
@@ -2458,7 +2458,7 @@ paths:
patch:
tags:
- 'BuitenlandsAdressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BuitenlandsAdres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBuitenlandsAdres
@@ -2495,7 +2495,7 @@ paths:
get:
tags:
- 'BuitenlandsAdressen'
- description: Retourneert een BuitenlandsAdres met de gegeven identifier
+ summary: Retourneert een BuitenlandsAdres met de gegeven identifier
operationId: readBuitenlandsAdresById
parameters:
- name: id
@@ -2532,7 +2532,7 @@ paths:
put:
tags:
- 'BuitenlandsAdressen'
- description: Vervangen van een BuitenlandsAdres
+ summary: Vervangen van een BuitenlandsAdres
operationId: replaceBuitenlandsAdresById
parameters:
- name: 'id'
@@ -2570,7 +2570,7 @@ paths:
patch:
tags:
- 'BuitenlandsAdressen'
- description: Wijzigen van een BuitenlandsAdres
+ summary: Wijzigen van een BuitenlandsAdres
operationId: updateBuitenlandsAdresById
parameters:
- name: 'id'
@@ -2609,7 +2609,7 @@ paths:
get:
tags:
- 'Buurten'
- description: Ophalen van Buurten
+ summary: Ophalen van Buurten
operationId: listBuurten
parameters:
- name: params
@@ -2659,7 +2659,7 @@ paths:
post:
tags:
- 'Buurten'
- description: Voegt een nieuw(e) Buurt toe.
+ summary: Voegt een nieuw(e) Buurt toe.
operationId: createBuurt
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2699,7 +2699,7 @@ paths:
put:
tags:
- 'Buurten'
- description: |
+ summary: |
Vervangen van een Buurt op basis van overeenkomstige sleutelvelden.
operationId: replaceBuurt
parameters:
@@ -2734,7 +2734,7 @@ paths:
patch:
tags:
- 'Buurten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Buurt. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBuurt
@@ -2771,7 +2771,7 @@ paths:
get:
tags:
- 'Buurten'
- description: Retourneert een Buurt met de gegeven identifier
+ summary: Retourneert een Buurt met de gegeven identifier
operationId: readBuurtById
parameters:
- name: id
@@ -2808,7 +2808,7 @@ paths:
put:
tags:
- 'Buurten'
- description: Vervangen van een Buurt
+ summary: Vervangen van een Buurt
operationId: replaceBuurtById
parameters:
- name: 'id'
@@ -2846,7 +2846,7 @@ paths:
patch:
tags:
- 'Buurten'
- description: Wijzigen van een Buurt
+ summary: Wijzigen van een Buurt
operationId: updateBuurtById
parameters:
- name: 'id'
@@ -2885,7 +2885,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Ophalen van Clusters
+ summary: Ophalen van Clusters
operationId: listClusters
parameters:
- name: params
@@ -2935,7 +2935,7 @@ paths:
post:
tags:
- 'Clusters'
- description: Voegt een nieuw(e) Cluster toe.
+ summary: Voegt een nieuw(e) Cluster toe.
operationId: createCluster
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2975,7 +2975,7 @@ paths:
put:
tags:
- 'Clusters'
- description: |
+ summary: |
Vervangen van een Cluster op basis van overeenkomstige sleutelvelden.
operationId: replaceCluster
parameters:
@@ -3010,7 +3010,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Cluster. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCluster
@@ -3047,7 +3047,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Retourneert een Cluster met de gegeven identifier
+ summary: Retourneert een Cluster met de gegeven identifier
operationId: readClusterById
parameters:
- name: id
@@ -3084,7 +3084,7 @@ paths:
put:
tags:
- 'Clusters'
- description: Vervangen van een Cluster
+ summary: Vervangen van een Cluster
operationId: replaceClusterById
parameters:
- name: 'id'
@@ -3122,7 +3122,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: Wijzigen van een Cluster
+ summary: Wijzigen van een Cluster
operationId: updateClusterById
parameters:
- name: 'id'
@@ -3161,7 +3161,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Ophalen van CollectiefObjecten
+ summary: Ophalen van CollectiefObjecten
operationId: listCollectiefObjecten
parameters:
- name: params
@@ -3211,7 +3211,7 @@ paths:
post:
tags:
- 'CollectiefObjecten'
- description: Voegt een nieuw(e) CollectiefObject toe.
+ summary: Voegt een nieuw(e) CollectiefObject toe.
operationId: createCollectiefObject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3251,7 +3251,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Vervangen van een CollectiefObject op basis van overeenkomstige sleutelvelden.
operationId: replaceCollectiefObject
parameters:
@@ -3286,7 +3286,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een CollectiefObject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCollectiefObject
@@ -3323,7 +3323,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Retourneert een CollectiefObject met de gegeven identifier
+ summary: Retourneert een CollectiefObject met de gegeven identifier
operationId: readCollectiefObjectById
parameters:
- name: id
@@ -3360,7 +3360,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: Vervangen van een CollectiefObject
+ summary: Vervangen van een CollectiefObject
operationId: replaceCollectiefObjectById
parameters:
- name: 'id'
@@ -3398,7 +3398,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: Wijzigen van een CollectiefObject
+ summary: Wijzigen van een CollectiefObject
operationId: updateCollectiefObjectById
parameters:
- name: 'id'
@@ -3437,7 +3437,7 @@ paths:
get:
tags:
- 'Conditiemetingen'
- description: Ophalen van Conditiemetingen
+ summary: Ophalen van Conditiemetingen
operationId: listConditiemetingen
parameters:
- name: params
@@ -3487,7 +3487,7 @@ paths:
post:
tags:
- 'Conditiemetingen'
- description: Voegt een nieuw(e) Conditiemeting toe.
+ summary: Voegt een nieuw(e) Conditiemeting toe.
operationId: createConditiemeting
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3527,7 +3527,7 @@ paths:
put:
tags:
- 'Conditiemetingen'
- description: |
+ summary: |
Vervangen van een Conditiemeting op basis van overeenkomstige sleutelvelden.
operationId: replaceConditiemeting
parameters:
@@ -3562,7 +3562,7 @@ paths:
patch:
tags:
- 'Conditiemetingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Conditiemeting. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateConditiemeting
@@ -3599,7 +3599,7 @@ paths:
get:
tags:
- 'Conditiemetingen'
- description: Retourneert een Conditiemeting met de gegeven identifier
+ summary: Retourneert een Conditiemeting met de gegeven identifier
operationId: readConditiemetingById
parameters:
- name: id
@@ -3636,7 +3636,7 @@ paths:
put:
tags:
- 'Conditiemetingen'
- description: Vervangen van een Conditiemeting
+ summary: Vervangen van een Conditiemeting
operationId: replaceConditiemetingById
parameters:
- name: 'id'
@@ -3674,7 +3674,7 @@ paths:
patch:
tags:
- 'Conditiemetingen'
- description: Wijzigen van een Conditiemeting
+ summary: Wijzigen van een Conditiemeting
operationId: updateConditiemetingById
parameters:
- name: 'id'
@@ -3713,7 +3713,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Ophalen van Eenheden
+ summary: Ophalen van Eenheden
operationId: listEenheden
parameters:
- name: params
@@ -3763,7 +3763,7 @@ paths:
post:
tags:
- 'Eenheden'
- description: Voegt een nieuw(e) Eenheid toe.
+ summary: Voegt een nieuw(e) Eenheid toe.
operationId: createEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3803,7 +3803,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: |
+ summary: |
Vervangen van een Eenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheid
parameters:
@@ -3838,7 +3838,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheid
@@ -3875,7 +3875,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Retourneert een Eenheid met de gegeven identifier
+ summary: Retourneert een Eenheid met de gegeven identifier
operationId: readEenheidById
parameters:
- name: id
@@ -3912,7 +3912,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: Vervangen van een Eenheid
+ summary: Vervangen van een Eenheid
operationId: replaceEenheidById
parameters:
- name: 'id'
@@ -3950,7 +3950,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: Wijzigen van een Eenheid
+ summary: Wijzigen van een Eenheid
operationId: updateEenheidById
parameters:
- name: 'id'
@@ -3989,7 +3989,7 @@ paths:
get:
tags:
- 'Eenheidadressen'
- description: Ophalen van Eenheidadressen
+ summary: Ophalen van Eenheidadressen
operationId: listEenheidadressen
parameters:
- name: params
@@ -4039,7 +4039,7 @@ paths:
post:
tags:
- 'Eenheidadressen'
- description: Voegt een nieuw(e) Eenheidadres toe.
+ summary: Voegt een nieuw(e) Eenheidadres toe.
operationId: createEenheidadres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4079,7 +4079,7 @@ paths:
put:
tags:
- 'Eenheidadressen'
- description: |
+ summary: |
Vervangen van een Eenheidadres op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidadres
parameters:
@@ -4114,7 +4114,7 @@ paths:
patch:
tags:
- 'Eenheidadressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheidadres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidadres
@@ -4151,7 +4151,7 @@ paths:
get:
tags:
- 'Eenheidadressen'
- description: Retourneert een Eenheidadres met de gegeven identifier
+ summary: Retourneert een Eenheidadres met de gegeven identifier
operationId: readEenheidadresById
parameters:
- name: id
@@ -4188,7 +4188,7 @@ paths:
put:
tags:
- 'Eenheidadressen'
- description: Vervangen van een Eenheidadres
+ summary: Vervangen van een Eenheidadres
operationId: replaceEenheidadresById
parameters:
- name: 'id'
@@ -4226,7 +4226,7 @@ paths:
patch:
tags:
- 'Eenheidadressen'
- description: Wijzigen van een Eenheidadres
+ summary: Wijzigen van een Eenheidadres
operationId: updateEenheidadresById
parameters:
- name: 'id'
@@ -4265,7 +4265,7 @@ paths:
get:
tags:
- 'Eenheidcriteria'
- description: Ophalen van Eenheidcriteria
+ summary: Ophalen van Eenheidcriteria
operationId: listEenheidcriteria
parameters:
- name: params
@@ -4315,7 +4315,7 @@ paths:
post:
tags:
- 'Eenheidcriteria'
- description: Voegt een nieuw(e) Eenheidcriterium toe.
+ summary: Voegt een nieuw(e) Eenheidcriterium toe.
operationId: createEenheidcriterium
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4355,7 +4355,7 @@ paths:
put:
tags:
- 'Eenheidcriteria'
- description: |
+ summary: |
Vervangen van een Eenheidcriterium op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidcriterium
parameters:
@@ -4390,7 +4390,7 @@ paths:
patch:
tags:
- 'Eenheidcriteria'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheidcriterium. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidcriterium
@@ -4427,7 +4427,7 @@ paths:
get:
tags:
- 'Eenheidcriteria'
- description: Retourneert een Eenheidcriterium met de gegeven identifier
+ summary: Retourneert een Eenheidcriterium met de gegeven identifier
operationId: readEenheidcriteriumById
parameters:
- name: id
@@ -4464,7 +4464,7 @@ paths:
put:
tags:
- 'Eenheidcriteria'
- description: Vervangen van een Eenheidcriterium
+ summary: Vervangen van een Eenheidcriterium
operationId: replaceEenheidcriteriumById
parameters:
- name: 'id'
@@ -4502,7 +4502,7 @@ paths:
patch:
tags:
- 'Eenheidcriteria'
- description: Wijzigen van een Eenheidcriterium
+ summary: Wijzigen van een Eenheidcriterium
operationId: updateEenheidcriteriumById
parameters:
- name: 'id'
@@ -4541,7 +4541,7 @@ paths:
get:
tags:
- 'EenheidToestanden'
- description: Ophalen van EenheidToestanden
+ summary: Ophalen van EenheidToestanden
operationId: listEenheidToestanden
parameters:
- name: params
@@ -4591,7 +4591,7 @@ paths:
post:
tags:
- 'EenheidToestanden'
- description: Voegt een nieuw(e) EenheidToestand toe.
+ summary: Voegt een nieuw(e) EenheidToestand toe.
operationId: createEenheidToestand
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4631,7 +4631,7 @@ paths:
put:
tags:
- 'EenheidToestanden'
- description: |
+ summary: |
Vervangen van een EenheidToestand op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidToestand
parameters:
@@ -4666,7 +4666,7 @@ paths:
patch:
tags:
- 'EenheidToestanden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een EenheidToestand. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidToestand
@@ -4703,7 +4703,7 @@ paths:
get:
tags:
- 'EenheidToestanden'
- description: Retourneert een EenheidToestand met de gegeven identifier
+ summary: Retourneert een EenheidToestand met de gegeven identifier
operationId: readEenheidToestandById
parameters:
- name: id
@@ -4740,7 +4740,7 @@ paths:
put:
tags:
- 'EenheidToestanden'
- description: Vervangen van een EenheidToestand
+ summary: Vervangen van een EenheidToestand
operationId: replaceEenheidToestandById
parameters:
- name: 'id'
@@ -4778,7 +4778,7 @@ paths:
patch:
tags:
- 'EenheidToestanden'
- description: Wijzigen van een EenheidToestand
+ summary: Wijzigen van een EenheidToestand
operationId: updateEenheidToestandById
parameters:
- name: 'id'
@@ -4817,7 +4817,7 @@ paths:
get:
tags:
- 'EenheidVoorwaardes'
- description: Ophalen van EenheidVoorwaardes
+ summary: Ophalen van EenheidVoorwaardes
operationId: listEenheidVoorwaardes
parameters:
- name: params
@@ -4867,7 +4867,7 @@ paths:
post:
tags:
- 'EenheidVoorwaardes'
- description: Voegt een nieuw(e) EenheidVoorwaarden toe.
+ summary: Voegt een nieuw(e) EenheidVoorwaarden toe.
operationId: createEenheidVoorwaarden
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4907,7 +4907,7 @@ paths:
put:
tags:
- 'EenheidVoorwaardes'
- description: |
+ summary: |
Vervangen van een EenheidVoorwaarden op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheidVoorwaarden
parameters:
@@ -4942,7 +4942,7 @@ paths:
patch:
tags:
- 'EenheidVoorwaardes'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een EenheidVoorwaarden. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheidVoorwaarden
@@ -4979,7 +4979,7 @@ paths:
get:
tags:
- 'EenheidVoorwaardes'
- description: Retourneert een EenheidVoorwaarden met de gegeven identifier
+ summary: Retourneert een EenheidVoorwaarden met de gegeven identifier
operationId: readEenheidVoorwaardenById
parameters:
- name: id
@@ -5016,7 +5016,7 @@ paths:
put:
tags:
- 'EenheidVoorwaardes'
- description: Vervangen van een EenheidVoorwaarden
+ summary: Vervangen van een EenheidVoorwaarden
operationId: replaceEenheidVoorwaardenById
parameters:
- name: 'id'
@@ -5054,7 +5054,7 @@ paths:
patch:
tags:
- 'EenheidVoorwaardes'
- description: Wijzigen van een EenheidVoorwaarden
+ summary: Wijzigen van een EenheidVoorwaarden
operationId: updateEenheidVoorwaardenById
parameters:
- name: 'id'
@@ -5093,7 +5093,7 @@ paths:
get:
tags:
- 'Energieprestaties'
- description: Ophalen van Energieprestaties
+ summary: Ophalen van Energieprestaties
operationId: listEnergieprestaties
parameters:
- name: params
@@ -5143,7 +5143,7 @@ paths:
post:
tags:
- 'Energieprestaties'
- description: Voegt een nieuw(e) Energieprestatie toe.
+ summary: Voegt een nieuw(e) Energieprestatie toe.
operationId: createEnergieprestatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5183,7 +5183,7 @@ paths:
put:
tags:
- 'Energieprestaties'
- description: |
+ summary: |
Vervangen van een Energieprestatie op basis van overeenkomstige sleutelvelden.
operationId: replaceEnergieprestatie
parameters:
@@ -5218,7 +5218,7 @@ paths:
patch:
tags:
- 'Energieprestaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Energieprestatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEnergieprestatie
@@ -5255,7 +5255,7 @@ paths:
get:
tags:
- 'Energieprestaties'
- description: Retourneert een Energieprestatie met de gegeven identifier
+ summary: Retourneert een Energieprestatie met de gegeven identifier
operationId: readEnergieprestatieById
parameters:
- name: id
@@ -5292,7 +5292,7 @@ paths:
put:
tags:
- 'Energieprestaties'
- description: Vervangen van een Energieprestatie
+ summary: Vervangen van een Energieprestatie
operationId: replaceEnergieprestatieById
parameters:
- name: 'id'
@@ -5330,7 +5330,7 @@ paths:
patch:
tags:
- 'Energieprestaties'
- description: Wijzigen van een Energieprestatie
+ summary: Wijzigen van een Energieprestatie
operationId: updateEnergieprestatieById
parameters:
- name: 'id'
@@ -5369,7 +5369,7 @@ paths:
get:
tags:
- 'Garanties'
- description: Ophalen van Garanties
+ summary: Ophalen van Garanties
operationId: listGaranties
parameters:
- name: params
@@ -5419,7 +5419,7 @@ paths:
post:
tags:
- 'Garanties'
- description: Voegt een nieuw(e) Garantie toe.
+ summary: Voegt een nieuw(e) Garantie toe.
operationId: createGarantie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5459,7 +5459,7 @@ paths:
put:
tags:
- 'Garanties'
- description: |
+ summary: |
Vervangen van een Garantie op basis van overeenkomstige sleutelvelden.
operationId: replaceGarantie
parameters:
@@ -5494,7 +5494,7 @@ paths:
patch:
tags:
- 'Garanties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Garantie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGarantie
@@ -5531,7 +5531,7 @@ paths:
get:
tags:
- 'Garanties'
- description: Retourneert een Garantie met de gegeven identifier
+ summary: Retourneert een Garantie met de gegeven identifier
operationId: readGarantieById
parameters:
- name: id
@@ -5568,7 +5568,7 @@ paths:
put:
tags:
- 'Garanties'
- description: Vervangen van een Garantie
+ summary: Vervangen van een Garantie
operationId: replaceGarantieById
parameters:
- name: 'id'
@@ -5606,7 +5606,7 @@ paths:
patch:
tags:
- 'Garanties'
- description: Wijzigen van een Garantie
+ summary: Wijzigen van een Garantie
operationId: updateGarantieById
parameters:
- name: 'id'
@@ -5645,7 +5645,7 @@ paths:
get:
tags:
- 'Gebouwen'
- description: Ophalen van Gebouwen
+ summary: Ophalen van Gebouwen
operationId: listGebouwen
parameters:
- name: params
@@ -5695,7 +5695,7 @@ paths:
post:
tags:
- 'Gebouwen'
- description: Voegt een nieuw(e) Gebouw toe.
+ summary: Voegt een nieuw(e) Gebouw toe.
operationId: createGebouw
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -5735,7 +5735,7 @@ paths:
put:
tags:
- 'Gebouwen'
- description: |
+ summary: |
Vervangen van een Gebouw op basis van overeenkomstige sleutelvelden.
operationId: replaceGebouw
parameters:
@@ -5770,7 +5770,7 @@ paths:
patch:
tags:
- 'Gebouwen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gebouw. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGebouw
@@ -5807,7 +5807,7 @@ paths:
get:
tags:
- 'Gebouwen'
- description: Retourneert een Gebouw met de gegeven identifier
+ summary: Retourneert een Gebouw met de gegeven identifier
operationId: readGebouwById
parameters:
- name: id
@@ -5844,7 +5844,7 @@ paths:
put:
tags:
- 'Gebouwen'
- description: Vervangen van een Gebouw
+ summary: Vervangen van een Gebouw
operationId: replaceGebouwById
parameters:
- name: 'id'
@@ -5882,7 +5882,7 @@ paths:
patch:
tags:
- 'Gebouwen'
- description: Wijzigen van een Gebouw
+ summary: Wijzigen van een Gebouw
operationId: updateGebouwById
parameters:
- name: 'id'
@@ -5921,7 +5921,7 @@ paths:
get:
tags:
- 'Gemeenten'
- description: Ophalen van Gemeenten
+ summary: Ophalen van Gemeenten
operationId: listGemeenten
parameters:
- name: params
@@ -5971,7 +5971,7 @@ paths:
post:
tags:
- 'Gemeenten'
- description: Voegt een nieuw(e) Gemeente toe.
+ summary: Voegt een nieuw(e) Gemeente toe.
operationId: createGemeente
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6011,7 +6011,7 @@ paths:
put:
tags:
- 'Gemeenten'
- description: |
+ summary: |
Vervangen van een Gemeente op basis van overeenkomstige sleutelvelden.
operationId: replaceGemeente
parameters:
@@ -6046,7 +6046,7 @@ paths:
patch:
tags:
- 'Gemeenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gemeente. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGemeente
@@ -6083,7 +6083,7 @@ paths:
get:
tags:
- 'Gemeenten'
- description: Retourneert een Gemeente met de gegeven identifier
+ summary: Retourneert een Gemeente met de gegeven identifier
operationId: readGemeenteById
parameters:
- name: id
@@ -6120,7 +6120,7 @@ paths:
put:
tags:
- 'Gemeenten'
- description: Vervangen van een Gemeente
+ summary: Vervangen van een Gemeente
operationId: replaceGemeenteById
parameters:
- name: 'id'
@@ -6158,7 +6158,7 @@ paths:
patch:
tags:
- 'Gemeenten'
- description: Wijzigen van een Gemeente
+ summary: Wijzigen van een Gemeente
operationId: updateGemeenteById
parameters:
- name: 'id'
@@ -6197,7 +6197,7 @@ paths:
get:
tags:
- 'Geometrieen'
- description: Ophalen van Geometrieen
+ summary: Ophalen van Geometrieen
operationId: listGeometrieen
parameters:
- name: params
@@ -6247,7 +6247,7 @@ paths:
post:
tags:
- 'Geometrieen'
- description: Voegt een nieuw(e) Geometrie toe.
+ summary: Voegt een nieuw(e) Geometrie toe.
operationId: createGeometrie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6287,7 +6287,7 @@ paths:
put:
tags:
- 'Geometrieen'
- description: |
+ summary: |
Vervangen van een Geometrie op basis van overeenkomstige sleutelvelden.
operationId: replaceGeometrie
parameters:
@@ -6322,7 +6322,7 @@ paths:
patch:
tags:
- 'Geometrieen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Geometrie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGeometrie
@@ -6359,7 +6359,7 @@ paths:
get:
tags:
- 'Geometrieen'
- description: Retourneert een Geometrie met de gegeven identifier
+ summary: Retourneert een Geometrie met de gegeven identifier
operationId: readGeometrieById
parameters:
- name: id
@@ -6396,7 +6396,7 @@ paths:
put:
tags:
- 'Geometrieen'
- description: Vervangen van een Geometrie
+ summary: Vervangen van een Geometrie
operationId: replaceGeometrieById
parameters:
- name: 'id'
@@ -6434,7 +6434,7 @@ paths:
patch:
tags:
- 'Geometrieen'
- description: Wijzigen van een Geometrie
+ summary: Wijzigen van een Geometrie
operationId: updateGeometrieById
parameters:
- name: 'id'
@@ -6473,7 +6473,7 @@ paths:
get:
tags:
- 'KadasterPercelen'
- description: Ophalen van KadasterPercelen
+ summary: Ophalen van KadasterPercelen
operationId: listKadasterPercelen
parameters:
- name: params
@@ -6523,7 +6523,7 @@ paths:
post:
tags:
- 'KadasterPercelen'
- description: Voegt een nieuw(e) KadasterPerceel toe.
+ summary: Voegt een nieuw(e) KadasterPerceel toe.
operationId: createKadasterPerceel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6563,7 +6563,7 @@ paths:
put:
tags:
- 'KadasterPercelen'
- description: |
+ summary: |
Vervangen van een KadasterPerceel op basis van overeenkomstige sleutelvelden.
operationId: replaceKadasterPerceel
parameters:
@@ -6598,7 +6598,7 @@ paths:
patch:
tags:
- 'KadasterPercelen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een KadasterPerceel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKadasterPerceel
@@ -6635,7 +6635,7 @@ paths:
get:
tags:
- 'KadasterPercelen'
- description: Retourneert een KadasterPerceel met de gegeven identifier
+ summary: Retourneert een KadasterPerceel met de gegeven identifier
operationId: readKadasterPerceelById
parameters:
- name: id
@@ -6672,7 +6672,7 @@ paths:
put:
tags:
- 'KadasterPercelen'
- description: Vervangen van een KadasterPerceel
+ summary: Vervangen van een KadasterPerceel
operationId: replaceKadasterPerceelById
parameters:
- name: 'id'
@@ -6710,7 +6710,7 @@ paths:
patch:
tags:
- 'KadasterPercelen'
- description: Wijzigen van een KadasterPerceel
+ summary: Wijzigen van een KadasterPerceel
operationId: updateKadasterPerceelById
parameters:
- name: 'id'
@@ -6749,7 +6749,7 @@ paths:
get:
tags:
- 'Marktwaarden'
- description: Ophalen van Marktwaarden
+ summary: Ophalen van Marktwaarden
operationId: listMarktwaarden
parameters:
- name: params
@@ -6799,7 +6799,7 @@ paths:
post:
tags:
- 'Marktwaarden'
- description: Voegt een nieuw(e) Marktwaarde toe.
+ summary: Voegt een nieuw(e) Marktwaarde toe.
operationId: createMarktwaarde
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -6839,7 +6839,7 @@ paths:
put:
tags:
- 'Marktwaarden'
- description: |
+ summary: |
Vervangen van een Marktwaarde op basis van overeenkomstige sleutelvelden.
operationId: replaceMarktwaarde
parameters:
@@ -6874,7 +6874,7 @@ paths:
patch:
tags:
- 'Marktwaarden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Marktwaarde. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateMarktwaarde
@@ -6911,7 +6911,7 @@ paths:
get:
tags:
- 'Marktwaarden'
- description: Retourneert een Marktwaarde met de gegeven identifier
+ summary: Retourneert een Marktwaarde met de gegeven identifier
operationId: readMarktwaardeById
parameters:
- name: id
@@ -6948,7 +6948,7 @@ paths:
put:
tags:
- 'Marktwaarden'
- description: Vervangen van een Marktwaarde
+ summary: Vervangen van een Marktwaarde
operationId: replaceMarktwaardeById
parameters:
- name: 'id'
@@ -6986,7 +6986,7 @@ paths:
patch:
tags:
- 'Marktwaarden'
- description: Wijzigen van een Marktwaarde
+ summary: Wijzigen van een Marktwaarde
operationId: updateMarktwaardeById
parameters:
- name: 'id'
@@ -7025,7 +7025,7 @@ paths:
get:
tags:
- 'Panden'
- description: Ophalen van Panden
+ summary: Ophalen van Panden
operationId: listPanden
parameters:
- name: params
@@ -7075,7 +7075,7 @@ paths:
post:
tags:
- 'Panden'
- description: Voegt een nieuw(e) Pand toe.
+ summary: Voegt een nieuw(e) Pand toe.
operationId: createPand
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7115,7 +7115,7 @@ paths:
put:
tags:
- 'Panden'
- description: |
+ summary: |
Vervangen van een Pand op basis van overeenkomstige sleutelvelden.
operationId: replacePand
parameters:
@@ -7150,7 +7150,7 @@ paths:
patch:
tags:
- 'Panden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Pand. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePand
@@ -7187,7 +7187,7 @@ paths:
get:
tags:
- 'Panden'
- description: Retourneert een Pand met de gegeven identifier
+ summary: Retourneert een Pand met de gegeven identifier
operationId: readPandById
parameters:
- name: id
@@ -7224,7 +7224,7 @@ paths:
put:
tags:
- 'Panden'
- description: Vervangen van een Pand
+ summary: Vervangen van een Pand
operationId: replacePandById
parameters:
- name: 'id'
@@ -7262,7 +7262,7 @@ paths:
patch:
tags:
- 'Panden'
- description: Wijzigen van een Pand
+ summary: Wijzigen van een Pand
operationId: updatePandById
parameters:
- name: 'id'
@@ -7301,7 +7301,7 @@ paths:
get:
tags:
- 'Postadressen'
- description: Ophalen van Postadressen
+ summary: Ophalen van Postadressen
operationId: listPostadressen
parameters:
- name: params
@@ -7351,7 +7351,7 @@ paths:
post:
tags:
- 'Postadressen'
- description: Voegt een nieuw(e) Postadres toe.
+ summary: Voegt een nieuw(e) Postadres toe.
operationId: createPostadres
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7391,7 +7391,7 @@ paths:
put:
tags:
- 'Postadressen'
- description: |
+ summary: |
Vervangen van een Postadres op basis van overeenkomstige sleutelvelden.
operationId: replacePostadres
parameters:
@@ -7426,7 +7426,7 @@ paths:
patch:
tags:
- 'Postadressen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Postadres. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePostadres
@@ -7463,7 +7463,7 @@ paths:
get:
tags:
- 'Postadressen'
- description: Retourneert een Postadres met de gegeven identifier
+ summary: Retourneert een Postadres met de gegeven identifier
operationId: readPostadresById
parameters:
- name: id
@@ -7500,7 +7500,7 @@ paths:
put:
tags:
- 'Postadressen'
- description: Vervangen van een Postadres
+ summary: Vervangen van een Postadres
operationId: replacePostadresById
parameters:
- name: 'id'
@@ -7538,7 +7538,7 @@ paths:
patch:
tags:
- 'Postadressen'
- description: Wijzigen van een Postadres
+ summary: Wijzigen van een Postadres
operationId: updatePostadresById
parameters:
- name: 'id'
@@ -7577,7 +7577,7 @@ paths:
get:
tags:
- 'Punten'
- description: Ophalen van Punten
+ summary: Ophalen van Punten
operationId: listPunten
parameters:
- name: params
@@ -7627,7 +7627,7 @@ paths:
post:
tags:
- 'Punten'
- description: Voegt een nieuw(e) Punt toe.
+ summary: Voegt een nieuw(e) Punt toe.
operationId: createPunt
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7667,7 +7667,7 @@ paths:
put:
tags:
- 'Punten'
- description: |
+ summary: |
Vervangen van een Punt op basis van overeenkomstige sleutelvelden.
operationId: replacePunt
parameters:
@@ -7702,7 +7702,7 @@ paths:
patch:
tags:
- 'Punten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Punt. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePunt
@@ -7739,7 +7739,7 @@ paths:
get:
tags:
- 'Punten'
- description: Retourneert een Punt met de gegeven identifier
+ summary: Retourneert een Punt met de gegeven identifier
operationId: readPuntById
parameters:
- name: id
@@ -7776,7 +7776,7 @@ paths:
put:
tags:
- 'Punten'
- description: Vervangen van een Punt
+ summary: Vervangen van een Punt
operationId: replacePuntById
parameters:
- name: 'id'
@@ -7814,7 +7814,7 @@ paths:
patch:
tags:
- 'Punten'
- description: Wijzigen van een Punt
+ summary: Wijzigen van een Punt
operationId: updatePuntById
parameters:
- name: 'id'
@@ -7853,7 +7853,7 @@ paths:
get:
tags:
- 'Renovaties'
- description: Ophalen van Renovaties
+ summary: Ophalen van Renovaties
operationId: listRenovaties
parameters:
- name: params
@@ -7903,7 +7903,7 @@ paths:
post:
tags:
- 'Renovaties'
- description: Voegt een nieuw(e) Renovatie toe.
+ summary: Voegt een nieuw(e) Renovatie toe.
operationId: createRenovatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -7943,7 +7943,7 @@ paths:
put:
tags:
- 'Renovaties'
- description: |
+ summary: |
Vervangen van een Renovatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRenovatie
parameters:
@@ -7978,7 +7978,7 @@ paths:
patch:
tags:
- 'Renovaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Renovatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRenovatie
@@ -8015,7 +8015,7 @@ paths:
get:
tags:
- 'Renovaties'
- description: Retourneert een Renovatie met de gegeven identifier
+ summary: Retourneert een Renovatie met de gegeven identifier
operationId: readRenovatieById
parameters:
- name: id
@@ -8052,7 +8052,7 @@ paths:
put:
tags:
- 'Renovaties'
- description: Vervangen van een Renovatie
+ summary: Vervangen van een Renovatie
operationId: replaceRenovatieById
parameters:
- name: 'id'
@@ -8090,7 +8090,7 @@ paths:
patch:
tags:
- 'Renovaties'
- description: Wijzigen van een Renovatie
+ summary: Wijzigen van een Renovatie
operationId: updateRenovatieById
parameters:
- name: 'id'
@@ -8129,7 +8129,7 @@ paths:
get:
tags:
- 'Ruimten'
- description: Ophalen van Ruimten
+ summary: Ophalen van Ruimten
operationId: listRuimten
parameters:
- name: params
@@ -8179,7 +8179,7 @@ paths:
post:
tags:
- 'Ruimten'
- description: Voegt een nieuw(e) Ruimte toe.
+ summary: Voegt een nieuw(e) Ruimte toe.
operationId: createRuimte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8219,7 +8219,7 @@ paths:
put:
tags:
- 'Ruimten'
- description: |
+ summary: |
Vervangen van een Ruimte op basis van overeenkomstige sleutelvelden.
operationId: replaceRuimte
parameters:
@@ -8254,7 +8254,7 @@ paths:
patch:
tags:
- 'Ruimten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Ruimte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRuimte
@@ -8291,7 +8291,7 @@ paths:
get:
tags:
- 'Ruimten'
- description: Retourneert een Ruimte met de gegeven identifier
+ summary: Retourneert een Ruimte met de gegeven identifier
operationId: readRuimteById
parameters:
- name: id
@@ -8328,7 +8328,7 @@ paths:
put:
tags:
- 'Ruimten'
- description: Vervangen van een Ruimte
+ summary: Vervangen van een Ruimte
operationId: replaceRuimteById
parameters:
- name: 'id'
@@ -8366,7 +8366,7 @@ paths:
patch:
tags:
- 'Ruimten'
- description: Wijzigen van een Ruimte
+ summary: Wijzigen van een Ruimte
operationId: updateRuimteById
parameters:
- name: 'id'
@@ -8405,7 +8405,7 @@ paths:
get:
tags:
- 'Stadsdelen'
- description: Ophalen van Stadsdelen
+ summary: Ophalen van Stadsdelen
operationId: listStadsdelen
parameters:
- name: params
@@ -8455,7 +8455,7 @@ paths:
post:
tags:
- 'Stadsdelen'
- description: Voegt een nieuw(e) Stadsdeel toe.
+ summary: Voegt een nieuw(e) Stadsdeel toe.
operationId: createStadsdeel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8495,7 +8495,7 @@ paths:
put:
tags:
- 'Stadsdelen'
- description: |
+ summary: |
Vervangen van een Stadsdeel op basis van overeenkomstige sleutelvelden.
operationId: replaceStadsdeel
parameters:
@@ -8530,7 +8530,7 @@ paths:
patch:
tags:
- 'Stadsdelen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Stadsdeel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateStadsdeel
@@ -8567,7 +8567,7 @@ paths:
get:
tags:
- 'Stadsdelen'
- description: Retourneert een Stadsdeel met de gegeven identifier
+ summary: Retourneert een Stadsdeel met de gegeven identifier
operationId: readStadsdeelById
parameters:
- name: id
@@ -8604,7 +8604,7 @@ paths:
put:
tags:
- 'Stadsdelen'
- description: Vervangen van een Stadsdeel
+ summary: Vervangen van een Stadsdeel
operationId: replaceStadsdeelById
parameters:
- name: 'id'
@@ -8642,7 +8642,7 @@ paths:
patch:
tags:
- 'Stadsdelen'
- description: Wijzigen van een Stadsdeel
+ summary: Wijzigen van een Stadsdeel
operationId: updateStadsdeelById
parameters:
- name: 'id'
@@ -8681,7 +8681,7 @@ paths:
get:
tags:
- 'Taxaties'
- description: Ophalen van Taxaties
+ summary: Ophalen van Taxaties
operationId: listTaxaties
parameters:
- name: params
@@ -8731,7 +8731,7 @@ paths:
post:
tags:
- 'Taxaties'
- description: Voegt een nieuw(e) Taxatie toe.
+ summary: Voegt een nieuw(e) Taxatie toe.
operationId: createTaxatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -8771,7 +8771,7 @@ paths:
put:
tags:
- 'Taxaties'
- description: |
+ summary: |
Vervangen van een Taxatie op basis van overeenkomstige sleutelvelden.
operationId: replaceTaxatie
parameters:
@@ -8806,7 +8806,7 @@ paths:
patch:
tags:
- 'Taxaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Taxatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateTaxatie
@@ -8843,7 +8843,7 @@ paths:
get:
tags:
- 'Taxaties'
- description: Retourneert een Taxatie met de gegeven identifier
+ summary: Retourneert een Taxatie met de gegeven identifier
operationId: readTaxatieById
parameters:
- name: id
@@ -8880,7 +8880,7 @@ paths:
put:
tags:
- 'Taxaties'
- description: Vervangen van een Taxatie
+ summary: Vervangen van een Taxatie
operationId: replaceTaxatieById
parameters:
- name: 'id'
@@ -8918,7 +8918,7 @@ paths:
patch:
tags:
- 'Taxaties'
- description: Wijzigen van een Taxatie
+ summary: Wijzigen van een Taxatie
operationId: updateTaxatieById
parameters:
- name: 'id'
@@ -8957,7 +8957,7 @@ paths:
get:
tags:
- 'Vertrekken'
- description: Ophalen van Vertrekken
+ summary: Ophalen van Vertrekken
operationId: listVertrekken
parameters:
- name: params
@@ -9007,7 +9007,7 @@ paths:
post:
tags:
- 'Vertrekken'
- description: Voegt een nieuw(e) Vertrek toe.
+ summary: Voegt een nieuw(e) Vertrek toe.
operationId: createVertrek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9047,7 +9047,7 @@ paths:
put:
tags:
- 'Vertrekken'
- description: |
+ summary: |
Vervangen van een Vertrek op basis van overeenkomstige sleutelvelden.
operationId: replaceVertrek
parameters:
@@ -9082,7 +9082,7 @@ paths:
patch:
tags:
- 'Vertrekken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Vertrek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVertrek
@@ -9119,7 +9119,7 @@ paths:
get:
tags:
- 'Vertrekken'
- description: Retourneert een Vertrek met de gegeven identifier
+ summary: Retourneert een Vertrek met de gegeven identifier
operationId: readVertrekById
parameters:
- name: id
@@ -9156,7 +9156,7 @@ paths:
put:
tags:
- 'Vertrekken'
- description: Vervangen van een Vertrek
+ summary: Vervangen van een Vertrek
operationId: replaceVertrekById
parameters:
- name: 'id'
@@ -9194,7 +9194,7 @@ paths:
patch:
tags:
- 'Vertrekken'
- description: Wijzigen van een Vertrek
+ summary: Wijzigen van een Vertrek
operationId: updateVertrekById
parameters:
- name: 'id'
@@ -9233,7 +9233,7 @@ paths:
get:
tags:
- 'Wijken'
- description: Ophalen van Wijken
+ summary: Ophalen van Wijken
operationId: listWijken
parameters:
- name: params
@@ -9283,7 +9283,7 @@ paths:
post:
tags:
- 'Wijken'
- description: Voegt een nieuw(e) Wijk toe.
+ summary: Voegt een nieuw(e) Wijk toe.
operationId: createWijk
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9323,7 +9323,7 @@ paths:
put:
tags:
- 'Wijken'
- description: |
+ summary: |
Vervangen van een Wijk op basis van overeenkomstige sleutelvelden.
operationId: replaceWijk
parameters:
@@ -9358,7 +9358,7 @@ paths:
patch:
tags:
- 'Wijken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Wijk. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWijk
@@ -9395,7 +9395,7 @@ paths:
get:
tags:
- 'Wijken'
- description: Retourneert een Wijk met de gegeven identifier
+ summary: Retourneert een Wijk met de gegeven identifier
operationId: readWijkById
parameters:
- name: id
@@ -9432,7 +9432,7 @@ paths:
put:
tags:
- 'Wijken'
- description: Vervangen van een Wijk
+ summary: Vervangen van een Wijk
operationId: replaceWijkById
parameters:
- name: 'id'
@@ -9470,7 +9470,7 @@ paths:
patch:
tags:
- 'Wijken'
- description: Wijzigen van een Wijk
+ summary: Wijzigen van een Wijk
operationId: updateWijkById
parameters:
- name: 'id'
@@ -9509,7 +9509,7 @@ paths:
get:
tags:
- 'Woningwaarderingen'
- description: Ophalen van Woningwaarderingen
+ summary: Ophalen van Woningwaarderingen
operationId: listWoningwaarderingen
parameters:
- name: params
@@ -9559,7 +9559,7 @@ paths:
post:
tags:
- 'Woningwaarderingen'
- description: Voegt een nieuw(e) Woningwaardering toe.
+ summary: Voegt een nieuw(e) Woningwaardering toe.
operationId: createWoningwaardering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9599,7 +9599,7 @@ paths:
put:
tags:
- 'Woningwaarderingen'
- description: |
+ summary: |
Vervangen van een Woningwaardering op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaardering
parameters:
@@ -9634,7 +9634,7 @@ paths:
patch:
tags:
- 'Woningwaarderingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Woningwaardering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaardering
@@ -9671,7 +9671,7 @@ paths:
get:
tags:
- 'Woningwaarderingen'
- description: Retourneert een Woningwaardering met de gegeven identifier
+ summary: Retourneert een Woningwaardering met de gegeven identifier
operationId: readWoningwaarderingById
parameters:
- name: id
@@ -9708,7 +9708,7 @@ paths:
put:
tags:
- 'Woningwaarderingen'
- description: Vervangen van een Woningwaardering
+ summary: Vervangen van een Woningwaardering
operationId: replaceWoningwaarderingById
parameters:
- name: 'id'
@@ -9746,7 +9746,7 @@ paths:
patch:
tags:
- 'Woningwaarderingen'
- description: Wijzigen van een Woningwaardering
+ summary: Wijzigen van een Woningwaardering
operationId: updateWoningwaarderingById
parameters:
- name: 'id'
@@ -9785,7 +9785,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteria'
- description: Ophalen van WoningwaarderingCriteria
+ summary: Ophalen van WoningwaarderingCriteria
operationId: listWoningwaarderingCriteria
parameters:
- name: params
@@ -9835,7 +9835,7 @@ paths:
post:
tags:
- 'WoningwaarderingCriteria'
- description: Voegt een nieuw(e) WoningwaarderingCriterium toe.
+ summary: Voegt een nieuw(e) WoningwaarderingCriterium toe.
operationId: createWoningwaarderingCriterium
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -9875,7 +9875,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteria'
- description: |
+ summary: |
Vervangen van een WoningwaarderingCriterium op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingCriterium
parameters:
@@ -9910,7 +9910,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteria'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingCriterium. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingCriterium
@@ -9947,7 +9947,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteria'
- description: Retourneert een WoningwaarderingCriterium met de gegeven identifier
+ summary: Retourneert een WoningwaarderingCriterium met de gegeven identifier
operationId: readWoningwaarderingCriteriumById
parameters:
- name: id
@@ -9984,7 +9984,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteria'
- description: Vervangen van een WoningwaarderingCriterium
+ summary: Vervangen van een WoningwaarderingCriterium
operationId: replaceWoningwaarderingCriteriumById
parameters:
- name: 'id'
@@ -10022,7 +10022,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteria'
- description: Wijzigen van een WoningwaarderingCriterium
+ summary: Wijzigen van een WoningwaarderingCriterium
operationId: updateWoningwaarderingCriteriumById
parameters:
- name: 'id'
@@ -10061,7 +10061,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Ophalen van WoningwaarderingCriteriumGroepen
+ summary: Ophalen van WoningwaarderingCriteriumGroepen
operationId: listWoningwaarderingCriteriumGroepen
parameters:
- name: params
@@ -10111,7 +10111,7 @@ paths:
post:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Voegt een nieuw(e) WoningwaarderingCriteriumGroep toe.
+ summary: Voegt een nieuw(e) WoningwaarderingCriteriumGroep toe.
operationId: createWoningwaarderingCriteriumGroep
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10151,7 +10151,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: |
+ summary: |
Vervangen van een WoningwaarderingCriteriumGroep op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingCriteriumGroep
parameters:
@@ -10186,7 +10186,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingCriteriumGroep. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingCriteriumGroep
@@ -10223,7 +10223,7 @@ paths:
get:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Retourneert een WoningwaarderingCriteriumGroep met de gegeven identifier
+ summary: Retourneert een WoningwaarderingCriteriumGroep met de gegeven identifier
operationId: readWoningwaarderingCriteriumGroepById
parameters:
- name: id
@@ -10260,7 +10260,7 @@ paths:
put:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Vervangen van een WoningwaarderingCriteriumGroep
+ summary: Vervangen van een WoningwaarderingCriteriumGroep
operationId: replaceWoningwaarderingCriteriumGroepById
parameters:
- name: 'id'
@@ -10298,7 +10298,7 @@ paths:
patch:
tags:
- 'WoningwaarderingCriteriumGroepen'
- description: Wijzigen van een WoningwaarderingCriteriumGroep
+ summary: Wijzigen van een WoningwaarderingCriteriumGroep
operationId: updateWoningwaarderingCriteriumGroepById
parameters:
- name: 'id'
@@ -10337,7 +10337,7 @@ paths:
get:
tags:
- 'WoningwaarderingGroepen'
- description: Ophalen van WoningwaarderingGroepen
+ summary: Ophalen van WoningwaarderingGroepen
operationId: listWoningwaarderingGroepen
parameters:
- name: params
@@ -10387,7 +10387,7 @@ paths:
post:
tags:
- 'WoningwaarderingGroepen'
- description: Voegt een nieuw(e) WoningwaarderingGroep toe.
+ summary: Voegt een nieuw(e) WoningwaarderingGroep toe.
operationId: createWoningwaarderingGroep
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10427,7 +10427,7 @@ paths:
put:
tags:
- 'WoningwaarderingGroepen'
- description: |
+ summary: |
Vervangen van een WoningwaarderingGroep op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingGroep
parameters:
@@ -10462,7 +10462,7 @@ paths:
patch:
tags:
- 'WoningwaarderingGroepen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingGroep. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingGroep
@@ -10499,7 +10499,7 @@ paths:
get:
tags:
- 'WoningwaarderingGroepen'
- description: Retourneert een WoningwaarderingGroep met de gegeven identifier
+ summary: Retourneert een WoningwaarderingGroep met de gegeven identifier
operationId: readWoningwaarderingGroepById
parameters:
- name: id
@@ -10536,7 +10536,7 @@ paths:
put:
tags:
- 'WoningwaarderingGroepen'
- description: Vervangen van een WoningwaarderingGroep
+ summary: Vervangen van een WoningwaarderingGroep
operationId: replaceWoningwaarderingGroepById
parameters:
- name: 'id'
@@ -10574,7 +10574,7 @@ paths:
patch:
tags:
- 'WoningwaarderingGroepen'
- description: Wijzigen van een WoningwaarderingGroep
+ summary: Wijzigen van een WoningwaarderingGroep
operationId: updateWoningwaarderingGroepById
parameters:
- name: 'id'
@@ -10613,7 +10613,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Ophalen van WoningwaarderingResultaten
+ summary: Ophalen van WoningwaarderingResultaten
operationId: listWoningwaarderingResultaten
parameters:
- name: params
@@ -10663,7 +10663,7 @@ paths:
post:
tags:
- 'WoningwaarderingResultaten'
- description: Voegt een nieuw(e) WoningwaarderingResultaat toe.
+ summary: Voegt een nieuw(e) WoningwaarderingResultaat toe.
operationId: createWoningwaarderingResultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10703,7 +10703,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Vervangen van een WoningwaarderingResultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingResultaat
parameters:
@@ -10738,7 +10738,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingResultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingResultaat
@@ -10775,7 +10775,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Retourneert een WoningwaarderingResultaat met de gegeven identifier
+ summary: Retourneert een WoningwaarderingResultaat met de gegeven identifier
operationId: readWoningwaarderingResultaatById
parameters:
- name: id
@@ -10812,7 +10812,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: Vervangen van een WoningwaarderingResultaat
+ summary: Vervangen van een WoningwaarderingResultaat
operationId: replaceWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -10850,7 +10850,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: Wijzigen van een WoningwaarderingResultaat
+ summary: Wijzigen van een WoningwaarderingResultaat
operationId: updateWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -10889,7 +10889,7 @@ paths:
get:
tags:
- 'Woonplaatsen'
- description: Ophalen van Woonplaatsen
+ summary: Ophalen van Woonplaatsen
operationId: listWoonplaatsen
parameters:
- name: params
@@ -10939,7 +10939,7 @@ paths:
post:
tags:
- 'Woonplaatsen'
- description: Voegt een nieuw(e) Woonplaats toe.
+ summary: Voegt een nieuw(e) Woonplaats toe.
operationId: createWoonplaats
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -10979,7 +10979,7 @@ paths:
put:
tags:
- 'Woonplaatsen'
- description: |
+ summary: |
Vervangen van een Woonplaats op basis van overeenkomstige sleutelvelden.
operationId: replaceWoonplaats
parameters:
@@ -11014,7 +11014,7 @@ paths:
patch:
tags:
- 'Woonplaatsen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Woonplaats. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoonplaats
@@ -11051,7 +11051,7 @@ paths:
get:
tags:
- 'Woonplaatsen'
- description: Retourneert een Woonplaats met de gegeven identifier
+ summary: Retourneert een Woonplaats met de gegeven identifier
operationId: readWoonplaatsById
parameters:
- name: id
@@ -11088,7 +11088,7 @@ paths:
put:
tags:
- 'Woonplaatsen'
- description: Vervangen van een Woonplaats
+ summary: Vervangen van een Woonplaats
operationId: replaceWoonplaatsById
parameters:
- name: 'id'
@@ -11126,7 +11126,7 @@ paths:
patch:
tags:
- 'Woonplaatsen'
- description: Wijzigen van een Woonplaats
+ summary: Wijzigen van een Woonplaats
operationId: updateWoonplaatsById
parameters:
- name: 'id'
@@ -11165,7 +11165,7 @@ paths:
get:
tags:
- 'WozEenheden'
- description: Ophalen van WozEenheden
+ summary: Ophalen van WozEenheden
operationId: listWozEenheden
parameters:
- name: params
@@ -11215,7 +11215,7 @@ paths:
post:
tags:
- 'WozEenheden'
- description: Voegt een nieuw(e) WozEenheid toe.
+ summary: Voegt een nieuw(e) WozEenheid toe.
operationId: createWozEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -11255,7 +11255,7 @@ paths:
put:
tags:
- 'WozEenheden'
- description: |
+ summary: |
Vervangen van een WozEenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceWozEenheid
parameters:
@@ -11290,7 +11290,7 @@ paths:
patch:
tags:
- 'WozEenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WozEenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWozEenheid
@@ -11327,7 +11327,7 @@ paths:
get:
tags:
- 'WozEenheden'
- description: Retourneert een WozEenheid met de gegeven identifier
+ summary: Retourneert een WozEenheid met de gegeven identifier
operationId: readWozEenheidById
parameters:
- name: id
@@ -11364,7 +11364,7 @@ paths:
put:
tags:
- 'WozEenheden'
- description: Vervangen van een WozEenheid
+ summary: Vervangen van een WozEenheid
operationId: replaceWozEenheidById
parameters:
- name: 'id'
@@ -11402,7 +11402,7 @@ paths:
patch:
tags:
- 'WozEenheden'
- description: Wijzigen van een WozEenheid
+ summary: Wijzigen van een WozEenheid
operationId: updateWozEenheidById
parameters:
- name: 'id'
@@ -11441,7 +11441,7 @@ paths:
get:
tags:
- 'ZekerheidVerpandingen'
- description: Ophalen van ZekerheidVerpandingen
+ summary: Ophalen van ZekerheidVerpandingen
operationId: listZekerheidVerpandingen
parameters:
- name: params
@@ -11491,7 +11491,7 @@ paths:
post:
tags:
- 'ZekerheidVerpandingen'
- description: Voegt een nieuw(e) ZekerheidVerpanding toe.
+ summary: Voegt een nieuw(e) ZekerheidVerpanding toe.
operationId: createZekerheidVerpanding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -11531,7 +11531,7 @@ paths:
put:
tags:
- 'ZekerheidVerpandingen'
- description: |
+ summary: |
Vervangen van een ZekerheidVerpanding op basis van overeenkomstige sleutelvelden.
operationId: replaceZekerheidVerpanding
parameters:
@@ -11566,7 +11566,7 @@ paths:
patch:
tags:
- 'ZekerheidVerpandingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ZekerheidVerpanding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZekerheidVerpanding
@@ -11603,7 +11603,7 @@ paths:
get:
tags:
- 'ZekerheidVerpandingen'
- description: Retourneert een ZekerheidVerpanding met de gegeven identifier
+ summary: Retourneert een ZekerheidVerpanding met de gegeven identifier
operationId: readZekerheidVerpandingById
parameters:
- name: id
@@ -11640,7 +11640,7 @@ paths:
put:
tags:
- 'ZekerheidVerpandingen'
- description: Vervangen van een ZekerheidVerpanding
+ summary: Vervangen van een ZekerheidVerpanding
operationId: replaceZekerheidVerpandingById
parameters:
- name: 'id'
@@ -11678,7 +11678,7 @@ paths:
patch:
tags:
- 'ZekerheidVerpandingen'
- description: Wijzigen van een ZekerheidVerpanding
+ summary: Wijzigen van een ZekerheidVerpanding
operationId: updateZekerheidVerpandingById
parameters:
- name: 'id'
@@ -11750,10 +11750,100 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Vastgoed.All.Read: alleen lezen van alle resources
+ Vastgoed.All.ReadWrite: lezen en schrijven van alle resources
+ Vastgoed.Adressen.Read: alleen lezen van Adressen
+ Vastgoed.Adressen.ReadWrite: lezen en schrijven van Adressen
+ Vastgoed.AdresseerbareObjectenBasisregistratie.Read: alleen lezen van AdresseerbareObjectenBasisregistratie
+ Vastgoed.AdresseerbareObjectenBasisregistratie.ReadWrite: lezen en schrijven van AdresseerbareObjectenBasisregistratie
+ Vastgoed.BagAdressen.Read: alleen lezen van BagAdressen
+ Vastgoed.BagAdressen.ReadWrite: lezen en schrijven van BagAdressen
+ Vastgoed.BagPanden.Read: alleen lezen van BagPanden
+ Vastgoed.BagPanden.ReadWrite: lezen en schrijven van BagPanden
+ Vastgoed.BagWoonplaatsen.Read: alleen lezen van BagWoonplaatsen
+ Vastgoed.BagWoonplaatsen.ReadWrite: lezen en schrijven van BagWoonplaatsen
+ Vastgoed.Beleidswaarden.Read: alleen lezen van Beleidswaarden
+ Vastgoed.Beleidswaarden.ReadWrite: lezen en schrijven van Beleidswaarden
+ Vastgoed.Bouwdelen.Read: alleen lezen van Bouwdelen
+ Vastgoed.Bouwdelen.ReadWrite: lezen en schrijven van Bouwdelen
+ Vastgoed.BouwkundigElementen.Read: alleen lezen van BouwkundigElementen
+ Vastgoed.BouwkundigElementen.ReadWrite: lezen en schrijven van BouwkundigElementen
+ Vastgoed.BuitenlandsAdressen.Read: alleen lezen van BuitenlandsAdressen
+ Vastgoed.BuitenlandsAdressen.ReadWrite: lezen en schrijven van BuitenlandsAdressen
+ Vastgoed.Buurten.Read: alleen lezen van Buurten
+ Vastgoed.Buurten.ReadWrite: lezen en schrijven van Buurten
+ Vastgoed.Clusters.Read: alleen lezen van Clusters
+ Vastgoed.Clusters.ReadWrite: lezen en schrijven van Clusters
+ Vastgoed.CollectiefObjecten.Read: alleen lezen van CollectiefObjecten
+ Vastgoed.CollectiefObjecten.ReadWrite: lezen en schrijven van CollectiefObjecten
+ Vastgoed.Conditiemetingen.Read: alleen lezen van Conditiemetingen
+ Vastgoed.Conditiemetingen.ReadWrite: lezen en schrijven van Conditiemetingen
+ Vastgoed.Eenheden.Read: alleen lezen van Eenheden
+ Vastgoed.Eenheden.ReadWrite: lezen en schrijven van Eenheden
+ Vastgoed.Eenheidadressen.Read: alleen lezen van Eenheidadressen
+ Vastgoed.Eenheidadressen.ReadWrite: lezen en schrijven van Eenheidadressen
+ Vastgoed.Eenheidcriteria.Read: alleen lezen van Eenheidcriteria
+ Vastgoed.Eenheidcriteria.ReadWrite: lezen en schrijven van Eenheidcriteria
+ Vastgoed.EenheidToestanden.Read: alleen lezen van EenheidToestanden
+ Vastgoed.EenheidToestanden.ReadWrite: lezen en schrijven van EenheidToestanden
+ Vastgoed.EenheidVoorwaardes.Read: alleen lezen van EenheidVoorwaardes
+ Vastgoed.EenheidVoorwaardes.ReadWrite: lezen en schrijven van EenheidVoorwaardes
+ Vastgoed.Energieprestaties.Read: alleen lezen van Energieprestaties
+ Vastgoed.Energieprestaties.ReadWrite: lezen en schrijven van Energieprestaties
+ Vastgoed.Garanties.Read: alleen lezen van Garanties
+ Vastgoed.Garanties.ReadWrite: lezen en schrijven van Garanties
+ Vastgoed.Gebouwen.Read: alleen lezen van Gebouwen
+ Vastgoed.Gebouwen.ReadWrite: lezen en schrijven van Gebouwen
+ Vastgoed.Gemeenten.Read: alleen lezen van Gemeenten
+ Vastgoed.Gemeenten.ReadWrite: lezen en schrijven van Gemeenten
+ Vastgoed.Geometrieen.Read: alleen lezen van Geometrieen
+ Vastgoed.Geometrieen.ReadWrite: lezen en schrijven van Geometrieen
+ Vastgoed.KadasterPercelen.Read: alleen lezen van KadasterPercelen
+ Vastgoed.KadasterPercelen.ReadWrite: lezen en schrijven van KadasterPercelen
+ Vastgoed.Marktwaarden.Read: alleen lezen van Marktwaarden
+ Vastgoed.Marktwaarden.ReadWrite: lezen en schrijven van Marktwaarden
+ Vastgoed.Panden.Read: alleen lezen van Panden
+ Vastgoed.Panden.ReadWrite: lezen en schrijven van Panden
+ Vastgoed.Postadressen.Read: alleen lezen van Postadressen
+ Vastgoed.Postadressen.ReadWrite: lezen en schrijven van Postadressen
+ Vastgoed.Punten.Read: alleen lezen van Punten
+ Vastgoed.Punten.ReadWrite: lezen en schrijven van Punten
+ Vastgoed.Renovaties.Read: alleen lezen van Renovaties
+ Vastgoed.Renovaties.ReadWrite: lezen en schrijven van Renovaties
+ Vastgoed.Ruimten.Read: alleen lezen van Ruimten
+ Vastgoed.Ruimten.ReadWrite: lezen en schrijven van Ruimten
+ Vastgoed.Stadsdelen.Read: alleen lezen van Stadsdelen
+ Vastgoed.Stadsdelen.ReadWrite: lezen en schrijven van Stadsdelen
+ Vastgoed.Taxaties.Read: alleen lezen van Taxaties
+ Vastgoed.Taxaties.ReadWrite: lezen en schrijven van Taxaties
+ Vastgoed.Vertrekken.Read: alleen lezen van Vertrekken
+ Vastgoed.Vertrekken.ReadWrite: lezen en schrijven van Vertrekken
+ Vastgoed.Wijken.Read: alleen lezen van Wijken
+ Vastgoed.Wijken.ReadWrite: lezen en schrijven van Wijken
+ Vastgoed.Woningwaarderingen.Read: alleen lezen van Woningwaarderingen
+ Vastgoed.Woningwaarderingen.ReadWrite: lezen en schrijven van Woningwaarderingen
+ Vastgoed.WoningwaarderingCriteria.Read: alleen lezen van WoningwaarderingCriteria
+ Vastgoed.WoningwaarderingCriteria.ReadWrite: lezen en schrijven van WoningwaarderingCriteria
+ Vastgoed.WoningwaarderingCriteriumGroepen.Read: alleen lezen van WoningwaarderingCriteriumGroepen
+ Vastgoed.WoningwaarderingCriteriumGroepen.ReadWrite: lezen en schrijven van WoningwaarderingCriteriumGroepen
+ Vastgoed.WoningwaarderingGroepen.Read: alleen lezen van WoningwaarderingGroepen
+ Vastgoed.WoningwaarderingGroepen.ReadWrite: lezen en schrijven van WoningwaarderingGroepen
+ Vastgoed.WoningwaarderingResultaten.Read: alleen lezen van WoningwaarderingResultaten
+ Vastgoed.WoningwaarderingResultaten.ReadWrite: lezen en schrijven van WoningwaarderingResultaten
+ Vastgoed.Woonplaatsen.Read: alleen lezen van Woonplaatsen
+ Vastgoed.Woonplaatsen.ReadWrite: lezen en schrijven van Woonplaatsen
+ Vastgoed.WozEenheden.Read: alleen lezen van WozEenheden
+ Vastgoed.WozEenheden.ReadWrite: lezen en schrijven van WozEenheden
+ Vastgoed.ZekerheidVerpandingen.Read: alleen lezen van ZekerheidVerpandingen
+ Vastgoed.ZekerheidVerpandingen.ReadWrite: lezen en schrijven van ZekerheidVerpandingen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Vastgoed.All.Read: alleen lezen van alle resources
Vastgoed.All.ReadWrite: lezen en schrijven van alle resources
@@ -11922,7 +12012,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -11934,7 +12024,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -12014,7 +12104,7 @@ components:
$ref: '#/components/schemas/Referentiedata'
bagHoofdadres:
allOf:
- - $ref: '#/components/schemas/Adres'
+ - $ref: '#/components/schemas/Adres-sleutels'
description: Het hoofdadres van het adresseerbaar object uit de basisregistratie.
bagIdentificatie:
type: string
@@ -12027,7 +12117,7 @@ components:
description: De adressen die gerelateerd zijn aan het adresseerbaar object uit de basisregistratie. Het hoofdadres maakt geen deel uit van deze collectie.
type: array
items:
- $ref: '#/components/schemas/Adres'
+ $ref: '#/components/schemas/Adres-sleutels'
bagOfficieel:
type: boolean
description: De aanduiding waarmee kan worden aangegeven dat een object in de basisregistratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
@@ -12039,20 +12129,16 @@ components:
description: De panden die gerelateerd zijn aan het adresseerbaar object uit de basisregistratie.
type: array
items:
- $ref: '#/components/schemas/Pand'
+ $ref: '#/components/schemas/Pand-sleutels'
bagStatus:
type: string
format: any
description: De fase van de levenscyclus van een standplaats, ligplaats of verblijfsobject waarin het betreffende object zich bevindt.
geometrie:
allOf:
- - $ref: '#/components/schemas/Geometrie'
+ - $ref: '#/components/schemas/Geometrie-sleutels'
description: De geometrie van het adresseerbaar object uit de basisregistratie.
- Pandbericht:
- allOf:
- - $ref: '#/components/schemas/Pand'
- - $ref: '#/components/schemas/Bericht-basis'
- Pand:
+ Adres-sleutels:
type: object
properties:
id:
@@ -12071,49 +12157,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van het pand volgens de eigenaar. Referentiedatasoort PANDSTATUS.
- adresseerbareObjectenBasisregistratie:
- description: De adresseerbare objecten uit de basisregistratie behorend bij het pand.
- type: array
- items:
- $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
- bag:
- allOf:
- - $ref: '#/components/schemas/BagPand'
- description: Verwijzing naar de BAG details behorende bij het pand.
- bouwdelen:
- description: De bouwdelen behorend bij het pand.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel'
- eenheden:
- description: De eenheden behorend bij het pand. De eenheden zijn onderdeel van het pand.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
- gebouw:
- allOf:
- - $ref: '#/components/schemas/Gebouw'
- description: Het gebouw behorend bij het pand.
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van het pand.
- kavelOppervlakte:
- type: number
- format: float
- description: De oppervlakte van het kavel van het pand.
- liftAanwezig:
- type: boolean
- description: De aanduiding geeft aan of in het pand in lift aanwezig is.
- renovatie:
- allOf:
- - $ref: '#/components/schemas/Renovatie'
- description: Verwijzing naar de laatste renovatie details van het pand.
- AdresseerbaarObjectBasisregistratie-sleutels:
+ Pand-sleutels:
type: object
properties:
id:
@@ -12132,11 +12176,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- BagPandbericht:
- allOf:
- - $ref: '#/components/schemas/BagPand'
- - $ref: '#/components/schemas/Bericht-basis'
- BagPand:
+ Geometrie-sleutels:
type: object
properties:
id:
@@ -12155,29 +12195,15 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bagIdentificatie:
- type: string
- format: any
- description: Het BAG registratienummer van het pand zoals bekend is bij de BAG.
- bagStatus:
- type: string
- format: any
- description: De fase van de levenscyclus van een pand, waarin het betreffende pand zich bevindt. Dit attribuut is afkomstig uit de BAG.
- bagInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de basisregistratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- bagBouwdatum:
- type: string
- format: date
- description: De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig gereed is opgeleverd.
- Bouwdeelbericht:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
+ BagAdresbericht:
allOf:
- - $ref: '#/components/schemas/Bouwdeel'
+ - $ref: '#/components/schemas/BagAdres'
- $ref: '#/components/schemas/Bericht-basis'
- Bouwdeel:
+ BagAdres:
type: object
properties:
id:
@@ -12196,43 +12222,39 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ bagNummeraanduidingIdentificatie:
type: string
format: any
- description: De naam van het bouwdeel.
- omschrijving:
+ description: De unieke aanduiding van een nummeraanduiding.
+ bagOpenbareRuimteIdentificatie:
type: string
format: any
- description: De omschrijving van het bouwdeel.
- bouwdelen:
- description: De bouwdelen behorend bij het bouwdeel, zodat een bouwdeel kan bestaan uit bouwdelen.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- bouwkundigeElementen:
- description: De bouwkundige elementen behorend bij het bouwdeel.
- type: array
- items:
- $ref: '#/components/schemas/BouwkundigElement'
- collectieveObjecten:
- description: De collectieve objecten behorend bij het bouwdeel.
- type: array
- items:
- $ref: '#/components/schemas/CollectiefObject'
- eenheden:
- description: De eenheden behorend bij het bouwdeel.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
- gebouw:
- allOf:
- - $ref: '#/components/schemas/Gebouw'
- description: Het gebouw behorend bij het bouwdeel.
- pand:
- allOf:
- - $ref: '#/components/schemas/Pand-sleutels'
- description: Het pand behorend bij het bouwdeel.
- Bouwdeel-sleutels:
+ description: De unieke aanduiding van een openbare ruimte.
+ bagNummeraanduidingInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagNummeraanduidingOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ bagNummeraanduidingStatus:
+ type: string
+ format: any
+ description: De fase van de levenscyclus van een nummeraanduiding, waarin de betreffende nummeraanduiding zich bevindt.
+ bagOpenbareRuimteInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagOpenbareruimteOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ bagOpenbareruimtestatus:
+ type: string
+ format: any
+ description: De fase van de levenscyclus van een openbare ruimte, waarin de betreffende openbare ruimte zich bevindt.
+ BagPandbericht:
+ allOf:
+ - $ref: '#/components/schemas/BagPand'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BagPand:
type: object
properties:
id:
@@ -12251,11 +12273,29 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- BouwkundigElementbericht:
+ bagIdentificatie:
+ type: string
+ format: any
+ description: Het BAG registratienummer van het pand zoals bekend is bij de BAG.
+ bagStatus:
+ type: string
+ format: any
+ description: De fase van de levenscyclus van een pand, waarin het betreffende pand zich bevindt. Dit attribuut is afkomstig uit de BAG.
+ bagInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de basisregistratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ bagBouwdatum:
+ type: string
+ format: date
+ description: De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig gereed is opgeleverd.
+ BagWoonplaatsbericht:
allOf:
- - $ref: '#/components/schemas/BouwkundigElement'
+ - $ref: '#/components/schemas/BagWoonplaats'
- $ref: '#/components/schemas/Bericht-basis'
- BouwkundigElement:
+ BagWoonplaats:
type: object
properties:
id:
@@ -12274,64 +12314,25 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ bagIdentificatie:
type: string
format: any
- description: De naam van het bouwkundig element.
- omschrijving:
+ description: De landelijk unieke aanduiding van een woonplaats, zoals vastgesteld door de beheerder van de landelijke tabel voor woonplaatsen.
+ bagStatus:
type: string
format: any
- description: De omschrijving van het bouwkundig element.
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTSOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTDETAILSOORT.
- begindatum:
- type: string
- format: date
- description: De begindatum van het bouwkundige element.
- einddatum:
- type: string
- format: date
- description: De einddatum het bouwkundige element
- bouwdeel:
- allOf:
- - $ref: '#/components/schemas/Bouwdeel-sleutels'
- description: Het bouwdeel behorend bij het bouwkundig element.
- garanties:
- description: De garanties behorend bij het bouwkundig element.
- type: array
- items:
- $ref: '#/components/schemas/Garantie'
- locatie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De locatie waar het bouwkundig element zich bevindt. Bijvoorbeeld huiskamer of toilet. Referentiedatasoort DEFECTLOCATIE.
- overeenkomsten:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- plaatsing:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Op welke wijze het bouwkundig element is aangebracht. Bijv. bij de bouw, renovatie, onderhoud of door huurder. Referentiedatasoort BOUWKUNDIGELEMENTPLAATSING.
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Garantiebericht:
+ description: De fase van de levenscyclus van een woonplaats, waarin de betreffende woonplaats zich bevindt.
+ bagInOnderzoek:
+ type: boolean
+ description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
+ bagOfficieel:
+ type: boolean
+ description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
+ Beleidswaardebericht:
allOf:
- - $ref: '#/components/schemas/Garantie'
+ - $ref: '#/components/schemas/Beleidswaarde'
- $ref: '#/components/schemas/Bericht-basis'
- Garantie:
+ Beleidswaarde:
type: object
properties:
id:
@@ -12350,52 +12351,74 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- omschrijving:
+ achterstalligOnderhoud:
+ type: number
+ format: float
+ description: Bedrag aan achterstallig onderhoud dat als correctie is toegepast.
+ afkoopErfpacht:
+ type: number
+ format: float
+ description: Het bedrag aan afkoop erfpacht dat als correctie is toegepast.
+ beheerAfslag:
+ type: number
+ format: float
+ description: 'Beheer (beheer): eventuele extra beheeruitgaven die gepaard gaan met de sociale doelgroep.'
+ beheerskosten:
+ type: number
+ format: float
+ description: Beheerkosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
+ beschikbaarheidAfslag:
+ type: number
+ format: float
+ description: 'Beschikbaarheid (doorexploiteren): in stand houden van een sociale portefeuille.'
+ betaalbaarheidAfslag:
+ type: number
+ format: float
+ description: 'Betaalbaarheid (huur): in stand houden van sociale huurprijzen passend bij de doelgroep.'
+ eenheid-sleutels:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarvoor de beleidswaarde is vastgelegd. Deze relatie is redundant omdat deze ook via de klasse Marktwaarde gelegd wordt (inclusief verslagjaar). Deze redundante relatie is ten behoeve van gemak bij mogelijke rapportages
+ kwaliteitAfslag:
+ type: number
+ format: float
+ description: 'Kwaliteit (onderhoud): eventuele extra onderhoudsuitgaven voor het op lange termijn in stand houden van de portefeuille.'
+ marktwaarde:
+ allOf:
+ - $ref: '#/components/schemas/Marktwaarde-sleutels'
+ description: De verwijzing naar de marktwaarde die ten grondslag ligt aan deze beleidswaarde.
+ onderhoudskosten:
+ type: number
+ format: float
+ description: Onderhoudskosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
+ streefhuur:
+ type: number
+ format: float
+ description: Actuele streefhuur op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
+ waarde:
+ type: number
+ format: float
+ description: 'De beleidswaarde van de eenheid waarde die rekening houdt met het beleid van de corporatie. Marktwaarde minus de afslagen voor beschikbaarheid, betaalbaarheid, kwaliteit en beheer, vormt de beleidswaarde (bron beleidswaarde WSW). Let op: het verslagjaar waarvoor de beleidswaarde is bepaald is het verslagjaar van de marktwaarde die de grondslag vormt van de beleidswaarde.'
+ Eenheid-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van de garantie.
- begindatum:
- type: string
- format: date
- description: De begindatum van de garantie.
- einddatum:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
- format: date
- description: De einddatum van de garantie.
- bouwdelen:
- description: De bouwdelen behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- bouwkundigeElementen:
- description: De bouwkundige elementen behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/BouwkundigElement-sleutels'
- clusters:
- description: De clusters behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/Cluster'
- collectieveObjecten:
- description: De collectieve objecten behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/CollectiefObject'
- eenheden:
- description: De eenheden behorend bij de garantie.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
- overeenkomst:
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- relatie:
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- BouwkundigElement-sleutels:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Marktwaarde-sleutels:
type: object
properties:
id:
@@ -12414,11 +12437,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Clusterbericht:
+ Bouwdeelbericht:
allOf:
- - $ref: '#/components/schemas/Cluster'
+ - $ref: '#/components/schemas/Bouwdeel'
- $ref: '#/components/schemas/Bericht-basis'
- Cluster:
+ Bouwdeel:
type: object
properties:
id:
@@ -12437,66 +12460,43 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort cluster. Bijvoorbeeld, nieuwbouwcluster, onderhoudscluster, financieel cluster. Referentiedatasoort CLUSTERSOORT.
naam:
type: string
format: any
- description: De naam van de cluster.
+ description: De naam van het bouwdeel.
omschrijving:
type: string
format: any
- description: De omschrijving van de cluster.
- bovenliggendeCluster:
- allOf:
- - $ref: '#/components/schemas/Cluster-sleutels'
- description: Het bovenliggende / overkoepelende cluster waar dit cluster eventueel onderdeel van is.
- begindatum:
- type: string
- format: date
- description: De begindatum van de cluster.
- einddatum:
- type: string
- format: date
- description: De einddatum van de cluster.
- collectieveObjecten:
- description: De collectieve objecten behorend bij de cluster.
- type: array
- items:
- $ref: '#/components/schemas/CollectiefObject'
- conditiemeting:
- allOf:
- - $ref: '#/components/schemas/Conditiemeting'
- description: Aan een cluster kunnen meerdere conditiescores conform de NEN 2767 gekoppeld worden (per tijdvak).
- eenheden:
- description: De eenheden behorend bij de cluster.
+ description: De omschrijving van het bouwdeel.
+ bouwdelen:
+ description: De bouwdelen behorend bij het bouwdeel, zodat een bouwdeel kan bestaan uit bouwdelen.
type: array
items:
- $ref: '#/components/schemas/Eenheid'
- garanties:
- description: De garanties behorend bij de cluster.
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ bouwkundigeElementen:
+ description: De bouwkundige elementen behorend bij het bouwdeel.
type: array
items:
- $ref: '#/components/schemas/Garantie-sleutels'
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de cluster.
- overeenkomsten:
+ $ref: '#/components/schemas/BouwkundigElement-sleutels'
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij het bouwdeel.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- relaties:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ eenheden:
+ description: De eenheden behorend bij het bouwdeel.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Cluster-sleutels:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ gebouw:
+ allOf:
+ - $ref: '#/components/schemas/Gebouw-sleutels'
+ description: Het gebouw behorend bij het bouwdeel.
+ pand:
+ allOf:
+ - $ref: '#/components/schemas/Pand-sleutels'
+ description: Het pand behorend bij het bouwdeel.
+ Bouwdeel-sleutels:
type: object
properties:
id:
@@ -12515,15 +12515,68 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ BouwkundigElement-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De naam van de cluster.
- CollectiefObjectbericht:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ CollectiefObject-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Gebouw-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ BouwkundigElementbericht:
allOf:
- - $ref: '#/components/schemas/CollectiefObject'
+ - $ref: '#/components/schemas/BouwkundigElement'
- $ref: '#/components/schemas/Bericht-basis'
- CollectiefObject:
+ BouwkundigElement:
type: object
properties:
id:
@@ -12542,55 +12595,60 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van het bouwkundig element.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het bouwkundig element.
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Bijvoorbeeld: fietsenstalling, galerij, lift etc. Referentiedatasoort COLLECTIEFOBJECTSOORT.'
- naam:
+ description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTSOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort bouwkundig element. Referentiedatasoort BOUWKUNDIGELEMENTDETAILSOORT.
+ begindatum:
type: string
- format: any
- description: De naam van het collectief object.
- adres:
+ format: date
+ description: De begindatum van het bouwkundige element.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum het bouwkundige element
+ bouwdeel:
allOf:
- - $ref: '#/components/schemas/Adres'
- description: Aan een Collectief Object kan een adres gekoppeld worden zodat een specifieke locatie opgenomen kan worden. Met name bij onderhoudswerkzaamheden is dit wenselijk.
- bouwdelen:
- description: De bouwdelen behorend bij het collectief object.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- clusters:
- description: De clusters behorend bij het collectief object.
- type: array
- items:
- $ref: '#/components/schemas/Cluster-sleutels'
- eenheden:
- description: De eenheden behorend bij het collectief object.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid'
+ - $ref: '#/components/schemas/Bouwdeel-sleutels'
+ description: Het bouwdeel behorend bij het bouwkundig element.
garanties:
- description: De garanties behorend bij het collectief object.
+ description: De garanties behorend bij het bouwkundig element.
type: array
items:
$ref: '#/components/schemas/Garantie-sleutels'
+ locatie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De locatie waar het bouwkundig element zich bevindt. Bijvoorbeeld huiskamer of toilet. Referentiedatasoort DEFECTLOCATIE.
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ plaatsing:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Op welke wijze het bouwkundig element is aangebracht. Bijv. bij de bouw, renovatie, onderhoud of door huurder. Referentiedatasoort BOUWKUNDIGELEMENTPLAATSING.
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Eenheidbericht:
- allOf:
- - $ref: '#/components/schemas/Eenheid'
- - $ref: '#/components/schemas/Bericht-basis'
- Eenheid:
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ Garantie-sleutels:
type: object
properties:
id:
@@ -12609,393 +12667,942 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De dienstverlening (soort) die geboden kan worden met de eenheid. Voorbeeld: Woonruimte, Bedrijfsruimte, Parkeergelegenheid. Referentiedatasoort EENHEIDSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het type van de eenheid. Bijvoorbeeld: Hoekwoning, Tussenwoning, Flat, Maisonnette. Hiervoor wordt de lijst van de waarderingskamer als uitgangspunt genomen. Referentiedatasoort EENHEIDDETAILSOORT.'
- naam:
+ BuitenlandsAdresbericht:
+ allOf:
+ - $ref: '#/components/schemas/BuitenlandsAdres'
+ - $ref: '#/components/schemas/Bericht-basis'
+ BuitenlandsAdres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-basis'
+ - type: object
+ properties:
+ adresregel1:
+ type: string
+ format: any
+ description: Adresregel in verband met een buitenlands adres.
+ adresregel2:
+ type: string
+ format: any
+ description: Adresregel in verband met een buitenlands adres.
+ land:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ postbusnummer:
+ type: string
+ format: any
+ description: Het postbusnummer behorende bij het adres
+ provincie:
+ type: string
+ format: any
+ description: De provincie behorend bij het adres.
+ woonplaats:
+ type: string
+ format: any
+ description: De woonplaats waarin het adres zich bevindt.
+ Buurtbericht:
+ allOf:
+ - $ref: '#/components/schemas/Buurt'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Buurt:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De naam van de eenheid.
- omschrijving:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: De omschrijving van de eenheid.
- bouwnummer:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: Het bouwnummer behorende bij de eenheid. Dit wordt aan een eenheid toegekend bij nieuwbouw van de eenheid. Vaak is op dat moment het adres van de eenheid nog niet bepaald.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De status van de eenheid, bijvoorbeeld: Leegstand, Uit beheer, Renovatie, Verhuurd, Verkocht Referentiedatasoort EENHEIDSTATUS.'
- detailStatus:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De detailstatus (ook wel substatus) van een status. De detailstatus geeft een extra reden op van de eenheid status die de eenheid heeft. Bijvoorbeeld: de status is Renovatie, de detailstatus geeft aan dat het om planmatig onderhoud gaat. Referentiedatasoort EENHEIDDETAILSTATUS.'
- inExploitatiedatum:
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
- format: date
- description: De datum waarop de eenheid in exploitatie is gegaan. We spreken over exploitatie als de eenheid in beheer is met als doel dat er resultaat wordt behaald.
- uitExploitatiedatum:
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
type: string
- format: date
- description: De datum waarop de eenheid uit exploitatie is gegaan, zowel het beheer als andere activiteiten stoppen.
- beginBouwdatum:
+ format: any
+ description: De naam van de buurt.
+ omschrijving:
type: string
- format: date
- description: De begindatum van de bouw van de eenheid.
- bouwjaar:
- type: integer
- format: int32
- description: Het bouwjaar waarin de bouw van de eenheid is afgerond.
- opleverdatum:
- type: string
- format: date
- description: De opleverdatum van de eenheid. De bouw van de eenheid is dan gereed of de eenheid is beschikbaar voor een volgende gebruiker.
- aantalOnzelfstandigeEenheden:
- type: integer
- format: int32
- description: Het aantal onzelfstandige eenheden (units, kamers) dat binnen de als geheel verhuurde eenheid valt. Bedoeld om het aantal onzelfstandige eenheden te kunnen verantwoorden in (verplichte) rapportages zoals dVi. Het attribuut wordt gebruikt als slechts één eenheid (met één huurovereenkomst) in het administratieve systeem is vastgelegd, in plaats van de (door VERA geadviseerde) registratie van alle eenheden met een bovenliggendeEenheid.
- aanvullendeDoelgroep:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De aanvullende doelgroep waarvoor de woning het meest geschikt is en waarvoor meestal ook voorrang wordt verleend. Bijv. Ouderen, Geestelijk gehandicapten, Lichamelijk gehandicapten, GGZ-Patiënten etc. Eventueel te gebruiken in combinatie met doelgroep. Referentiedatasoort AANVULLENDEDOELGROEP.
- adres:
- allOf:
- - $ref: '#/components/schemas/Adres'
- description: Het adres van de eenheid.
- adresseerbaarObjectBasisregistratie:
- allOf:
- - $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
- description: Het adresseerbare object uit de BAG die overeenkomt met de eenheid.
- beleidswaarde:
- description: De beleidswaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
- type: array
- items:
- $ref: '#/components/schemas/Beleidswaarde'
- benodigdeAfspraakverzoeken:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Afspraakverzoek in informatiedomein Relaties
- beoogdUitExploitatieDatum:
- type: string
- format: date
- description: Verwachte datum waarop de eenheid aan het bezit zal worden onttrokken door sloop of verkoop.
- bestemming:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Door de corporatie bepaalde bestemming van de eenheid bij mutatie (sloop, verkoop, huur). In AddresseerbaarObjectRegistratie wordt met het attribuut gebruiksdoel aangegeven wat volgens de gemeente het gebruiksdoel van de eenheid is (wonen, werken, zorg, enz.) Referentiedatasoort BESTEMMING.
- bouwdelen:
- description: Het bouwdelen behorend bij de eenheid
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- bovenliggendeEenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De bovenliggende eenheid waarvan de eenheid onderdeel van uit maakt.
- brutohuur:
- type: number
- format: float
- description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
- buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- clusters:
- description: De clusters waar de eenheid onderdeel van uitmaakt.
- type: array
- items:
- $ref: '#/components/schemas/Cluster-sleutels'
- collectieveObjecten:
- description: De collectieve objecten behorend bij de eenheid.
+ format: any
+ description: De omschrijving van de buurt.
+ eenheden:
+ description: De eenheden behorend bij de buurt.
type: array
items:
- $ref: '#/components/schemas/CollectiefObject-sleutels'
- criteria:
- description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid.
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ gebouwen:
+ description: De gebouwen behorend bij de buurt.
type: array
items:
- $ref: '#/components/schemas/Eenheidcriterium'
- doelgroep:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De doelgroep waarvoor de eenheid bestemd is, bijv. zorgwoning, jongerenwoning, seniorenwoning, eengezinswoning, starterswoning etc. Eventueel te gebruiken in combinatie met aanvullendeDoelgroep. Referentiedatasoort DOELGROEP.
- energieprestatie:
+ $ref: '#/components/schemas/Gebouw-sleutels'
+ geometrie:
allOf:
- - $ref: '#/components/schemas/Energieprestatie'
- description: De huidige energieprestatie van de eenheid. OBSOLETE
- deprecated: true
- energieprestaties:
- description: De huidige energieprestatie(s) van de eenheid.
- type: array
- items:
- $ref: '#/components/schemas/Energieprestatie'
- energievoorzieningen:
- description: Voorzieningen met betrekking tot energie zoals zonnepanelen en oplaadpunten Referentiedatasoort EENHEIDENERGIEVOORZIENING.
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de buurt.
+ relaties:
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- etage:
- type: integer
- format: int32
- description: De etage waarop de eenheid zich bevindt.
- gebouw:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ wijk:
allOf:
- - $ref: '#/components/schemas/Gebouw'
- description: Het gebouw waaruit de eenheid onderdeel van maakt.
- gebruiksoppervlakte:
- type: integer
- format: int32
- description: De gebruiksoppervlakte van een eenheid(verblijfsobject) in gehele vierkante meters, gemeten conform NEN 2580. Te gebruiken voor verantwoording dVi. Naast gebruiksoppervlakte is ook een attribuut totaleOppervlakte beschikbaar.
- inExploitatieReden:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De wijk behorend bij de buurt.
+ Wijk-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de wijk.
+ Clusterbericht:
+ allOf:
+ - $ref: '#/components/schemas/Cluster'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Cluster:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het in exploitatie nemen van een eenheid. Bijvoorbeeld: verhuur of beheer namens andere eigenaren. Referentiedatasoort INEXPLOITATIEREDEN.'
- interieur:
- description: Binnenruimte van de woning zoals gemeubileerd en vloerbedekking in de woonkamer. Referentiedatasoort EENHEIDINTERIEUR.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- isolatie:
- description: Getroffen isolatie maatregelen in de eenheid. Referentiedatasoort EENHEIDISOLATIE.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- juridischEigendomspercentage:
- type: integer
- format: int32
- description: Het percentage juridisch eigendom zoals vastgelegd in de eigendomsakte.
- kadastraalNummer:
+ description: Het soort cluster. Bijvoorbeeld, nieuwbouwcluster, onderhoudscluster, financieel cluster. Referentiedatasoort CLUSTERSOORT.
+ naam:
type: string
format: any
- description: Het kadastraalnummer behorend bij de eenheid.
- kamersAantal:
- type: integer
- format: int32
- description: Het aantal leefruimten en slaapkamers behorende bij de eenheid.
- klimaatbeheersing:
- description: Verzameling van kenmerken die het binnenklimaat (lucht, warmte en koeling) regelen in de eenheid. Referentiedatasoort EENHEIDKLIMAATBEHEERSING.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- kwaliteitsniveau:
+ description: De naam van de cluster.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de cluster.
+ bovenliggendeCluster:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het kwaliteitsniveau van de eenheid. Referentiedatasoort KWALITEITSNIVEAU.
- ligging:
- description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg en vrij uitzicht Referentiedatasoort EENHEIDLIGGING.'
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- liggingBuitenruimten:
- description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ - $ref: '#/components/schemas/Cluster-sleutels'
+ description: Het bovenliggende / overkoepelende cluster waar dit cluster eventueel onderdeel van is.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de cluster.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de cluster.
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij de cluster.
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- maatschappelijkLabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort de eenheid tot de DAEB-tak of tot de niet-DAEB-tak. Het label op de eenheid kan afwijken van het maatschappelijk label van de huurovereenkomst. Hiermee kan worden aangegeven dat een eenheid die behoort tot de niet-DAEB tak als DAEB-verhuring verantwoord moet worden. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
- marktlabel:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ conditiemeting:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het marklabel wordt gebruikt om het strategisch voorraadbeleid vast te leggen. Referentiedatasoort MARKTLABEL.
- marktwaarde:
- description: De marktwaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
- type: array
- items:
- $ref: '#/components/schemas/Marktwaarde'
- monumenten:
- description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort EENHEIDMONUMENT.
+ - $ref: '#/components/schemas/Conditiemeting-sleutels'
+ description: Aan een cluster kunnen meerdere conditiescores conform de NEN 2767 gekoppeld worden (per tijdvak).
+ eenheden:
+ description: De eenheden behorend bij de cluster.
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- nevenadressen:
- description: De nevenadressen van de eenheid.
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ garanties:
+ description: De garanties behorend bij de cluster.
type: array
items:
- $ref: '#/components/schemas/Adres'
- onderhoudslabel:
+ $ref: '#/components/schemas/Garantie-sleutels'
+ geometrie:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het onderhoudslabel geeft aan hoe hoog of laag het onderhoudsniveau van het betreffende eenheid moet zijn. Hierbij wordt rekening gehouden met het soort bewoners en de toekomst van het pand. Referentiedatasoort ONDERHOUDSLABEL.
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de cluster.
overeenkomsten:
type: array
items:
type: string
format: uri
- description: Referenties naar Overeenkomst in informatiedomein Overeenkomsten
- overigeVertrekkenTotaalOppervlakte:
- type: number
- format: float
- description: Het totaal aan oppervlakte van overige vertrekken. Met overige vertrekken worden de ruimtes bedoeld die ook in de categorie overige ruimtes vallen bij het bepalen van de woningwaarderingspunten.
- panden:
- description: De panden behorend bij een eenheid.
- type: array
- items:
- $ref: '#/components/schemas/Pand-sleutels'
- prestatieafspraken:
- description: Geeft aan of voor de eenheid een specifieke prestatieafspraak is gemaakt (meestal met een gemeente), bijvoorbeeld over het aanwenden van een extra inkomensafhankelijke huurverhoging voor investeringen. Referentiedatasoort PRESTATIEAFSPRAAK.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- prijscomponenten:
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Prijscomponent in informatiedomein Overeenkomsten
- prijsconditie:
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ Cluster-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de cluster.
+ Conditiemeting-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ CollectiefObjectbericht:
+ allOf:
+ - $ref: '#/components/schemas/CollectiefObject'
+ - $ref: '#/components/schemas/Bericht-basis'
+ CollectiefObject:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De voorwaarden behorende bij de huur- of koopprijs. Bijv. Kopers Kosten. Referentiedatasoort EENHEIDPRIJSCONDITIE.
- publicatie:
- type: string
- format: uri
- description: Referentie naar Publicatie in informatiedomein Woonruimteverdeling
- publicatieLabel:
+ description: 'Bijvoorbeeld: fietsenstalling, galerij, lift etc. Referentiedatasoort COLLECTIEFOBJECTSOORT.'
+ naam:
type: string
format: any
- description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning etc.
- rekenhuur:
- type: number
- format: float
- description: De subsidiabele huur in euro's die geregistreerd staat bij de eenheid. De subsidiabele huur is het bedrag van de huur dat in aanmerking komt voor huurtoeslag.
+ description: De naam van het collectief object.
+ adres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-sleutels'
+ description: Aan een Collectief Object kan een adres gekoppeld worden zodat een specifieke locatie opgenomen kan worden. Met name bij onderhoudswerkzaamheden is dit wenselijk.
+ bouwdelen:
+ description: De bouwdelen behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ clusters:
+ description: De clusters behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster-sleutels'
+ eenheden:
+ description: De eenheden behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ garanties:
+ description: De garanties behorend bij het collectief object.
+ type: array
+ items:
+ $ref: '#/components/schemas/Garantie-sleutels'
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
relaties:
type: array
items:
type: string
format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- renovatie:
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ Conditiemetingbericht:
+ allOf:
+ - $ref: '#/components/schemas/Conditiemeting'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Conditiemeting:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum die aangeeft wanneer de conditiescore is bepaald. De combinatie van start en einddatum geven een sluitende periode waarin een bepaalde conditiescore geldig is.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum die aangeeft tot wanneer de conditiescore geldig is. Als de einddatum niet beschikbaar is, dan hoeft dit niet opgegeven worden en is de conditiescore voor onbepaalde tijd geldig.
+ conditiescore:
allOf:
- - $ref: '#/components/schemas/Renovatie'
- description: De details van de laatste renovatie van de eenheid.
- ruimten:
- description: De verschillende ruimtes behorend bij de eenheid Bij. 'Achtertuin' of 'Woonkamer'.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De conditiescore uit de NEN 2767. Bijvoorbeeld score 1 voor uitstekende conditie, 4 voor matige conditie. Referentiedatasoort CONDITIESCORE.
+ Eenheidbericht:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Eenheid:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De dienstverlening (soort) die geboden kan worden met de eenheid. Voorbeeld: Woonruimte, Bedrijfsruimte, Parkeergelegenheid. Referentiedatasoort EENHEIDSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het type van de eenheid. Bijvoorbeeld: Hoekwoning, Tussenwoning, Flat, Maisonnette. Hiervoor wordt de lijst van de waarderingskamer als uitgangspunt genomen. Referentiedatasoort EENHEIDDETAILSOORT.'
+ naam:
+ type: string
+ format: any
+ description: De naam van de eenheid.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de eenheid.
+ bouwnummer:
+ type: string
+ format: any
+ description: Het bouwnummer behorende bij de eenheid. Dit wordt aan een eenheid toegekend bij nieuwbouw van de eenheid. Vaak is op dat moment het adres van de eenheid nog niet bepaald.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De status van de eenheid, bijvoorbeeld: Leegstand, Uit beheer, Renovatie, Verhuurd, Verkocht Referentiedatasoort EENHEIDSTATUS.'
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De detailstatus (ook wel substatus) van een status. De detailstatus geeft een extra reden op van de eenheid status die de eenheid heeft. Bijvoorbeeld: de status is Renovatie, de detailstatus geeft aan dat het om planmatig onderhoud gaat. Referentiedatasoort EENHEIDDETAILSTATUS.'
+ inExploitatiedatum:
+ type: string
+ format: date
+ description: De datum waarop de eenheid in exploitatie is gegaan. We spreken over exploitatie als de eenheid in beheer is met als doel dat er resultaat wordt behaald.
+ uitExploitatiedatum:
+ type: string
+ format: date
+ description: De datum waarop de eenheid uit exploitatie is gegaan, zowel het beheer als andere activiteiten stoppen.
+ beginBouwdatum:
+ type: string
+ format: date
+ description: De begindatum van de bouw van de eenheid.
+ bouwjaar:
+ type: integer
+ format: int32
+ description: Het bouwjaar waarin de bouw van de eenheid is afgerond.
+ opleverdatum:
+ type: string
+ format: date
+ description: De opleverdatum van de eenheid. De bouw van de eenheid is dan gereed of de eenheid is beschikbaar voor een volgende gebruiker.
+ aantalOnzelfstandigeEenheden:
+ type: integer
+ format: int32
+ description: Het aantal onzelfstandige eenheden (units, kamers) dat binnen de als geheel verhuurde eenheid valt. Bedoeld om het aantal onzelfstandige eenheden te kunnen verantwoorden in (verplichte) rapportages zoals dVi. Het attribuut wordt gebruikt als slechts één eenheid (met één huurovereenkomst) in het administratieve systeem is vastgelegd, in plaats van de (door VERA geadviseerde) registratie van alle eenheden met een bovenliggendeEenheid.
+ aanvullendeDoelgroep:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De aanvullende doelgroep waarvoor de woning het meest geschikt is en waarvoor meestal ook voorrang wordt verleend. Bijv. Ouderen, Geestelijk gehandicapten, Lichamelijk gehandicapten, GGZ-Patiënten etc. Eventueel te gebruiken in combinatie met doelgroep. Referentiedatasoort AANVULLENDEDOELGROEP.
+ adres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-sleutels'
+ description: Het adres van de eenheid.
+ adresseerbaarObjectBasisregistratie:
+ allOf:
+ - $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
+ description: Het adresseerbare object uit de BAG die overeenkomt met de eenheid.
+ beleidswaarde:
+ description: De beleidswaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
type: array
items:
- $ref: '#/components/schemas/Ruimte'
- sanitair:
- description: Sanitaire voorzieningen Referentiedatasoort EENHEIDSANITAIR.
+ $ref: '#/components/schemas/Beleidswaarde-sleutels'
+ benodigdeAfspraakverzoeken:
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- situering:
+ type: string
+ format: uri
+ description: Referenties naar Afspraakverzoek-sleutels in informatiedomein Relaties
+ beoogdUitExploitatieDatum:
+ type: string
+ format: date
+ description: Verwachte datum waarop de eenheid aan het bezit zal worden onttrokken door sloop of verkoop.
+ bestemming:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Door de corporatie bepaalde bestemming van de eenheid bij mutatie (sloop, verkoop, huur). In AddresseerbaarObjectRegistratie wordt met het attribuut gebruiksdoel aangegeven wat volgens de gemeente het gebruiksdoel van de eenheid is (wonen, werken, zorg, enz.) Referentiedatasoort BESTEMMING.
+ bouwdelen:
+ description: Het bouwdelen behorend bij de eenheid
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ bovenliggendeEenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De bovenliggende eenheid waarvan de eenheid onderdeel van uit maakt.
+ brutohuur:
+ type: number
+ format: float
+ description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
+ buitenruimten:
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ deprecated: true
+ clusters:
+ description: De clusters waar de eenheid onderdeel van uitmaakt.
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster-sleutels'
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ criteria:
+ description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheidcriterium-sleutels'
+ doelgroep:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De doelgroep waarvoor de eenheid bestemd is, bijv. zorgwoning, jongerenwoning, seniorenwoning, eengezinswoning, starterswoning etc. Eventueel te gebruiken in combinatie met aanvullendeDoelgroep. Referentiedatasoort DOELGROEP.
+ energieprestatie:
+ allOf:
+ - $ref: '#/components/schemas/Energieprestatie-sleutels'
+ description: De huidige energieprestatie van de eenheid. OBSOLETE
+ deprecated: true
+ energieprestaties:
+ description: De huidige energieprestatie(s) van de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Energieprestatie-sleutels'
+ energievoorzieningen:
+ description: Voorzieningen met betrekking tot energie zoals zonnepanelen en oplaadpunten Referentiedatasoort EENHEIDENERGIEVOORZIENING.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ etage:
+ type: integer
+ format: int32
+ description: De etage waarop de eenheid zich bevindt.
+ gebouw:
+ allOf:
+ - $ref: '#/components/schemas/Gebouw-sleutels'
+ description: Het gebouw waaruit de eenheid onderdeel van maakt.
+ gebruiksoppervlakte:
+ type: integer
+ format: int32
+ description: De gebruiksoppervlakte van een eenheid(verblijfsobject) in gehele vierkante meters, gemeten conform NEN 2580. Te gebruiken voor verantwoording dVi. Naast gebruiksoppervlakte is ook een attribuut totaleOppervlakte beschikbaar.
+ inExploitatieReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De reden voor het in exploitatie nemen van een eenheid. Bijvoorbeeld: verhuur of beheer namens andere eigenaren. Referentiedatasoort INEXPLOITATIEREDEN.'
+ interieur:
+ description: Binnenruimte van de woning zoals gemeubileerd en vloerbedekking in de woonkamer. Referentiedatasoort EENHEIDINTERIEUR.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ isolatie:
+ description: Getroffen isolatie maatregelen in de eenheid. Referentiedatasoort EENHEIDISOLATIE.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ juridischEigendomspercentage:
+ type: integer
+ format: int32
+ description: Het percentage juridisch eigendom zoals vastgelegd in de eigendomsakte.
+ kadastraalNummer:
+ type: string
+ format: any
+ description: Het kadastraalnummer behorend bij de eenheid.
+ kamersAantal:
+ type: integer
+ format: int32
+ description: Het aantal leefruimten en slaapkamers behorende bij de eenheid.
+ klimaatbeheersing:
+ description: Verzameling van kenmerken die het binnenklimaat (lucht, warmte en koeling) regelen in de eenheid. Referentiedatasoort EENHEIDKLIMAATBEHEERSING.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ kwaliteitsniveau:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het kwaliteitsniveau van de eenheid. Referentiedatasoort KWALITEITSNIVEAU.
+ ligging:
+ description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg en vrij uitzicht Referentiedatasoort EENHEIDLIGGING.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ liggingBuitenruimten:
+ description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc. OBSOLETE Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ deprecated: true
+ liggingTuin:
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ deprecated: true
+ maatschappelijkLabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort de eenheid tot de DAEB-tak of tot de niet-DAEB-tak. Het label op de eenheid kan afwijken van het maatschappelijk label van de huurovereenkomst. Hiermee kan worden aangegeven dat een eenheid die behoort tot de niet-DAEB tak als DAEB-verhuring verantwoord moet worden. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
+ marktlabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het marklabel wordt gebruikt om het strategisch voorraadbeleid vast te leggen. Referentiedatasoort MARKTLABEL.
+ marktwaarde:
+ description: De marktwaarden behorende bij de eenheid. Vanaf versie 4.0 wordt dit attribuut in meervoud geschreven
+ type: array
+ items:
+ $ref: '#/components/schemas/Marktwaarde-sleutels'
+ monumenten:
+ description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort EENHEIDMONUMENT.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ nevenadressen:
+ description: De nevenadressen van de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Adres-sleutels'
+ onderhoudslabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het onderhoudslabel geeft aan hoe hoog of laag het onderhoudsniveau van het betreffende eenheid moet zijn. Hierbij wordt rekening gehouden met het soort bewoners en de toekomst van het pand. Referentiedatasoort ONDERHOUDSLABEL.
+ overeenkomsten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ overigeVertrekkenTotaalOppervlakte:
+ type: number
+ format: float
+ description: Het totaal aan oppervlakte van overige vertrekken. Met overige vertrekken worden de ruimtes bedoeld die ook in de categorie overige ruimtes vallen bij het bepalen van de woningwaarderingspunten.
+ panden:
+ description: De panden behorend bij een eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/Pand-sleutels'
+ prestatieafspraken:
+ description: Geeft aan of voor de eenheid een specifieke prestatieafspraak is gemaakt (meestal met een gemeente), bijvoorbeeld over het aanwenden van een extra inkomensafhankelijke huurverhoging voor investeringen. Referentiedatasoort PRESTATIEAFSPRAAK.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ prijscomponenten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Prijscomponent-sleutels in informatiedomein Overeenkomsten
+ prijsconditie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De voorwaarden behorende bij de huur- of koopprijs. Bijv. Kopers Kosten. Referentiedatasoort EENHEIDPRIJSCONDITIE.
+ publicatie:
+ type: string
+ format: uri
+ description: Referentie naar Publicatie-sleutels in informatiedomein Woonruimteverdeling
+ publicatieLabel:
+ type: string
+ format: any
+ description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning, Appartement etc.
+ rekenhuur:
+ type: number
+ format: float
+ description: De subsidiabele huur in euro's die geregistreerd staat bij de eenheid. De subsidiabele huur is het bedrag van de huur dat in aanmerking komt voor huurtoeslag.
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ renovatie:
+ allOf:
+ - $ref: '#/components/schemas/Renovatie-sleutels'
+ description: De details van de laatste renovatie van de eenheid.
+ ruimten:
+ description: De verschillende ruimtes behorend bij de eenheid Bij. 'Achtertuin' of 'Woonkamer'.
+ type: array
+ items:
+ $ref: '#/components/schemas/Ruimte-sleutels'
+ sanitair:
+ description: Sanitaire voorzieningen Referentiedatasoort EENHEIDSANITAIR.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ situering:
+ type: string
+ format: any
+ description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg'
+ streefhuur:
+ type: number
+ format: float
+ description: De netto huur in euro's waarnaar de woningcorporatie streeft.
+ taxaties:
+ description: 'De taxaties van een eenheid. Let op: Voor de waardering van vastgoed ter verantwoording aan AW en WSW (dVi/dPi) worden de waardebegrippen Marktwaarde en Beleidswaarde gebruikt. Dit zijn aparte klassen.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Taxatie-sleutels'
+ toegankelijkheidslabel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
+ totaalInhoud:
+ type: number
+ format: float
+ description: De totale inhoud van de eenheid in m3. Zowel bewoonbare als onbewoonbare vertrekken worden hierbij meegeteld.
+ totaleOppervlakte:
+ type: number
+ format: float
+ description: 'De totale oppervlakte van een eenheid. Vertrekken die niet bewoonbaar zijn, worden hierbij meegeteld. Let op: niet te verwarren met de voor de dVi vereiste "gebruiksoppervlakte".'
+ uitExploitatieReden:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De reden voor het uit exploitatie nemen van een eenheid. Voorbeeld: sloop. Referentiedatasoort UITEXPLOITATIEREDEN.'
+ verkoop:
+ type: boolean
+ description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
+ vertrekken:
+ description: De ruimten behorend bij de eenheid. OBSOLETE
+ type: array
+ items:
+ $ref: '#/components/schemas/Vertrek-sleutels'
+ deprecated: true
+ vertrekkenAantal:
+ type: integer
+ format: int32
+ description: Het aantal vertrekken behorende bij de eenheid.
+ verwarmdeVertrekkenAantal:
+ type: integer
+ format: int32
+ description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
+ volgnummer:
+ type: string
+ format: any
+ description: Het volgnummer van een eenheid, zoals een appartementsaanduiding, of een nummering van garageboxen.
+ voorwaarden:
+ allOf:
+ - $ref: '#/components/schemas/EenheidVoorwaarden-sleutels'
+ description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid. OBSOLETE
+ deprecated: true
+ vraagprijs:
+ type: number
+ format: float
+ description: De vraagprijs voor de verkoop van de eenheid.
+ woningwaarderingResultaat:
+ allOf:
+ - $ref: '#/components/schemas/WoningwaarderingResultaat-sleutels'
+ description: De woningwaardering van de eenheid.
+ Woningwaarderingstelsel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
+ woonvertrekInhoud:
+ type: number
+ format: float
+ description: De inhoud van de eenheid in m3 waarin gewoond kan worden.
+ woonvertrekkenTotaalOppervlakte:
+ type: number
+ format: float
+ description: Het totaal aan oppervlakte van woonvertrekken. Met woonvertrekken worden de ruimtes bedoeld die ook in de categorie woonvertrekken vallen bij het bepalen van de woningwaarderingspunten.
+ woonvorm:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De woonvorm van de eenheid. Bijvoorbeeld groepswonen. Referentiedatasoort WOONVORM.
+ wozEenheden:
+ description: De WOZ eenheden behorend bij de eenheid. Dit zijn de WOZ waarden behorende bij de eenheid.
+ type: array
+ items:
+ $ref: '#/components/schemas/WozEenheid-sleutels'
+ zekerheidVerpandingen:
+ description: De zekerheid verpandingen die horen bij de eenheid. Het bekendste voorbeeld van een zekerheidsverpanding is de hypotheek. Andere voorbeelden zijn pandrechten of het vruchtgebruik (huurpenningen).
+ type: array
+ items:
+ $ref: '#/components/schemas/ZekerheidVerpanding-sleutels'
+ zelfstandig:
+ type: boolean
+ description: Geeft aan of het een zelfstandige of onzelfstandige eenheid betreft. Dit gegeven wordt ook gebruikt bij het bepalen van het woningwaardering volgens het woningwaarderingsstelsel.
+ zorgfaciliteitOmschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de zorgfaciliteit behorende bij de eenheid.
+ AdresseerbaarObjectBasisregistratie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Beleidswaarde-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Eenheidcriterium-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ Energieprestatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Renovatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Ruimte-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Taxatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Vertrek-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ EenheidVoorwaarden-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WoningwaarderingResultaat-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: 'De omschrijving van de situering van de eenheid behorend bij de eenheid. Bijvoorbeeld: Ligt aan drukke weg'
- streefhuur:
- type: number
- format: float
- description: De netto huur in euro's waarnaar de woningcorporatie streeft.
- taxaties:
- description: 'De taxaties van een eenheid. Let op: Voor de waardering van vastgoed ter verantwoording aan AW en WSW (dVi/dPi) worden de waardebegrippen Marktwaarde en Beleidswaarde gebruikt. Dit zijn aparte klassen.'
- type: array
- items:
- $ref: '#/components/schemas/Taxatie'
- toegankelijkheidslabel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
- totaalInhoud:
- type: number
- format: float
- description: De totale inhoud van de eenheid in m3. Zowel bewoonbare als onbewoonbare vertrekken worden hierbij meegeteld.
- totaleOppervlakte:
- type: number
- format: float
- description: 'De totale oppervlakte van een eenheid. Vertrekken die niet bewoonbaar zijn, worden hierbij meegeteld. Let op: niet te verwarren met de voor de dVi vereiste "gebruiksoppervlakte".'
- uitExploitatieReden:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het uit exploitatie nemen van een eenheid. Voorbeeld: sloop. Referentiedatasoort UITEXPLOITATIEREDEN.'
- verkoop:
- type: boolean
- description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
- vertrekken:
- description: De ruimten behorend bij de eenheid. OBSOLETE
- type: array
- items:
- $ref: '#/components/schemas/Vertrek'
- deprecated: true
- vertrekkenAantal:
- type: integer
- format: int32
- description: Het aantal vertrekken behorende bij de eenheid.
- verwarmdeVertrekkenAantal:
- type: integer
- format: int32
- description: Het aantal verwarmde vertrekken van de eenheid.
- volgnummer:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: Het volgnummer van een eenheid, zoals een appartementsaanduiding, of een nummering van garageboxen.
- voorwaarden:
- allOf:
- - $ref: '#/components/schemas/EenheidVoorwaarden'
- description: De voorwaarden waaraan de bewoner moet voldoen om in aanmerking te komen of voorrang te krijgen voor de eenheid. OBSOLETE
- deprecated: true
- vraagprijs:
- type: number
- format: float
- description: De vraagprijs voor de verkoop van de eenheid.
- woningwaarderingResultaat:
- allOf:
- - $ref: '#/components/schemas/WoningwaarderingResultaat'
- description: De woningwaardering van de eenheid.
- Woningwaarderingstelsel:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
- woonvertrekInhoud:
- type: number
- format: float
- description: De inhoud van de eenheid in m3 waarin gewoond kan worden.
- woonvertrekkenTotaalOppervlakte:
- type: number
- format: float
- description: Het totaal aan oppervlakte van woonvertrekken. Met woonvertrekken worden de ruimtes bedoeld die ook in de categorie woonvertrekken vallen bij het bepalen van de woningwaarderingspunten.
- woonvorm:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De woonvorm van de eenheid. Bijvoorbeeld groepswonen. Referentiedatasoort WOONVORM.
- wozEenheden:
- description: De WOZ eenheden behorend bij de eenheid. Dit zijn de WOZ waarden behorende bij de eenheid.
- type: array
- items:
- $ref: '#/components/schemas/WozEenheid'
- zekerheidVerpandingen:
- description: De zekerheid verpandingen die horen bij de eenheid. Het bekendste voorbeeld van een zekerheidsverpanding is de hypotheek. Andere voorbeelden zijn pandrechten of het vruchtgebruik (huurpenningen).
- type: array
- items:
- $ref: '#/components/schemas/ZekerheidVerpanding'
- zelfstandig:
- type: boolean
- description: Geeft aan of het een zelfstandige of onzelfstandige eenheid betreft. Dit gegeven wordt ook gebruikt bij het bepalen van het woningwaardering volgens het woningwaarderingsstelsel.
- zorgfaciliteitOmschrijving:
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
type: string
format: any
- description: De omschrijving van de zorgfaciliteit behorende bij de eenheid.
- Beleidswaardebericht:
- allOf:
- - $ref: '#/components/schemas/Beleidswaarde'
- - $ref: '#/components/schemas/Bericht-basis'
- Beleidswaarde:
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WozEenheid-sleutels:
type: object
properties:
id:
@@ -13014,55 +13621,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- achterstalligOnderhoud:
- type: number
- format: float
- description: Bedrag aan achterstallig onderhoud dat als correctie is toegepast.
- afkoopErfpacht:
- type: number
- format: float
- description: Het bedrag aan afkoop erfpacht dat als correctie is toegepast.
- beheerAfslag:
- type: number
- format: float
- description: 'Beheer (beheer): eventuele extra beheeruitgaven die gepaard gaan met de sociale doelgroep.'
- beheerskosten:
- type: number
- format: float
- description: Beheerkosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
- beschikbaarheidAfslag:
- type: number
- format: float
- description: 'Beschikbaarheid (doorexploiteren): in stand houden van een sociale portefeuille.'
- betaalbaarheidAfslag:
- type: number
- format: float
- description: 'Betaalbaarheid (huur): in stand houden van sociale huurprijzen passend bij de doelgroep.'
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarvoor de beleidswaarde is vastgelegd. Deze relatie is redundant omdat deze ook via de klasse Marktwaarde gelegd wordt (inclusief verslagjaar). Deze redundante relatie is ten behoeve van gemak bij mogelijke rapportages
- kwaliteitAfslag:
- type: number
- format: float
- description: 'Kwaliteit (onderhoud): eventuele extra onderhoudsuitgaven voor het op lange termijn in stand houden van de portefeuille.'
- marktwaarde:
- allOf:
- - $ref: '#/components/schemas/Marktwaarde'
- description: De verwijzing naar de marktwaarde die ten grondslag ligt aan deze beleidswaarde.
- onderhoudskosten:
- type: number
- format: float
- description: Onderhoudskosten op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
- streefhuur:
- type: number
- format: float
- description: Actuele streefhuur op het moment van waarderen zoals toegepast in de beleidswaardeberekening.
- waarde:
- type: number
- format: float
- description: 'De beleidswaarde van de eenheid waarde die rekening houdt met het beleid van de corporatie. Marktwaarde minus de afslagen voor beschikbaarheid, betaalbaarheid, kwaliteit en beheer, vormt de beleidswaarde (bron beleidswaarde WSW). Let op: het verslagjaar waarvoor de beleidswaarde is bepaald is het verslagjaar van de marktwaarde die de grondslag vormt van de beleidswaarde.'
- Eenheid-sleutels:
+ ZekerheidVerpanding-sleutels:
type: object
properties:
id:
@@ -13081,11 +13640,52 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Marktwaardebericht:
+ Eenheidadresbericht:
allOf:
- - $ref: '#/components/schemas/Marktwaarde'
+ - $ref: '#/components/schemas/Eenheidadres'
- $ref: '#/components/schemas/Bericht-basis'
- Marktwaarde:
+ Eenheidadres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-basis'
+ - type: object
+ properties:
+ bag:
+ allOf:
+ - $ref: '#/components/schemas/BagAdres-sleutels'
+ description: De unieke aanduiding van een nummeraanduiding.
+ buurt:
+ allOf:
+ - $ref: '#/components/schemas/Buurt-sleutels'
+ description: De buurt behorend bij het adres.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Gemeente-sleutels'
+ description: De gemeente behorend bij het adres.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van het adres.
+ land:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ provincie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De provincie behorend bij het adres. Referentiedatasoort PROVINCIE.
+ stadsdeel:
+ allOf:
+ - $ref: '#/components/schemas/Stadsdeel-sleutels'
+ description: Het stadsdeel behorend bij het adres.
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De wijk behorend bij het adres.
+ woonplaats:
+ allOf:
+ - $ref: '#/components/schemas/Woonplaats-sleutels'
+ description: De woonplaats waarin het adres zich bevindt.
+ BagAdres-sleutels:
type: object
properties:
id:
@@ -13104,51 +13704,72 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- beheersKosten:
- type: number
- format: float
- description: Beheerkosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
- contractJaarhuur:
- type: number
- format: float
- description: De contractueel afgesproken jaarhuur op het moment van waarderen.
- disconteringsvoet:
- type: number
- format: float
- description: Disconteringsvoet op het moment van waarderen.
- doorexploiterenDisconteringsvoet:
- type: number
- format: float
- description: Disconteringsvoet doorexploiteren op het moment van waarderen.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarvoor de marktwaarde is vastgelegd.
- leegwaarde:
- type: number
- format: float
- description: De geschatte verkoopprijs op basis van de kosten koper, vrij van huur en overige lasten (Handboek MVS).
- marktJaarhuur:
- type: number
- format: float
- description: Actuele markt jaarhuur op het moment van waarderen.
- onderhoudsKosten:
- type: number
- format: float
- description: Onderhoudskosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
- verhuurderheffing:
- type: number
- format: float
- description: De verhuurderheffing voor de volledige DCF-periode. De heffing wordt berekend als een percentage van de WOZ-waarde (Handboek MVS).
- verslagJaar:
- type: integer
- format: int32
- description: Het verslagjaar waarop de marktwaarde bepaling betrekking heeft.
- waarde:
- type: number
- format: float
- description: De vastgestelde taxatiewaarde, ook wel marktwaarde in verhuurde staat.
- CollectiefObject-sleutels:
+ Buurt-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de buurt.
+ Gemeente-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de gemeente.
+ Stadsdeel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Woonplaats-sleutels:
type: object
properties:
id:
@@ -13167,6 +13788,10 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de woonplaats.
Eenheidcriteriumbericht:
allOf:
- $ref: '#/components/schemas/Eenheidcriterium'
@@ -13194,6 +13819,10 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het soort criterium op basis waarvan de woning passend is of waarop men voorang kan krijgen. Referentiedatasoort EENHEIDCRITERIUMDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van het criterium.
aantalBovengrens:
type: number
format: float
@@ -13214,11 +13843,11 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Of het een selectie- of sorteercriterium betreft. Referentiedatasoort EENHEIDCRITERIUMTOEPASSING.
- Energieprestatiebericht:
+ EenheidToestandbericht:
allOf:
- - $ref: '#/components/schemas/Energieprestatie'
+ - $ref: '#/components/schemas/EenheidToestand'
- $ref: '#/components/schemas/Bericht-basis'
- Energieprestatie:
+ EenheidToestand:
type: object
properties:
id:
@@ -13237,52 +13866,31 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
+ status:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort energieprestatie. Bijv. Voorloping Energielabel, Energieprestatieindex etc.. Referentiedatasoort ENERGIEPRESTATIESOORT.
- status:
+ description: De status van de eenheid. Dit kan bijvoorbeeld verhuurd, gesloopt of leeg zijn. Referentiedatasoort EENHEIDSTATUS.
+ detailStatus:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'Geeft de status van de energieprestatie aan: Voorlopig of Definitief. Een voorlopige energieprestatie wordt ook wel "pré-label" genoemd. Een definitieve energieprestatie is afgemeld bij de Rijksoverheid. Referentiedatasoort ENERGIEPRESTATIESTATUS.'
+ description: De status van de eenheid. Dit kan bijvoorbeeld frictieleegstand, mutatieleegstand of reguliere verhuur zijn. Referentiedatasoort EENHEIDDETAILSTATUS.
begindatum:
type: string
format: date
- description: De datum die aangeeft vanaf welk moment de energieprestatie geldt. Indien de energieprestatie is vastgesteld door een adviseur dan is deze datum gelijk aan de opnamedatum. Indien het een voorlopige energieprestatie (pré-label) is dan is de begindatum de datum waarop de energieprestatie is berekend op basis van de beschikbare woningkenmerken. De combinatie van start en einddatum geven een sluitende periode waarin een bepaald energielabel.
+ description: De ingangsdatum van de toestand van de eenheid.
einddatum:
type: string
format: date
- description: De datum die aangeeft tot welk moment de energieprestatie geldig is. Indien de energieprestatie een officiële status heft (afgemeld bij de Rijksoverheid) dan is dit de 'Geldig tot'-datum van de registratie. Indien het een voorlopige energieprestatie is, dan kan de einddatum leeg zijn.
- registratiedatum:
- type: string
- format: date
- description: De datum waarop de energieprestatie is geregistreerd bij de Rijksoverheid. Als sprake is van een voorlopige energieprestatie is geen registratiedatum bekend.
+ description: De einddatum van de toestand van de eenheid.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarop de energielabel van toepassing is.
- index:
- type: number
- format: float
- description: De energieprestatie index van de eenheid. OBSOLETE
- deprecated: true
- label:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het energielabel voor woningen geeft met klassen (A**** tot en met G) en kleuren (groen tot en met rood) aan hoe energiezuinig een huis is ten opzichte van andere soortgelijke woningen. Energielabel A (donkergroen) is zuinig, energielabel G (rood) is onzuinig. Het energielabel is meestal een afgeleide van de waarde van de energieprestatie. Referentiedatasoort ENERGIELABEL.
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- waarde:
- type: string
- format: any
- description: 'De door een adviseur vastgestelde, of afgeleide, waarde die hoort bij de energieprestatie. De waarde is afhankelijk van het soort energieprestatie: een energie-index of een EP2-score. Van deze waarde is het energielabel afgeleid. Als de energieprestatiesoort "Voorlopig energielabel" is, dan is er géén waarde bekend.'
- Gebouwbericht:
+ description: De eenheid waar de toestand voor geldt.
+ EenheidVoorwaardenbericht:
allOf:
- - $ref: '#/components/schemas/Gebouw'
+ - $ref: '#/components/schemas/EenheidVoorwaarden'
- $ref: '#/components/schemas/Bericht-basis'
- Gebouw:
+ EenheidVoorwaarden:
type: object
properties:
id:
@@ -13301,50 +13909,45 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van het gebouw.
- omschrijving:
- type: string
- format: any
- description: De omschrijving van het gebouw.
- bouwdelen:
- description: De bouwdelen behorend bij het gebouw.
- type: array
- items:
- $ref: '#/components/schemas/Bouwdeel-sleutels'
- buurt:
- allOf:
- - $ref: '#/components/schemas/Buurt'
- description: De buurt behorend bij het gebouw.
- corporatieBuurt:
- allOf:
- - $ref: '#/components/schemas/Buurt'
- description: De door de corporatie verzonnen buurt behorend bij het gebouw.
- corporatieWijk:
- allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De door de corporatie verzonnen wijk behorend bij het gebouw.
- eenheden:
- description: sleutels
+ maximumAantalPersonen:
+ type: integer
+ format: int32
+ description: Het maximaal aantal personen waarvoor de eenheid geschikt is.
+ maximuminkomen:
+ type: number
+ format: float
+ description: Het maximuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
+ maximunleeftijd:
+ type: integer
+ format: int32
+ description: De maximumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
+ minimumAantalPersonen:
+ type: integer
+ format: int32
+ description: Het minimum aantal personen waarvoor de eenheid geschikt is.
+ minimuminkomen:
+ type: number
+ format: float
+ description: Het minimuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
+ minimumleeftijd:
+ type: integer
+ format: int32
+ description: De minimumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
+ selectiecriteria:
+ description: De criteria waaraan men moet voldoen om in aanmerking te komen voor deze eenheid. Referentiedatasoort SELECTIECRITERIA.
type: array
items:
- $ref: '#/components/schemas/Eenheid-sleutels'
- panden:
- description: De panden behorend bij het gebouw.
+ $ref: '#/components/schemas/Referentiedata'
+ voorrangscriteria:
+ description: De criteria waaraan men moet voldoen om voorrang te krijgen voor deze eenheid. Referentiedatasoort VOORRANGSCRITERIA.
type: array
items:
- $ref: '#/components/schemas/Pand-sleutels'
- wijk:
- allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De wijk behorend bij het gebouw.
- Buurtbericht:
+ $ref: '#/components/schemas/Referentiedata'
+ Energieprestatiebericht:
allOf:
- - $ref: '#/components/schemas/Buurt'
+ - $ref: '#/components/schemas/Energieprestatie'
- $ref: '#/components/schemas/Bericht-basis'
- Buurt:
+ Energieprestatie:
type: object
properties:
id:
@@ -13363,97 +13966,52 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de buurt.
- omschrijving:
- type: string
- format: any
- description: De omschrijving van de buurt.
- eenheden:
- description: De eenheden behorend bij de buurt.
- type: array
- items:
- $ref: '#/components/schemas/Eenheid-sleutels'
- gebouwen:
- description: De gebouwen behorend bij de buurt.
- type: array
- items:
- $ref: '#/components/schemas/Gebouw-sleutels'
- geometrie:
+ soort:
allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de buurt.
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- wijk:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort energieprestatie. Bijv. Voorloping Energielabel, Energieprestatieindex etc.. Referentiedatasoort ENERGIEPRESTATIESOORT.
+ status:
allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De wijk behorend bij de buurt.
- Gebouw-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Geometrie-basis:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Geeft de status van de energieprestatie aan: Voorlopig of Definitief. Een voorlopige energieprestatie wordt ook wel "pré-label" genoemd. Een definitieve energieprestatie is afgemeld bij de Rijksoverheid. Referentiedatasoort ENERGIEPRESTATIESTATUS.'
+ begindatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
+ format: date
+ description: De datum die aangeeft vanaf welk moment de energieprestatie geldt. Indien de energieprestatie is vastgesteld door een adviseur dan is deze datum gelijk aan de opnamedatum. Indien het een voorlopige energieprestatie (pré-label) is dan is de begindatum de datum waarop de energieprestatie is berekend op basis van de beschikbare woningkenmerken. De combinatie van start en einddatum geven een sluitende periode waarin een bepaald energielabel.
+ einddatum:
type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ format: date
+ description: De datum die aangeeft tot welk moment de energieprestatie geldig is. Indien de energieprestatie een officiële status heft (afgemeld bij de Rijksoverheid) dan is dit de 'Geldig tot'-datum van de registratie. Indien het een voorlopige energieprestatie is, dan kan de einddatum leeg zijn.
+ registratiedatum:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
+ format: date
+ description: De datum waarop de energieprestatie is geregistreerd bij de Rijksoverheid. Als sprake is van een voorlopige energieprestatie is geen registratiedatum bekend.
+ eenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarop de energielabel van toepassing is.
+ index:
+ type: number
+ format: float
+ description: De energieprestatie index van de eenheid. OBSOLETE
+ deprecated: true
+ label:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
- omschrijving:
+ description: Het energielabel voor woningen geeft met klassen (A**** tot en met G) en kleuren (groen tot en met rood) aan hoe energiezuinig een huis is ten opzichte van andere soortgelijke woningen. Energielabel A (donkergroen) is zuinig, energielabel G (rood) is onzuinig. Het energielabel is meestal een afgeleide van de waarde van de energieprestatie. Referentiedatasoort ENERGIELABEL.
+ relatie:
type: string
- format: any
- description: 'De omschrijving van de geometrie. Bijvoorbeeld: Lindelaan 3'
- Geometriebericht:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- - $ref: '#/components/schemas/Bericht-basis'
- Geometrie:
- oneOf:
- - $ref: '#/components/schemas/Punt'
- - $ref: '#/components/schemas/Geometrie-basis'
- Wijkbericht:
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ waarde:
+ type: string
+ format: any
+ description: 'De door een adviseur vastgestelde, of afgeleide, waarde die hoort bij de energieprestatie. De waarde is afhankelijk van het soort energieprestatie: een energie-index of een EP2-score. Van deze waarde is het energielabel afgeleid. Als de energieprestatiesoort "Voorlopig energielabel" is, dan is er géén waarde bekend.'
+ Garantiebericht:
allOf:
- - $ref: '#/components/schemas/Wijk'
+ - $ref: '#/components/schemas/Garantie'
- $ref: '#/components/schemas/Bericht-basis'
- Wijk:
+ Garantie:
type: object
properties:
id:
@@ -13472,65 +14030,56 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de wijk.
omschrijving:
type: string
format: any
- description: De omschrijving van de wijk.
- buurten:
- description: De buurten behorend bij de wijk.
+ description: De omschrijving van de garantie.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum van de garantie.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum van de garantie.
+ bouwdelen:
+ description: De bouwdelen behorend bij de garantie.
type: array
items:
- $ref: '#/components/schemas/Buurt-sleutels'
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de wijk.
- relaties:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ bouwkundigeElementen:
+ description: De bouwkundige elementen behorend bij de garantie.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- stadsdeel:
- allOf:
- - $ref: '#/components/schemas/Stadsdeel'
- description: Het stadsdeel van de wijk.
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- description: De woonplaats waar de wijk deel uit van maakt.
- Buurt-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ $ref: '#/components/schemas/BouwkundigElement-sleutels'
+ clusters:
+ description: De clusters behorend bij de garantie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster-sleutels'
+ collectieveObjecten:
+ description: De collectieve objecten behorend bij de garantie.
+ type: array
+ items:
+ $ref: '#/components/schemas/CollectiefObject-sleutels'
+ eenheden:
+ description: De eenheden behorend bij de garantie.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ overeenkomst:
type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ relatie:
type: string
- format: any
- description: De naam van de buurt.
- Stadsdeelbericht:
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ Gebouwbericht:
allOf:
- - $ref: '#/components/schemas/Stadsdeel'
+ - $ref: '#/components/schemas/Gebouw'
- $ref: '#/components/schemas/Bericht-basis'
- Stadsdeel:
+ Gebouw:
type: object
properties:
id:
@@ -13552,20 +14101,42 @@ components:
naam:
type: string
format: any
- description: De naam van het stadsdeel.
- gemeente:
+ description: De naam van het gebouw.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van het gebouw.
+ bouwdelen:
+ description: De bouwdelen behorend bij het gebouw.
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ buurt:
allOf:
- - $ref: '#/components/schemas/Gemeente'
- description: De gemeente behorend bij het stadsdeel.
- geometrie:
+ - $ref: '#/components/schemas/Buurt-sleutels'
+ description: De buurt behorend bij het gebouw.
+ corporatieBuurt:
allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van het stadsdeel.
- wijken:
- description: De wijken die in het stadsdeel liggen.
+ - $ref: '#/components/schemas/Buurt-sleutels'
+ description: De door de corporatie verzonnen buurt behorend bij het gebouw.
+ corporatieWijk:
+ allOf:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De door de corporatie verzonnen wijk behorend bij het gebouw.
+ eenheden:
+ description: De eenheden behorend bij het gebouw.
type: array
items:
- $ref: '#/components/schemas/Wijk-sleutels'
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ panden:
+ description: De panden behorend bij het gebouw.
+ type: array
+ items:
+ $ref: '#/components/schemas/Pand-sleutels'
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Wijk-sleutels'
+ description: De wijk behorend bij het gebouw.
Gemeentebericht:
allOf:
- $ref: '#/components/schemas/Gemeente'
@@ -13595,7 +14166,7 @@ components:
description: De naam van de gemeente.
geometrie:
allOf:
- - $ref: '#/components/schemas/Geometrie'
+ - $ref: '#/components/schemas/Geometrie-sleutels'
description: De geometrie van de gemeente.
provincie:
allOf:
@@ -13611,34 +14182,11 @@ components:
items:
$ref: '#/components/schemas/Stadsdeel-sleutels'
woonplaatsen:
- description: sleutels
+ description: De woonplaatsen van de gemeente.
type: array
items:
- $ref: '#/components/schemas/Woonplaats'
- Stadsdeel-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Woonplaatsbericht:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- - $ref: '#/components/schemas/Bericht-basis'
- Woonplaats:
+ $ref: '#/components/schemas/Woonplaats-sleutels'
+ Geometrie-basis:
type: object
properties:
id:
@@ -13657,32 +14205,27 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
+ omschrijving:
type: string
format: any
- description: De naam van de woonplaats.
- bag:
- allOf:
- - $ref: '#/components/schemas/BagWoonplaats'
- description: Verwijzing naar de BAG registratie van de woonplaats.
- gemeente:
- allOf:
- - $ref: '#/components/schemas/Gemeente-sleutels'
- description: De gemeente behorend bij de woonplaats.
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van de woonplaats.
- wijken:
- description: De wijken behorend bij de woonplaats.
- type: array
- items:
- $ref: '#/components/schemas/Wijk-sleutels'
- BagWoonplaatsbericht:
+ description: 'De omschrijving van de geometrie. Bijvoorbeeld: Lindelaan 3'
+ Geometriebericht:
allOf:
- - $ref: '#/components/schemas/BagWoonplaats'
+ - $ref: '#/components/schemas/Geometrie'
- $ref: '#/components/schemas/Bericht-basis'
- BagWoonplaats:
+ Geometrie:
+ oneOf:
+ - $ref: '#/components/schemas/Punt'
+ - $ref: '#/components/schemas/Geometrie-basis'
+ KadasterPerceelbericht:
+ allOf:
+ - $ref: '#/components/schemas/KadasterPerceel'
+ - $ref: '#/components/schemas/Bericht-basis'
+ KadasterPerceel:
type: object
properties:
id:
@@ -13701,21 +14244,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bagIdentificatie:
- type: string
- format: any
- description: De landelijk unieke aanduiding van een woonplaats, zoals vastgesteld door de beheerder van de landelijke tabel voor woonplaatsen.
- bagStatus:
- type: string
- format: any
- description: De fase van de levenscyclus van een woonplaats, waarin de betreffende woonplaats zich bevindt.
- bagInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- Gemeente-sleutels:
+ Marktwaardebericht:
+ allOf:
+ - $ref: '#/components/schemas/Marktwaarde'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Marktwaarde:
type: object
properties:
id:
@@ -13734,11 +14267,55 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de gemeente.
- Wijk-sleutels:
+ beheersKosten:
+ type: number
+ format: float
+ description: Beheerkosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
+ contractJaarhuur:
+ type: number
+ format: float
+ description: De contractueel afgesproken jaarhuur op het moment van waarderen.
+ disconteringsvoet:
+ type: number
+ format: float
+ description: Disconteringsvoet op het moment van waarderen.
+ doorexploiterenDisconteringsvoet:
+ type: number
+ format: float
+ description: Disconteringsvoet doorexploiteren op het moment van waarderen.
+ eenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarvoor de marktwaarde is vastgelegd.
+ leegwaarde:
+ type: number
+ format: float
+ description: De geschatte verkoopprijs op basis van de kosten koper, vrij van huur en overige lasten (Handboek MVS).
+ marktJaarhuur:
+ type: number
+ format: float
+ description: Actuele markt jaarhuur op het moment van waarderen.
+ onderhoudsKosten:
+ type: number
+ format: float
+ description: Onderhoudskosten op het moment van waarderen zoals toegepast in de martkwaardeberekening.
+ verhuurderheffing:
+ type: number
+ format: float
+ description: De verhuurderheffing voor de volledige DCF-periode. De heffing wordt berekend als een percentage van de WOZ-waarde (Handboek MVS).
+ verslagJaar:
+ type: integer
+ format: int32
+ description: Het verslagjaar waarop de marktwaarde bepaling betrekking heeft.
+ waarde:
+ type: number
+ format: float
+ description: De vastgestelde taxatiewaarde, ook wel marktwaarde in verhuurde staat.
+ Pandbericht:
+ allOf:
+ - $ref: '#/components/schemas/Pand'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Pand:
type: object
properties:
id:
@@ -13757,11 +14334,49 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
- type: string
- format: any
- description: De naam van de wijk.
- Pand-sleutels:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het pand volgens de eigenaar. Referentiedatasoort PANDSTATUS.
+ adresseerbareObjectenBasisregistratie:
+ description: De adresseerbare objecten uit de basisregistratie behorend bij het pand.
+ type: array
+ items:
+ $ref: '#/components/schemas/AdresseerbaarObjectBasisregistratie-sleutels'
+ bag:
+ allOf:
+ - $ref: '#/components/schemas/BagPand-sleutels'
+ description: Verwijzing naar de BAG details behorende bij het pand.
+ bouwdelen:
+ description: De bouwdelen behorend bij het pand.
+ type: array
+ items:
+ $ref: '#/components/schemas/Bouwdeel-sleutels'
+ eenheden:
+ description: De eenheden behorend bij het pand. De eenheden zijn onderdeel van het pand.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheid-sleutels'
+ gebouw:
+ allOf:
+ - $ref: '#/components/schemas/Gebouw-sleutels'
+ description: Het gebouw behorend bij het pand.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van het pand.
+ kavelOppervlakte:
+ type: number
+ format: float
+ description: De oppervlakte van het kavel van het pand.
+ liftAanwezig:
+ type: boolean
+ description: De aanduiding geeft aan of in het pand in lift aanwezig is.
+ renovatie:
+ allOf:
+ - $ref: '#/components/schemas/Renovatie-sleutels'
+ description: Verwijzing naar de laatste renovatie details van het pand.
+ BagPand-sleutels:
type: object
properties:
id:
@@ -13780,6 +14395,44 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Postadresbericht:
+ allOf:
+ - $ref: '#/components/schemas/Postadres'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Postadres:
+ allOf:
+ - $ref: '#/components/schemas/Adres-basis'
+ - type: object
+ properties:
+ antwoordnummer:
+ type: string
+ format: any
+ description: Het antwoordnummer behorende bij het adres.
+ postbusnummer:
+ type: string
+ format: any
+ description: Het postbusnummer behorende bij het adres.
+ woonplaats:
+ allOf:
+ - $ref: '#/components/schemas/Woonplaats-sleutels'
+ description: De woonplaats waarin het adres zich bevindt.
+ Puntbericht:
+ allOf:
+ - $ref: '#/components/schemas/Punt'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Punt:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-basis'
+ - type: object
+ properties:
+ breedtegraad:
+ type: number
+ format: float
+ description: De breedtegraad.
+ lengtegraad:
+ type: number
+ format: float
+ description: De lengtegraad.
Renovatiebericht:
allOf:
- $ref: '#/components/schemas/Renovatie'
@@ -13867,55 +14520,16 @@ components:
ligging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De ligging van de ruimte. Referentiedatasoort EENHEIDLIGGINGRUIMTE.
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
oppervlakte:
type: number
format: float
description: De oppervlakte van de ruimte
- Taxatiebericht:
- allOf:
- - $ref: '#/components/schemas/Taxatie'
- - $ref: '#/components/schemas/Bericht-basis'
- Taxatie:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'De soort taxatie die heeft plaatsgevonden. Bijvoorbeeld: geveltaxatie of volledige taxatie. Referentiedatasoort TAXATIESOORT.'
- datum:
- type: string
- format: date
- description: De datum waarop de taxatie heeft plaatsgevonden.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarvoor de taxatie heeft plaatsgevonden.
- waarde:
- type: number
- format: float
- description: De taxatiewaarde van de getaxeerde eenheid.
- Vertrekbericht:
+ Stadsdeelbericht:
allOf:
- - $ref: '#/components/schemas/Vertrek'
+ - $ref: '#/components/schemas/Stadsdeel'
- $ref: '#/components/schemas/Bericht-basis'
- Vertrek:
+ Stadsdeel:
type: object
properties:
id:
@@ -13934,92 +14548,28 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het soort ruimte. Ruimtes worden verdeeld in vertrekken die meetellen voor de woningwaardering, buitenruimtes en overige ruimtes. Referentiedatasoort RUIMTESOORT.
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het detailsoort van de ruimte. Bijv. Slaapkamer, Dakteras, Tuin etc. Referentiedatasoort RUIMTEDETAILSOORT.
naam:
type: string
format: any
- description: De omschrijving van de ruimte.
- eenheid:
+ description: De naam van het stadsdeel.
+ gemeente:
allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de ruimte.
- inhoud:
- type: number
- format: float
- description: De inhoud van de ruimte in m3.
- oppervlakte:
- type: number
- format: float
- description: De oppervlakte van de ruimte
- EenheidVoorwaardenbericht:
- allOf:
- - $ref: '#/components/schemas/EenheidVoorwaarden'
- - $ref: '#/components/schemas/Bericht-basis'
- EenheidVoorwaarden:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- maximumAantalPersonen:
- type: integer
- format: int32
- description: Het maximaal aantal personen waarvoor de eenheid geschikt is.
- maximuminkomen:
- type: number
- format: float
- description: Het maximuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
- maximunleeftijd:
- type: integer
- format: int32
- description: De maximumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
- minimumAantalPersonen:
- type: integer
- format: int32
- description: Het minimum aantal personen waarvoor de eenheid geschikt is.
- minimuminkomen:
- type: number
- format: float
- description: Het minimuminkomen dat de bewoner moet hebben om in aanmerking te komen voor de eenheid.
- minimumleeftijd:
- type: integer
- format: int32
- description: De minimumleeftijd waaraan de bewoner moet voldoen om in aanmerking te komen voor de eenheid.
- selectiecriteria:
- description: De criteria waaraan men moet voldoen om in aanmerking te komen voor deze eenheid. Referentiedatasoort SELECTIECRITERIA.
- type: array
- items:
- $ref: '#/components/schemas/Referentiedata'
- voorrangscriteria:
- description: De criteria waaraan men moet voldoen om voorrang te krijgen voor deze eenheid. Referentiedatasoort VOORRANGSCRITERIA.
+ - $ref: '#/components/schemas/Gemeente-sleutels'
+ description: De gemeente behorend bij het stadsdeel.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van het stadsdeel.
+ wijken:
+ description: De wijken die in het stadsdeel liggen.
type: array
items:
- $ref: '#/components/schemas/Referentiedata'
- WoningwaarderingResultaatbericht:
+ $ref: '#/components/schemas/Wijk-sleutels'
+ Taxatiebericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingResultaat'
+ - $ref: '#/components/schemas/Taxatie'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingResultaat:
+ Taxatie:
type: object
properties:
id:
@@ -14038,40 +14588,27 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date
- description: De begindatum van de woningwaardering puntentotaal.
- einddatum:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'De soort taxatie die heeft plaatsgevonden. Bijvoorbeeld: geveltaxatie of volledige taxatie. Referentiedatasoort TAXATIESOORT.'
+ datum:
type: string
format: date
- description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
+ description: De datum waarop de taxatie heeft plaatsgevonden.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de woningwaardering.
- groepen:
- description: De woningwaarderingenGroep behorend bij het woningwaardering puntentotaal.
- type: array
- items:
- $ref: '#/components/schemas/WoningwaarderingGroep'
- maximaleHuur:
- type: number
- format: float
- description: De maximaal redelijke huur in euro's die geregistreerd staat bij de eenheid. De maximale huur is de huurprijs die gevraagd kan worden voor de eenheid op basis van de woningwaarderingspunten.
- opslagpercentage:
- type: number
- format: float
- description: Het percentage dat boven de maximale huurprijs op basis van punten mag worden gerekend. Bijvoorbeeld bij specifieke monumenten binnen stads of dorpsgezichten van voor 1945 waarbij de corporatie extra onderhoud pleegt aan het monument.
- punten:
+ description: De eenheid waarvoor de taxatie heeft plaatsgevonden.
+ waarde:
type: number
format: float
- description: Het aantal woningwaarderingsstelsel punten dat is toegekend.
- WoningwaarderingGroepbericht:
+ description: De taxatiewaarde van de getaxeerde eenheid.
+ Vertrekbericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingGroep'
+ - $ref: '#/components/schemas/Vertrek'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingGroep:
+ Vertrek:
type: object
properties:
id:
@@ -14090,36 +14627,35 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date
- description: De begindatum van de woningwaardering groep.
- einddatum:
- type: string
- format: date
- description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
- criteriumGroep:
+ soort:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep'
- description: De woningwaardering criterium groep behorend bij de woningwaardering groep.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort ruimte. Ruimtes worden verdeeld in vertrekken die meetellen voor de woningwaardering, buitenruimtes en overige ruimtes. Referentiedatasoort RUIMTESOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het detailsoort van de ruimte. Bijv. Slaapkamer, Dakteras, Tuin etc. Referentiedatasoort RUIMTEDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De omschrijving van de ruimte.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de woningwaardering.
- punten:
+ description: De eenheid behorend bij de ruimte.
+ inhoud:
type: number
format: float
- description: De som van het aantal punten dat is toegekend aan de onderliggende Woningwaarderingen.
- woningwaarderingen:
- description: sleutels
- type: array
- items:
- $ref: '#/components/schemas/Woningwaardering'
- WoningwaarderingCriteriumGroepbericht:
+ description: De inhoud van de ruimte in m3.
+ oppervlakte:
+ type: number
+ format: float
+ description: De oppervlakte van de ruimte
+ Wijkbericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep'
+ - $ref: '#/components/schemas/Wijk'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingCriteriumGroep:
+ Wijk:
type: object
properties:
id:
@@ -14141,34 +14677,39 @@ components:
naam:
type: string
format: any
- description: De naam van de groep.
+ description: De naam van de wijk.
omschrijving:
type: string
format: any
- description: De omschrijving van de groep.
- criteria:
- description: De woningwaardering criteria behorend bij de woningwaardering criterium groep.
+ description: De omschrijving van de wijk.
+ buurten:
+ description: De buurten behorend bij de wijk.
type: array
items:
- $ref: '#/components/schemas/WoningwaarderingCriterium'
- soort:
+ $ref: '#/components/schemas/Buurt-sleutels'
+ geometrie:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. OBSOLETE. Referentiedatasoort WONINGWAARDERINGCRITERIUMGROEPSOORT.
- deprecated: true
- stelsel:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de wijk.
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ stadsdeel:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
- stelselgroep:
+ - $ref: '#/components/schemas/Stadsdeel-sleutels'
+ description: Het stadsdeel van de wijk.
+ woonplaats:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. Referentiedatasoort WONINGWAARDERINGSTELSELGROEP.
- WoningwaarderingCriteriumbericht:
+ - $ref: '#/components/schemas/Woonplaats-sleutels'
+ description: De woonplaats waar de wijk deel uit van maakt.
+ Woningwaarderingbericht:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriterium'
+ - $ref: '#/components/schemas/Woningwaardering'
- $ref: '#/components/schemas/Bericht-basis'
- WoningwaarderingCriterium:
+ Woningwaardering:
type: object
properties:
id:
@@ -14187,23 +14728,35 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- naam:
+ begindatum:
type: string
- format: any
- description: De naam van het woningwaardering element.
- criteriumGroep:
+ format: date
+ description: De datum waarop het woning waardering onderdeel in gaat of is ingegaan.
+ einddatum:
+ type: string
+ format: date
+ description: De datum waarop het woningwaardering onderdeel niet meer van toepassing is.
+ aantal:
+ type: number
+ format: float
+ description: Het aantal van de opgegeven meeteenheid van de bijbehorende woningwaardering criterium.
+ criterium:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep-sleutels'
- description: De groep waarbij de woningwaardering criterium bij hoort.
- meeteenheid:
+ - $ref: '#/components/schemas/WoningwaarderingCriterium-sleutels'
+ description: De omschrijving van het woningwaardering onderdeel.
+ eenheid:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De meeteenheid waarmee het criterium wordt aangeduid. Referentiedatasoort MEETEENHEID.
- stelsel:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid die is gewaardeerd.
+ groep:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
- WoningwaarderingCriteriumGroep-sleutels:
+ - $ref: '#/components/schemas/WoningwaarderingGroep-sleutels'
+ description: De woningwaardering groep behorend bij de woningwaardering.
+ punten:
+ type: number
+ format: float
+ description: Het aantal punten dat is toegekend op basis van het opgegeven aantal, voor de betreffende woningwaardering. Voor bepaalde woningwaarderingGroepen binnen een woningwaarderingstelsel geldt dat het aantal punten op groepsniveau bepaald wordt. In die gevallen kan het attribuut aantal punten in deze klasse leeg blijven
+ WoningwaarderingCriterium-sleutels:
type: object
properties:
id:
@@ -14222,11 +14775,30 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Woningwaarderingbericht:
+ WoningwaarderingGroep-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WoningwaarderingCriteriumbericht:
allOf:
- - $ref: '#/components/schemas/Woningwaardering'
+ - $ref: '#/components/schemas/WoningwaarderingCriterium'
- $ref: '#/components/schemas/Bericht-basis'
- Woningwaardering:
+ WoningwaarderingCriterium:
type: object
properties:
id:
@@ -14245,35 +14817,23 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- begindatum:
- type: string
- format: date
- description: De datum waarop het woning waardering onderdeel in gaat of is ingegaan.
- einddatum:
+ naam:
type: string
- format: date
- description: De datum waarop het woningwaardering onderdeel niet meer van toepassing is.
- aantal:
- type: number
- format: float
- description: Het aantal van de opgegeven meeteenheid van de bijbehorende woningwaardering criterium.
- criterium:
+ format: any
+ description: De naam van het woningwaardering element.
+ criteriumGroep:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingCriterium'
- description: De omschrijving van het woningwaardering onderdeel.
- eenheid:
+ - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep-sleutels'
+ description: De groep waarbij de woningwaardering criterium bij hoort.
+ meeteenheid:
allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid die is gewaardeerd.
- groep:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De meeteenheid waarmee het criterium wordt aangeduid. Referentiedatasoort MEETEENHEID.
+ stelsel:
allOf:
- - $ref: '#/components/schemas/WoningwaarderingGroep-sleutels'
- description: De woningwaardering groep behorend bij de woningwaardering.
- punten:
- type: number
- format: float
- description: Het aantal punten dat is toegekend op basis van het opgegeven aantal, voor de betreffende woningwaardering. Voor bepaalde woningwaarderingGroepen binnen een woningwaarderingstelsel geldt dat het aantal punten op groepsniveau bepaald wordt. In die gevallen kan het attribuut aantal punten in deze klasse leeg blijven
- WoningwaarderingGroep-sleutels:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
+ WoningwaarderingCriteriumGroep-sleutels:
type: object
properties:
id:
@@ -14292,11 +14852,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- WozEenheidbericht:
+ WoningwaarderingCriteriumGroepbericht:
allOf:
- - $ref: '#/components/schemas/WozEenheid'
+ - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep'
- $ref: '#/components/schemas/Bericht-basis'
- WozEenheid:
+ WoningwaarderingCriteriumGroep:
type: object
properties:
id:
@@ -14315,23 +14875,37 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid behorend bij de WOZ eenheid. De WOZ gegevens die in het WOZEenheid object worden ingevoerd hebben betrekking op de eenheid die is aangegeven voor dit attribuut.
- vastgesteldeWaarde:
- type: number
- format: float
- description: De WOZ waarde in euro's die eventueel wordt doorberekend aan de eenheid.
- waardepeildatum:
+ naam:
type: string
- format: date
- description: De datum waarop de WOZ waarde is vastgesteld.
- ZekerheidVerpandingbericht:
+ format: any
+ description: De naam van de groep.
+ omschrijving:
+ type: string
+ format: any
+ description: De omschrijving van de groep.
+ criteria:
+ description: De woningwaardering criteria behorend bij de woningwaardering criterium groep.
+ type: array
+ items:
+ $ref: '#/components/schemas/WoningwaarderingCriterium-sleutels'
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. OBSOLETE. Referentiedatasoort WONINGWAARDERINGCRITERIUMGROEPSOORT.
+ deprecated: true
+ stelsel:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het woningwaardering stelsel geeft aan welk puntensysteem voor de eenheid van toepassing is: het puntensysteem voor zelfstandige woonruimten, het puntensysteem voor onzelfstandige woonruimten, of het puntensysteem voor woonwagens en standplaatsen. Referentiedatasoort WONINGWAARDERINGSTELSEL.'
+ stelselgroep:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De naam van de groep binnen het woningwaarderingsstelsel, zoals beschreven in het Besluit huurprijzen woonruimte. Referentiedatasoort WONINGWAARDERINGSTELSELGROEP.
+ WoningwaarderingGroepbericht:
allOf:
- - $ref: '#/components/schemas/ZekerheidVerpanding'
+ - $ref: '#/components/schemas/WoningwaarderingGroep'
- $ref: '#/components/schemas/Bericht-basis'
- ZekerheidVerpanding:
+ WoningwaarderingGroep:
type: object
properties:
id:
@@ -14350,40 +14924,32 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort of type zekerheid dat op de eenheid is gevestigd. Bijvoorbeeld Hypotheek of Pandrecht huurpenningen. Referentiedatasoort ZEKERHEIDVERPANDINGSOORT.
begindatum:
type: string
format: date
- description: De begindatum die aangeeft wanneer de zekerheid is afgegeven.
+ description: De begindatum van de woningwaardering groep.
einddatum:
type: string
format: date
- description: De einddatum die aangeeft wanneer de zekerheid is ingetrokken of opgeheven.
- akteSoort:
+ description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
+ criteriumGroep:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Soort akte waarmee de zekerheid is gevestigd. (Notarieel of onderhands) Referentiedatasoort AKTESOORT.
- belastingdienstRegistratiedatum:
- type: string
- format: date
- description: 'In het geval van een onderhandse akte: de datum van registratie bij de belastingdienst.'
+ - $ref: '#/components/schemas/WoningwaarderingCriteriumGroep-sleutels'
+ description: De woningwaardering criterium groep behorend bij de woningwaardering groep.
eenheid:
allOf:
- $ref: '#/components/schemas/Eenheid-sleutels'
- description: De eenheid waarop de zekerheid is verleend.
- onderpandWSW:
- type: boolean
- description: Is de eenheid als onderpand ingebracht bij het WSW?
- relaties:
+ description: De eenheid behorend bij de woningwaardering.
+ punten:
+ type: number
+ format: float
+ description: De som van het aantal punten dat is toegekend aan de onderliggende Woningwaarderingen.
+ woningwaarderingen:
+ description: De woningwaarderingen behorend bij de woningwaardering groep.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- Garantie-sleutels:
+ $ref: '#/components/schemas/Woningwaardering-sleutels'
+ Woningwaardering-sleutels:
type: object
properties:
id:
@@ -14402,11 +14968,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Conditiemetingbericht:
+ WoningwaarderingResultaatbericht:
allOf:
- - $ref: '#/components/schemas/Conditiemeting'
+ - $ref: '#/components/schemas/WoningwaarderingResultaat'
- $ref: '#/components/schemas/Bericht-basis'
- Conditiemeting:
+ WoningwaarderingResultaat:
type: object
properties:
id:
@@ -14428,20 +14994,37 @@ components:
begindatum:
type: string
format: date
- description: De begindatum die aangeeft wanneer de conditiescore is bepaald. De combinatie van start en einddatum geven een sluitende periode waarin een bepaalde conditiescore geldig is.
+ description: De begindatum van de woningwaardering puntentotaal.
einddatum:
type: string
format: date
- description: De einddatum die aangeeft tot wanneer de conditiescore geldig is. Als de einddatum niet beschikbaar is, dan hoeft dit niet opgegeven worden en is de conditiescore voor onbepaalde tijd geldig.
- conditiescore:
+ description: De einddatum waarop de waarop de woningwaardering niet meer geldig is.
+ eenheid:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De conditiescore uit de NEN 2767. Bijvoorbeeld score 1 voor uitstekende conditie, 4 voor matige conditie. Referentiedatasoort CONDITIESCORE.
- BagAdresbericht:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid behorend bij de woningwaardering.
+ groepen:
+ description: De woningwaarderingenGroep behorend bij het woningwaardering puntentotaal.
+ type: array
+ items:
+ $ref: '#/components/schemas/WoningwaarderingGroep-sleutels'
+ maximaleHuur:
+ type: number
+ format: float
+ description: De maximaal redelijke huur in euro's die geregistreerd staat bij de eenheid. De maximale huur is de huurprijs die gevraagd kan worden voor de eenheid op basis van de woningwaarderingspunten.
+ opslagpercentage:
+ type: number
+ format: float
+ description: Het percentage dat boven de maximale huurprijs op basis van punten mag worden gerekend. Bijvoorbeeld bij specifieke monumenten binnen stads of dorpsgezichten van voor 1945 waarbij de corporatie extra onderhoud pleegt aan het monument.
+ punten:
+ type: number
+ format: float
+ description: Het aantal woningwaarderingsstelsel punten dat is toegekend.
+ Woonplaatsbericht:
allOf:
- - $ref: '#/components/schemas/BagAdres'
+ - $ref: '#/components/schemas/Woonplaats'
- $ref: '#/components/schemas/Bericht-basis'
- BagAdres:
+ Woonplaats:
type: object
properties:
id:
@@ -14460,113 +15043,51 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- bagNummeraanduidingIdentificatie:
+ naam:
type: string
format: any
- description: De unieke aanduiding van een nummeraanduiding.
- bagOpenbareRuimteIdentificatie:
+ description: De naam van de woonplaats.
+ bag:
+ allOf:
+ - $ref: '#/components/schemas/BagWoonplaats-sleutels'
+ description: Verwijzing naar de BAG registratie van de woonplaats.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Gemeente-sleutels'
+ description: De gemeente behorend bij de woonplaats.
+ geometrie:
+ allOf:
+ - $ref: '#/components/schemas/Geometrie-sleutels'
+ description: De geometrie van de woonplaats.
+ wijken:
+ description: De wijken behorend bij de woonplaats.
+ type: array
+ items:
+ $ref: '#/components/schemas/Wijk-sleutels'
+ BagWoonplaats-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De unieke aanduiding van een openbare ruimte.
- bagNummeraanduidingInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagNummeraanduidingOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- bagNummeraanduidingStatus:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
type: string
format: any
- description: De fase van de levenscyclus van een nummeraanduiding, waarin de betreffende nummeraanduiding zich bevindt.
- bagOpenbareRuimteInOnderzoek:
- type: boolean
- description: De aanduiding waarmee wordt aangegeven dat een onderzoek wordt uitgevoerd naar de juistheid van een of meerdere gegevens van het betreffende object.
- bagOpenbareruimteOfficieel:
- type: boolean
- description: De aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake is van een formele grondslag voor deze opname.
- bagOpenbareruimtestatus:
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
type: string
format: any
- description: De fase van de levenscyclus van een openbare ruimte, waarin de betreffende openbare ruimte zich bevindt.
- BuitenlandsAdresbericht:
- allOf:
- - $ref: '#/components/schemas/BuitenlandsAdres'
- - $ref: '#/components/schemas/Bericht-basis'
- BuitenlandsAdres:
- allOf:
- - $ref: '#/components/schemas/Adres-basis'
- - type: object
- properties:
- adresregel1:
- type: string
- format: any
- description: Adresregel in verband met een buitenlands adres.
- adresregel2:
- type: string
- format: any
- description: Adresregel in verband met een buitenlands adres.
- land:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
- postbusnummer:
- type: string
- format: any
- description: Het postbusnummer behorende bij het adres
- provincie:
- type: string
- format: any
- description: De provincie behorend bij het adres.
- woonplaats:
- type: string
- format: any
- description: De woonplaats waarin het adres zich bevindt.
- Eenheidadresbericht:
- allOf:
- - $ref: '#/components/schemas/Eenheidadres'
- - $ref: '#/components/schemas/Bericht-basis'
- Eenheidadres:
- allOf:
- - $ref: '#/components/schemas/Adres-basis'
- - type: object
- properties:
- bag:
- allOf:
- - $ref: '#/components/schemas/BagAdres'
- description: De unieke aanduiding van een nummeraanduiding.
- buurt:
- allOf:
- - $ref: '#/components/schemas/Buurt'
- description: De buurt behorend bij het adres.
- gemeente:
- allOf:
- - $ref: '#/components/schemas/Gemeente'
- description: De gemeente behorend bij het adres.
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Geometrie'
- description: De geometrie van het adres.
- land:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
- provincie:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De provincie behorend bij het adres. Referentiedatasoort PROVINCIE.
- wijk:
- allOf:
- - $ref: '#/components/schemas/Wijk'
- description: De wijk behorend bij het adres.
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- description: De woonplaats waarin het adres zich bevindt.
- EenheidToestandbericht:
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ WozEenheidbericht:
allOf:
- - $ref: '#/components/schemas/EenheidToestand'
+ - $ref: '#/components/schemas/WozEenheid'
- $ref: '#/components/schemas/Bericht-basis'
- EenheidToestand:
+ WozEenheid:
type: object
properties:
id:
@@ -14585,31 +15106,23 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de eenheid. Dit kan bijvoorbeeld verhuurd, gesloopt of leeg zijn. Referentiedatasoort EENHEIDSTATUS.
- detailStatus:
+ eenheid:
allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de eenheid. Dit kan bijvoorbeeld frictieleegstand, mutatieleegstand of reguliere verhuur zijn. Referentiedatasoort EENHEIDDETAILSTATUS.
- begindatum:
- type: string
- format: date
- description: De ingangsdatum van de toestand van de eenheid.
- einddatum:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid behorend bij de WOZ eenheid. De WOZ gegevens die in het WOZEenheid object worden ingevoerd hebben betrekking op de eenheid die is aangegeven voor dit attribuut.
+ vastgesteldeWaarde:
+ type: number
+ format: float
+ description: De WOZ waarde in euro's die eventueel wordt doorberekend aan de eenheid.
+ waardepeildatum:
type: string
format: date
- description: De einddatum van de toestand van de eenheid.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheid'
- description: De eenheid waar de toestand voor geldt.
- KadasterPerceelbericht:
+ description: De datum waarop de WOZ waarde is vastgesteld.
+ ZekerheidVerpandingbericht:
allOf:
- - $ref: '#/components/schemas/KadasterPerceel'
+ - $ref: '#/components/schemas/ZekerheidVerpanding'
- $ref: '#/components/schemas/Bericht-basis'
- KadasterPerceel:
+ ZekerheidVerpanding:
type: object
properties:
id:
@@ -14628,44 +15141,39 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Postadresbericht:
- allOf:
- - $ref: '#/components/schemas/Postadres'
- - $ref: '#/components/schemas/Bericht-basis'
- Postadres:
- allOf:
- - $ref: '#/components/schemas/Adres-basis'
- - type: object
- properties:
- antwoordnummer:
- type: string
- format: any
- description: Het antwoordnummer behorende bij het adres.
- postbusnummer:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort of type zekerheid dat op de eenheid is gevestigd. Bijvoorbeeld Hypotheek of Pandrecht huurpenningen. Referentiedatasoort ZEKERHEIDVERPANDINGSOORT.
+ begindatum:
+ type: string
+ format: date
+ description: De begindatum die aangeeft wanneer de zekerheid is afgegeven.
+ einddatum:
+ type: string
+ format: date
+ description: De einddatum die aangeeft wanneer de zekerheid is ingetrokken of opgeheven.
+ akteSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Soort akte waarmee de zekerheid is gevestigd. (Notarieel of onderhands) Referentiedatasoort AKTESOORT.
+ belastingdienstRegistratiedatum:
+ type: string
+ format: date
+ description: 'In het geval van een onderhandse akte: de datum van registratie bij de belastingdienst.'
+ eenheid:
+ allOf:
+ - $ref: '#/components/schemas/Eenheid-sleutels'
+ description: De eenheid waarop de zekerheid is verleend.
+ onderpandWSW:
+ type: boolean
+ description: Is de eenheid als onderpand ingebracht bij het WSW?
+ relaties:
+ type: array
+ items:
type: string
- format: any
- description: Het postbusnummer behorende bij het adres.
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Woonplaats'
- description: De woonplaats waarin het adres zich bevindt.
- Puntbericht:
- allOf:
- - $ref: '#/components/schemas/Punt'
- - $ref: '#/components/schemas/Bericht-basis'
- Punt:
- allOf:
- - $ref: '#/components/schemas/Geometrie-basis'
- - type: object
- properties:
- breedtegraad:
- type: number
- format: float
- description: De breedtegraad.
- lengtegraad:
- type: number
- format: float
- description: De lengtegraad.
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
Bericht-basis:
type: object
properties:
diff --git a/docs/Informatiedomeinen/Woonruimteverdeling.yaml b/docs/Informatiedomeinen/Woonruimteverdeling.yaml
index 9736a9c..1fbef1a 100644
--- a/docs/Informatiedomeinen/Woonruimteverdeling.yaml
+++ b/docs/Informatiedomeinen/Woonruimteverdeling.yaml
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '4.1.0+230422.8'
+ version: '4.1.1+230512.44'
servers:
- url: https://woonruimteverdeling.vera.io:{port}/{basePath}
description: Productieserver
@@ -57,7 +57,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -73,7 +73,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Ophalen van Aanbiedingen
+ summary: Ophalen van Aanbiedingen
operationId: listAanbiedingen
parameters:
- name: params
@@ -123,7 +123,7 @@ paths:
post:
tags:
- 'Aanbiedingen'
- description: Voegt een nieuw(e) Aanbieding toe.
+ summary: Voegt een nieuw(e) Aanbieding toe.
operationId: createAanbieding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -163,7 +163,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Vervangen van een Aanbieding op basis van overeenkomstige sleutelvelden.
operationId: replaceAanbieding
parameters:
@@ -198,7 +198,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aanbieding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAanbieding
@@ -235,7 +235,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Retourneert een Aanbieding met de gegeven identifier
+ summary: Retourneert een Aanbieding met de gegeven identifier
operationId: readAanbiedingById
parameters:
- name: id
@@ -272,7 +272,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: Vervangen van een Aanbieding
+ summary: Vervangen van een Aanbieding
operationId: replaceAanbiedingById
parameters:
- name: 'id'
@@ -310,7 +310,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: Wijzigen van een Aanbieding
+ summary: Wijzigen van een Aanbieding
operationId: updateAanbiedingById
parameters:
- name: 'id'
@@ -349,7 +349,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Ophalen van Gebeurtenissen
+ summary: Ophalen van Gebeurtenissen
operationId: listGebeurtenissen
parameters:
- name: params
@@ -399,7 +399,7 @@ paths:
post:
tags:
- 'Gebeurtenissen'
- description: Voegt een nieuw(e) Gebeurtenis toe.
+ summary: Voegt een nieuw(e) Gebeurtenis toe.
operationId: createGebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -439,7 +439,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Vervangen van een Gebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replaceGebeurtenis
parameters:
@@ -474,7 +474,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGebeurtenis
@@ -511,7 +511,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Retourneert een Gebeurtenis met de gegeven identifier
+ summary: Retourneert een Gebeurtenis met de gegeven identifier
operationId: readGebeurtenisById
parameters:
- name: id
@@ -548,7 +548,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: Vervangen van een Gebeurtenis
+ summary: Vervangen van een Gebeurtenis
operationId: replaceGebeurtenisById
parameters:
- name: 'id'
@@ -586,7 +586,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: Wijzigen van een Gebeurtenis
+ summary: Wijzigen van een Gebeurtenis
operationId: updateGebeurtenisById
parameters:
- name: 'id'
@@ -625,7 +625,7 @@ paths:
get:
tags:
- 'HuidigeGebruikers'
- description: Ophalen van HuidigeGebruikers
+ summary: Ophalen van HuidigeGebruikers
operationId: listHuidigeGebruikers
parameters:
- name: params
@@ -675,7 +675,7 @@ paths:
post:
tags:
- 'HuidigeGebruikers'
- description: Voegt een nieuw(e) HuidigeGebruiker toe.
+ summary: Voegt een nieuw(e) HuidigeGebruiker toe.
operationId: createHuidigeGebruiker
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -715,7 +715,7 @@ paths:
put:
tags:
- 'HuidigeGebruikers'
- description: |
+ summary: |
Vervangen van een HuidigeGebruiker op basis van overeenkomstige sleutelvelden.
operationId: replaceHuidigeGebruiker
parameters:
@@ -750,7 +750,7 @@ paths:
patch:
tags:
- 'HuidigeGebruikers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een HuidigeGebruiker. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuidigeGebruiker
@@ -787,7 +787,7 @@ paths:
get:
tags:
- 'HuidigeGebruikers'
- description: Retourneert een HuidigeGebruiker met de gegeven identifier
+ summary: Retourneert een HuidigeGebruiker met de gegeven identifier
operationId: readHuidigeGebruikerById
parameters:
- name: id
@@ -824,7 +824,7 @@ paths:
put:
tags:
- 'HuidigeGebruikers'
- description: Vervangen van een HuidigeGebruiker
+ summary: Vervangen van een HuidigeGebruiker
operationId: replaceHuidigeGebruikerById
parameters:
- name: 'id'
@@ -862,7 +862,7 @@ paths:
patch:
tags:
- 'HuidigeGebruikers'
- description: Wijzigen van een HuidigeGebruiker
+ summary: Wijzigen van een HuidigeGebruiker
operationId: updateHuidigeGebruikerById
parameters:
- name: 'id'
@@ -901,7 +901,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Ophalen van Kandidaten
+ summary: Ophalen van Kandidaten
operationId: listKandidaten
parameters:
- name: params
@@ -951,7 +951,7 @@ paths:
post:
tags:
- 'Kandidaten'
- description: Voegt een nieuw(e) Kandidaat toe.
+ summary: Voegt een nieuw(e) Kandidaat toe.
operationId: createKandidaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -991,7 +991,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Vervangen van een Kandidaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKandidaat
parameters:
@@ -1026,7 +1026,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kandidaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKandidaat
@@ -1063,7 +1063,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Retourneert een Kandidaat met de gegeven identifier
+ summary: Retourneert een Kandidaat met de gegeven identifier
operationId: readKandidaatById
parameters:
- name: id
@@ -1100,7 +1100,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: Vervangen van een Kandidaat
+ summary: Vervangen van een Kandidaat
operationId: replaceKandidaatById
parameters:
- name: 'id'
@@ -1138,7 +1138,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: Wijzigen van een Kandidaat
+ summary: Wijzigen van een Kandidaat
operationId: updateKandidaatById
parameters:
- name: 'id'
@@ -1177,7 +1177,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Ophalen van Publicaties
+ summary: Ophalen van Publicaties
operationId: listPublicaties
parameters:
- name: params
@@ -1227,7 +1227,7 @@ paths:
post:
tags:
- 'Publicaties'
- description: Voegt een nieuw(e) Publicatie toe.
+ summary: Voegt een nieuw(e) Publicatie toe.
operationId: createPublicatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1267,7 +1267,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: |
+ summary: |
Vervangen van een Publicatie op basis van overeenkomstige sleutelvelden.
operationId: replacePublicatie
parameters:
@@ -1302,7 +1302,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Publicatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePublicatie
@@ -1339,7 +1339,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Retourneert een Publicatie met de gegeven identifier
+ summary: Retourneert een Publicatie met de gegeven identifier
operationId: readPublicatieById
parameters:
- name: id
@@ -1376,7 +1376,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: Vervangen van een Publicatie
+ summary: Vervangen van een Publicatie
operationId: replacePublicatieById
parameters:
- name: 'id'
@@ -1414,7 +1414,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: Wijzigen van een Publicatie
+ summary: Wijzigen van een Publicatie
operationId: updatePublicatieById
parameters:
- name: 'id'
@@ -1453,7 +1453,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Ophalen van Puntenberekeningen
+ summary: Ophalen van Puntenberekeningen
operationId: listPuntenberekeningen
parameters:
- name: params
@@ -1503,7 +1503,7 @@ paths:
post:
tags:
- 'Puntenberekeningen'
- description: Voegt een nieuw(e) Puntenberekening toe.
+ summary: Voegt een nieuw(e) Puntenberekening toe.
operationId: createPuntenberekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1543,7 +1543,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Vervangen van een Puntenberekening op basis van overeenkomstige sleutelvelden.
operationId: replacePuntenberekening
parameters:
@@ -1578,7 +1578,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntenberekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntenberekening
@@ -1615,7 +1615,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Retourneert een Puntenberekening met de gegeven identifier
+ summary: Retourneert een Puntenberekening met de gegeven identifier
operationId: readPuntenberekeningById
parameters:
- name: id
@@ -1652,7 +1652,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: Vervangen van een Puntenberekening
+ summary: Vervangen van een Puntenberekening
operationId: replacePuntenberekeningById
parameters:
- name: 'id'
@@ -1690,7 +1690,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: Wijzigen van een Puntenberekening
+ summary: Wijzigen van een Puntenberekening
operationId: updatePuntenberekeningById
parameters:
- name: 'id'
@@ -1729,7 +1729,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Ophalen van Puntengebeurtenissen
+ summary: Ophalen van Puntengebeurtenissen
operationId: listPuntengebeurtenissen
parameters:
- name: params
@@ -1779,7 +1779,7 @@ paths:
post:
tags:
- 'Puntengebeurtenissen'
- description: Voegt een nieuw(e) Puntengebeurtenis toe.
+ summary: Voegt een nieuw(e) Puntengebeurtenis toe.
operationId: createPuntengebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1819,7 +1819,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Vervangen van een Puntengebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replacePuntengebeurtenis
parameters:
@@ -1854,7 +1854,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntengebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntengebeurtenis
@@ -1891,7 +1891,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Retourneert een Puntengebeurtenis met de gegeven identifier
+ summary: Retourneert een Puntengebeurtenis met de gegeven identifier
operationId: readPuntengebeurtenisById
parameters:
- name: id
@@ -1928,7 +1928,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: Vervangen van een Puntengebeurtenis
+ summary: Vervangen van een Puntengebeurtenis
operationId: replacePuntengebeurtenisById
parameters:
- name: 'id'
@@ -1966,7 +1966,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: Wijzigen van een Puntengebeurtenis
+ summary: Wijzigen van een Puntengebeurtenis
operationId: updatePuntengebeurtenisById
parameters:
- name: 'id'
@@ -2005,7 +2005,7 @@ paths:
get:
tags:
- 'Puntenmutaties'
- description: Ophalen van Puntenmutaties
+ summary: Ophalen van Puntenmutaties
operationId: listPuntenmutaties
parameters:
- name: params
@@ -2055,7 +2055,7 @@ paths:
post:
tags:
- 'Puntenmutaties'
- description: Voegt een nieuw(e) Puntenmutatie toe.
+ summary: Voegt een nieuw(e) Puntenmutatie toe.
operationId: createPuntenmutatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2095,7 +2095,7 @@ paths:
put:
tags:
- 'Puntenmutaties'
- description: |
+ summary: |
Vervangen van een Puntenmutatie op basis van overeenkomstige sleutelvelden.
operationId: replacePuntenmutatie
parameters:
@@ -2130,7 +2130,7 @@ paths:
patch:
tags:
- 'Puntenmutaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntenmutatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntenmutatie
@@ -2167,7 +2167,7 @@ paths:
get:
tags:
- 'Puntenmutaties'
- description: Retourneert een Puntenmutatie met de gegeven identifier
+ summary: Retourneert een Puntenmutatie met de gegeven identifier
operationId: readPuntenmutatieById
parameters:
- name: id
@@ -2204,7 +2204,7 @@ paths:
put:
tags:
- 'Puntenmutaties'
- description: Vervangen van een Puntenmutatie
+ summary: Vervangen van een Puntenmutatie
operationId: replacePuntenmutatieById
parameters:
- name: 'id'
@@ -2242,7 +2242,7 @@ paths:
patch:
tags:
- 'Puntenmutaties'
- description: Wijzigen van een Puntenmutatie
+ summary: Wijzigen van een Puntenmutatie
operationId: updatePuntenmutatieById
parameters:
- name: 'id'
@@ -2281,7 +2281,7 @@ paths:
get:
tags:
- 'Reacties'
- description: Ophalen van Reacties
+ summary: Ophalen van Reacties
operationId: listReacties
parameters:
- name: params
@@ -2331,7 +2331,7 @@ paths:
post:
tags:
- 'Reacties'
- description: Voegt een nieuw(e) Reactie toe.
+ summary: Voegt een nieuw(e) Reactie toe.
operationId: createReactie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2371,7 +2371,7 @@ paths:
put:
tags:
- 'Reacties'
- description: |
+ summary: |
Vervangen van een Reactie op basis van overeenkomstige sleutelvelden.
operationId: replaceReactie
parameters:
@@ -2406,7 +2406,7 @@ paths:
patch:
tags:
- 'Reacties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Reactie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReactie
@@ -2443,7 +2443,7 @@ paths:
get:
tags:
- 'Reacties'
- description: Retourneert een Reactie met de gegeven identifier
+ summary: Retourneert een Reactie met de gegeven identifier
operationId: readReactieById
parameters:
- name: id
@@ -2480,7 +2480,7 @@ paths:
put:
tags:
- 'Reacties'
- description: Vervangen van een Reactie
+ summary: Vervangen van een Reactie
operationId: replaceReactieById
parameters:
- name: 'id'
@@ -2518,7 +2518,7 @@ paths:
patch:
tags:
- 'Reacties'
- description: Wijzigen van een Reactie
+ summary: Wijzigen van een Reactie
operationId: updateReactieById
parameters:
- name: 'id'
@@ -2557,7 +2557,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Ophalen van Reclamaties
+ summary: Ophalen van Reclamaties
operationId: listReclamaties
parameters:
- name: params
@@ -2607,7 +2607,7 @@ paths:
post:
tags:
- 'Reclamaties'
- description: Voegt een nieuw(e) Reclamatie toe.
+ summary: Voegt een nieuw(e) Reclamatie toe.
operationId: createReclamatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2647,7 +2647,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Vervangen van een Reclamatie op basis van overeenkomstige sleutelvelden.
operationId: replaceReclamatie
parameters:
@@ -2682,7 +2682,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Reclamatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReclamatie
@@ -2719,7 +2719,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Retourneert een Reclamatie met de gegeven identifier
+ summary: Retourneert een Reclamatie met de gegeven identifier
operationId: readReclamatieById
parameters:
- name: id
@@ -2756,7 +2756,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: Vervangen van een Reclamatie
+ summary: Vervangen van een Reclamatie
operationId: replaceReclamatieById
parameters:
- name: 'id'
@@ -2794,7 +2794,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: Wijzigen van een Reclamatie
+ summary: Wijzigen van een Reclamatie
operationId: updateReclamatieById
parameters:
- name: 'id'
@@ -2833,7 +2833,7 @@ paths:
get:
tags:
- 'Regelingen'
- description: Ophalen van Regelingen
+ summary: Ophalen van Regelingen
operationId: listRegelingen
parameters:
- name: params
@@ -2883,7 +2883,7 @@ paths:
post:
tags:
- 'Regelingen'
- description: Voegt een nieuw(e) Regeling toe.
+ summary: Voegt een nieuw(e) Regeling toe.
operationId: createRegeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2923,7 +2923,7 @@ paths:
put:
tags:
- 'Regelingen'
- description: |
+ summary: |
Vervangen van een Regeling op basis van overeenkomstige sleutelvelden.
operationId: replaceRegeling
parameters:
@@ -2958,7 +2958,7 @@ paths:
patch:
tags:
- 'Regelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Regeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRegeling
@@ -2995,7 +2995,7 @@ paths:
get:
tags:
- 'Regelingen'
- description: Retourneert een Regeling met de gegeven identifier
+ summary: Retourneert een Regeling met de gegeven identifier
operationId: readRegelingById
parameters:
- name: id
@@ -3032,7 +3032,7 @@ paths:
put:
tags:
- 'Regelingen'
- description: Vervangen van een Regeling
+ summary: Vervangen van een Regeling
operationId: replaceRegelingById
parameters:
- name: 'id'
@@ -3070,7 +3070,7 @@ paths:
patch:
tags:
- 'Regelingen'
- description: Wijzigen van een Regeling
+ summary: Wijzigen van een Regeling
operationId: updateRegelingById
parameters:
- name: 'id'
@@ -3109,7 +3109,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Ophalen van Sancties
+ summary: Ophalen van Sancties
operationId: listSancties
parameters:
- name: params
@@ -3159,7 +3159,7 @@ paths:
post:
tags:
- 'Sancties'
- description: Voegt een nieuw(e) Sanctie toe.
+ summary: Voegt een nieuw(e) Sanctie toe.
operationId: createSanctie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3199,7 +3199,7 @@ paths:
put:
tags:
- 'Sancties'
- description: |
+ summary: |
Vervangen van een Sanctie op basis van overeenkomstige sleutelvelden.
operationId: replaceSanctie
parameters:
@@ -3234,7 +3234,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Sanctie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSanctie
@@ -3271,7 +3271,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Retourneert een Sanctie met de gegeven identifier
+ summary: Retourneert een Sanctie met de gegeven identifier
operationId: readSanctieById
parameters:
- name: id
@@ -3308,7 +3308,7 @@ paths:
put:
tags:
- 'Sancties'
- description: Vervangen van een Sanctie
+ summary: Vervangen van een Sanctie
operationId: replaceSanctieById
parameters:
- name: 'id'
@@ -3346,7 +3346,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: Wijzigen van een Sanctie
+ summary: Wijzigen van een Sanctie
operationId: updateSanctieById
parameters:
- name: 'id'
@@ -3385,7 +3385,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Ophalen van Toewijzingen
+ summary: Ophalen van Toewijzingen
operationId: listToewijzingen
parameters:
- name: params
@@ -3435,7 +3435,7 @@ paths:
post:
tags:
- 'Toewijzingen'
- description: Voegt een nieuw(e) Toewijzing toe.
+ summary: Voegt een nieuw(e) Toewijzing toe.
operationId: createToewijzing
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3475,7 +3475,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Vervangen van een Toewijzing op basis van overeenkomstige sleutelvelden.
operationId: replaceToewijzing
parameters:
@@ -3510,7 +3510,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Toewijzing. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateToewijzing
@@ -3547,7 +3547,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Retourneert een Toewijzing met de gegeven identifier
+ summary: Retourneert een Toewijzing met de gegeven identifier
operationId: readToewijzingById
parameters:
- name: id
@@ -3584,7 +3584,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: Vervangen van een Toewijzing
+ summary: Vervangen van een Toewijzing
operationId: replaceToewijzingById
parameters:
- name: 'id'
@@ -3622,7 +3622,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: Wijzigen van een Toewijzing
+ summary: Wijzigen van een Toewijzing
operationId: updateToewijzingById
parameters:
- name: 'id'
@@ -3661,7 +3661,7 @@ paths:
get:
tags:
- 'Voorrangsregelingen'
- description: Ophalen van Voorrangsregelingen
+ summary: Ophalen van Voorrangsregelingen
operationId: listVoorrangsregelingen
parameters:
- name: params
@@ -3711,7 +3711,7 @@ paths:
post:
tags:
- 'Voorrangsregelingen'
- description: Voegt een nieuw(e) Voorrangsregeling toe.
+ summary: Voegt een nieuw(e) Voorrangsregeling toe.
operationId: createVoorrangsregeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3751,7 +3751,7 @@ paths:
put:
tags:
- 'Voorrangsregelingen'
- description: |
+ summary: |
Vervangen van een Voorrangsregeling op basis van overeenkomstige sleutelvelden.
operationId: replaceVoorrangsregeling
parameters:
@@ -3786,7 +3786,7 @@ paths:
patch:
tags:
- 'Voorrangsregelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Voorrangsregeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVoorrangsregeling
@@ -3823,7 +3823,7 @@ paths:
get:
tags:
- 'Voorrangsregelingen'
- description: Retourneert een Voorrangsregeling met de gegeven identifier
+ summary: Retourneert een Voorrangsregeling met de gegeven identifier
operationId: readVoorrangsregelingById
parameters:
- name: id
@@ -3860,7 +3860,7 @@ paths:
put:
tags:
- 'Voorrangsregelingen'
- description: Vervangen van een Voorrangsregeling
+ summary: Vervangen van een Voorrangsregeling
operationId: replaceVoorrangsregelingById
parameters:
- name: 'id'
@@ -3898,7 +3898,7 @@ paths:
patch:
tags:
- 'Voorrangsregelingen'
- description: Wijzigen van een Voorrangsregeling
+ summary: Wijzigen van een Voorrangsregeling
operationId: updateVoorrangsregelingById
parameters:
- name: 'id'
@@ -3937,7 +3937,7 @@ paths:
get:
tags:
- 'VoorrangsregelingProfielen'
- description: Ophalen van VoorrangsregelingProfielen
+ summary: Ophalen van VoorrangsregelingProfielen
operationId: listVoorrangsregelingProfielen
parameters:
- name: params
@@ -3987,7 +3987,7 @@ paths:
post:
tags:
- 'VoorrangsregelingProfielen'
- description: Voegt een nieuw(e) VoorrangsregelingProfiel toe.
+ summary: Voegt een nieuw(e) VoorrangsregelingProfiel toe.
operationId: createVoorrangsregelingProfiel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4027,7 +4027,7 @@ paths:
put:
tags:
- 'VoorrangsregelingProfielen'
- description: |
+ summary: |
Vervangen van een VoorrangsregelingProfiel op basis van overeenkomstige sleutelvelden.
operationId: replaceVoorrangsregelingProfiel
parameters:
@@ -4062,7 +4062,7 @@ paths:
patch:
tags:
- 'VoorrangsregelingProfielen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een VoorrangsregelingProfiel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateVoorrangsregelingProfiel
@@ -4099,7 +4099,7 @@ paths:
get:
tags:
- 'VoorrangsregelingProfielen'
- description: Retourneert een VoorrangsregelingProfiel met de gegeven identifier
+ summary: Retourneert een VoorrangsregelingProfiel met de gegeven identifier
operationId: readVoorrangsregelingProfielById
parameters:
- name: id
@@ -4136,7 +4136,7 @@ paths:
put:
tags:
- 'VoorrangsregelingProfielen'
- description: Vervangen van een VoorrangsregelingProfiel
+ summary: Vervangen van een VoorrangsregelingProfiel
operationId: replaceVoorrangsregelingProfielById
parameters:
- name: 'id'
@@ -4174,7 +4174,7 @@ paths:
patch:
tags:
- 'VoorrangsregelingProfielen'
- description: Wijzigen van een VoorrangsregelingProfiel
+ summary: Wijzigen van een VoorrangsregelingProfiel
operationId: updateVoorrangsregelingProfielById
parameters:
- name: 'id'
@@ -4213,7 +4213,7 @@ paths:
get:
tags:
- 'Zoekprofiellen'
- description: Ophalen van Zoekprofiellen
+ summary: Ophalen van Zoekprofiellen
operationId: listZoekprofiellen
parameters:
- name: params
@@ -4263,7 +4263,7 @@ paths:
post:
tags:
- 'Zoekprofiellen'
- description: Voegt een nieuw(e) Zoekprofiel toe.
+ summary: Voegt een nieuw(e) Zoekprofiel toe.
operationId: createZoekprofiel
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -4303,7 +4303,7 @@ paths:
put:
tags:
- 'Zoekprofiellen'
- description: |
+ summary: |
Vervangen van een Zoekprofiel op basis van overeenkomstige sleutelvelden.
operationId: replaceZoekprofiel
parameters:
@@ -4338,7 +4338,7 @@ paths:
patch:
tags:
- 'Zoekprofiellen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zoekprofiel. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZoekprofiel
@@ -4375,7 +4375,7 @@ paths:
get:
tags:
- 'Zoekprofiellen'
- description: Retourneert een Zoekprofiel met de gegeven identifier
+ summary: Retourneert een Zoekprofiel met de gegeven identifier
operationId: readZoekprofielById
parameters:
- name: id
@@ -4412,7 +4412,7 @@ paths:
put:
tags:
- 'Zoekprofiellen'
- description: Vervangen van een Zoekprofiel
+ summary: Vervangen van een Zoekprofiel
operationId: replaceZoekprofielById
parameters:
- name: 'id'
@@ -4450,7 +4450,7 @@ paths:
patch:
tags:
- 'Zoekprofiellen'
- description: Wijzigen van een Zoekprofiel
+ summary: Wijzigen van een Zoekprofiel
operationId: updateZoekprofielById
parameters:
- name: 'id'
@@ -4522,10 +4522,48 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ Woonruimteverdeling.All.Read: alleen lezen van alle resources
+ Woonruimteverdeling.All.ReadWrite: lezen en schrijven van alle resources
+ Woonruimteverdeling.Aanbiedingen.Read: alleen lezen van Aanbiedingen
+ Woonruimteverdeling.Aanbiedingen.ReadWrite: lezen en schrijven van Aanbiedingen
+ Woonruimteverdeling.Gebeurtenissen.Read: alleen lezen van Gebeurtenissen
+ Woonruimteverdeling.Gebeurtenissen.ReadWrite: lezen en schrijven van Gebeurtenissen
+ Woonruimteverdeling.HuidigeGebruikers.Read: alleen lezen van HuidigeGebruikers
+ Woonruimteverdeling.HuidigeGebruikers.ReadWrite: lezen en schrijven van HuidigeGebruikers
+ Woonruimteverdeling.Kandidaten.Read: alleen lezen van Kandidaten
+ Woonruimteverdeling.Kandidaten.ReadWrite: lezen en schrijven van Kandidaten
+ Woonruimteverdeling.Publicaties.Read: alleen lezen van Publicaties
+ Woonruimteverdeling.Publicaties.ReadWrite: lezen en schrijven van Publicaties
+ Woonruimteverdeling.Puntenberekeningen.Read: alleen lezen van Puntenberekeningen
+ Woonruimteverdeling.Puntenberekeningen.ReadWrite: lezen en schrijven van Puntenberekeningen
+ Woonruimteverdeling.Puntengebeurtenissen.Read: alleen lezen van Puntengebeurtenissen
+ Woonruimteverdeling.Puntengebeurtenissen.ReadWrite: lezen en schrijven van Puntengebeurtenissen
+ Woonruimteverdeling.Puntenmutaties.Read: alleen lezen van Puntenmutaties
+ Woonruimteverdeling.Puntenmutaties.ReadWrite: lezen en schrijven van Puntenmutaties
+ Woonruimteverdeling.Reacties.Read: alleen lezen van Reacties
+ Woonruimteverdeling.Reacties.ReadWrite: lezen en schrijven van Reacties
+ Woonruimteverdeling.Reclamaties.Read: alleen lezen van Reclamaties
+ Woonruimteverdeling.Reclamaties.ReadWrite: lezen en schrijven van Reclamaties
+ Woonruimteverdeling.Regelingen.Read: alleen lezen van Regelingen
+ Woonruimteverdeling.Regelingen.ReadWrite: lezen en schrijven van Regelingen
+ Woonruimteverdeling.Sancties.Read: alleen lezen van Sancties
+ Woonruimteverdeling.Sancties.ReadWrite: lezen en schrijven van Sancties
+ Woonruimteverdeling.Toewijzingen.Read: alleen lezen van Toewijzingen
+ Woonruimteverdeling.Toewijzingen.ReadWrite: lezen en schrijven van Toewijzingen
+ Woonruimteverdeling.Voorrangsregelingen.Read: alleen lezen van Voorrangsregelingen
+ Woonruimteverdeling.Voorrangsregelingen.ReadWrite: lezen en schrijven van Voorrangsregelingen
+ Woonruimteverdeling.VoorrangsregelingProfielen.Read: alleen lezen van VoorrangsregelingProfielen
+ Woonruimteverdeling.VoorrangsregelingProfielen.ReadWrite: lezen en schrijven van VoorrangsregelingProfielen
+ Woonruimteverdeling.Zoekprofiellen.Read: alleen lezen van Zoekprofiellen
+ Woonruimteverdeling.Zoekprofiellen.ReadWrite: lezen en schrijven van Zoekprofiellen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
Woonruimteverdeling.All.Read: alleen lezen van alle resources
Woonruimteverdeling.All.ReadWrite: lezen en schrijven van alle resources
@@ -4619,33 +4657,33 @@ components:
bezichtiging:
type: string
format: uri
- description: Referentie naar Afspraak in informatiedomein Relaties
+ description: Referentie naar Afspraak-sleutels in informatiedomein Relaties
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
kandidaat:
allOf:
- - $ref: '#/components/schemas/Kandidaat'
+ - $ref: '#/components/schemas/Kandidaat-sleutels'
description: De kandidaat behorend bij de aanbieding.
publicatie:
allOf:
- - $ref: '#/components/schemas/Publicatie'
+ - $ref: '#/components/schemas/Publicatie-sleutels'
description: De publicatie naar aanleiding waarvan de aanbieding is gedaan.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Referentiedatabericht:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4672,7 +4710,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit. Referentiedatasoort .
+ description: De soort van het referentiedata item. Bijvoorbeeld nationaliteit.
naam:
type: string
format: any
@@ -4684,7 +4722,7 @@ components:
parent:
allOf:
- $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata. Referentiedatasoort .
+ description: De bovenliggende referentiedata in het geval er sprake is van een hierarchische relatie tussen referentiedata.
begindatum:
type: string
format: date
@@ -4720,6 +4758,144 @@ components:
type: string
format: any
description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ Kandidaat-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Publicatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Gebeurtenisbericht:
+ allOf:
+ - $ref: '#/components/schemas/Gebeurtenis'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Gebeurtenis:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn. OBSOLETE
+ deprecated: true
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling. OBSOLETE
+ deprecated: true
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden. OBSOLETE
+ deprecated: true
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
+ deprecated: true
+ datum:
+ type: string
+ format: date-time
+ description: De datum waarop gebeurtenis heeft plaatsgevonden. OBSOLETE
+ deprecated: true
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum van de geldigheid van de gebeurtenis. OBSOLETE
+ deprecated: true
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum van de geldigheid van de gebeurtenis. OBSOLETE
+ deprecated: true
+ adres:
+ type: string
+ format: uri
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
+ contextId:
+ type: string
+ format: any
+ description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc. OBSOLETE
+ deprecated: true
+ inschrijving:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. OBSOLETE Referentiedatasoort VESTIGING.
+ deprecated: true
+ HuidigeGebruikerbericht:
+ allOf:
+ - $ref: '#/components/schemas/HuidigeGebruiker'
+ - $ref: '#/components/schemas/Bericht-basis'
+ HuidigeGebruiker:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Vertrekdatum:
+ type: string
+ format: date-time
+ description: de vertrekdatum van de huidige gebruiker OBSOLETE
+ deprecated: true
+ vertrekdatum:
+ type: string
+ format: date-time
+ description: de vertrekdatum van de huidige gebruiker
+ relatie:
+ type: string
+ format: uri
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ contactgegevens:
+ type: string
+ format: uri
+ description: Referentie naar Contactgegeven-sleutels in informatiedomein Relaties
Kandidaatbericht:
allOf:
- $ref: '#/components/schemas/Kandidaat'
@@ -4761,27 +4937,27 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
positie:
type: integer
format: int32
description: De positie van de kandidaat voor een eenheid ten opzichte van de overige kandidaten.
publicatie:
allOf:
- - $ref: '#/components/schemas/Publicatie'
+ - $ref: '#/components/schemas/Publicatie-sleutels'
description: De publicatie waarvoor de kandidaat in aanmerking komt.
reactie:
allOf:
- - $ref: '#/components/schemas/Reactie'
+ - $ref: '#/components/schemas/Reactie-sleutels'
description: De reactie behorend bij de kandidaat.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Aanbieding-sleutels:
type: object
properties:
@@ -4801,6 +4977,25 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Reactie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Publicatiebericht:
allOf:
- $ref: '#/components/schemas/Publicatie'
@@ -4863,7 +5058,7 @@ components:
cluster:
type: string
format: uri
- description: Referentie naar Cluster in informatiedomein Vastgoed
+ description: Referentie naar Cluster-sleutels in informatiedomein Vastgoed
detailModel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4873,10 +5068,10 @@ components:
items:
type: string
format: uri
- description: Referenties naar Eenheid in informatiedomein Vastgoed
+ description: Referenties naar Eenheid-sleutels in informatiedomein Vastgoed
huidigeGebruiker:
allOf:
- - $ref: '#/components/schemas/HuidigeGebruiker'
+ - $ref: '#/components/schemas/HuidigeGebruiker-sleutels'
description: De huidige gebruiker van de eenheid
intakevorm:
allOf:
@@ -4923,11 +5118,7 @@ components:
type: integer
format: int32
description: De gemiddelde wachttijd in maanden voor mensen met voorrang.
- HuidigeGebruikerbericht:
- allOf:
- - $ref: '#/components/schemas/HuidigeGebruiker'
- - $ref: '#/components/schemas/Bericht-basis'
- HuidigeGebruiker:
+ HuidigeGebruiker-sleutels:
type: object
properties:
id:
@@ -4946,28 +5137,11 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Vertrekdatum:
- type: string
- format: date-time
- description: de vertrekdatum van de huidige gebruiker OBSOLETE
- deprecated: true
- vertrekdatum:
- type: string
- format: date-time
- description: de vertrekdatum van de huidige gebruiker
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- contactgegevens:
- type: string
- format: uri
- description: Referentie naar Contactgegeven in informatiedomein Relaties
- Reactiebericht:
+ Puntenberekeningbericht:
allOf:
- - $ref: '#/components/schemas/Reactie'
+ - $ref: '#/components/schemas/Puntenberekening'
- $ref: '#/components/schemas/Bericht-basis'
- Reactie:
+ Puntenberekening:
type: object
properties:
id:
@@ -4982,127 +5156,118 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
- type: string
- format: any
- description: 'Het soort reactie. Bijvoorbeeld: Optie of belangstelling.'
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van de reactie. Referentiedatasoort REACTIESTATUS.
- detailStatus:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De detail status van de reactie. Referentiedatasoort REACTIEDETAILSTATUS.
+ description: Het soort puntenberekening. Bij. Nieuwe inschrijving, Maandelijkse herberekening etc. Referentiedatasoort Puntenberekeningsoort.
datum:
type: string
format: date-time
- description: De datum en het tijdstip waarop de reactie is geplaatst.
- begeleiderDatum:
+ description: De datum waarop berekening heeft plaatsgevonden.
+ begindatum:
type: string
format: date-time
- description: De datum en tijd waarop de begeleider namens de woningzoekende een reactie heeft geplaatst.
- contactmomenten:
+ description: De begindatum van de geldigheid van de berekenis.
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum van de geldigheid van de berekenis.
+ puntenmutaties:
+ description: De puntenmutaties die hebben geleid tot een puntenberekening.
type: array
items:
- type: string
- format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
- overeenkomst:
+ $ref: '#/components/schemas/Puntenmutatie-sleutels'
+ relatie:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- positie:
- type: integer
- format: int32
- description: De positie van de kandidaat ten tijde van de reactie.
- publicatie:
- allOf:
- - $ref: '#/components/schemas/Publicatie'
- description: De publicatie behorend bij de reactie.
- relaties:
- type: array
- items:
- type: string
- format: uri
- description: Referenties naar Relatie in informatiedomein Relaties
- statusToelichting:
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ situatiepunten:
+ type: number
+ format: float
+ description: Het aantal punten voor dringende omstandigheden die niet binnen gemeentelijk urgentiebeleid vallen.
+ startpunten:
+ type: number
+ format: float
+ description: Het aantal punten dat men krijgt voor voorrang binnen de eigen gemeente.
+ zoekpunten:
+ type: number
+ format: float
+ description: Het aantal punten dat aangeeft hoe actief men op zoek is naar een woning.
+ Puntenmutatie-sleutels:
+ type: object
+ properties:
+ id:
type: string
format: any
- description: De omschrijving van de status van de reactie in het proces.
- voorkeur:
- type: integer
- format: int32
- description: De volgorde van reacties op voorkeur van de woningzoekende.
- Gebeurtenisbericht:
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort puntenmutatie. Referentiedatasoort PUNTENMUTATIESOORT.
+ Puntengebeurtenisbericht:
allOf:
- - $ref: '#/components/schemas/Gebeurtenis'
+ - $ref: '#/components/schemas/Puntengebeurtenis'
- $ref: '#/components/schemas/Bericht-basis'
- Gebeurtenis:
+ Puntengebeurtenis:
type: object
properties:
id:
type: string
format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn. OBSOLETE
- deprecated: true
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
idExtern:
type: string
format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling. OBSOLETE
- deprecated: true
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
idGegevensbeheerder:
type: string
format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden. OBSOLETE
- deprecated: true
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
- deprecated: true
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. Referentiedatasoort GEBEURTENISSOORT.
datum:
type: string
format: date-time
- description: De datum waarop gebeurtenis heeft plaatsgevonden. OBSOLETE
- deprecated: true
+ description: De datum waarop gebeurtenis heeft plaatsgevonden.
begindatum:
type: string
format: date-time
- description: De begindatum van de geldigheid van de gebeurtenis. OBSOLETE
- deprecated: true
+ description: De begindatum van de geldigheid van de gebeurtenis.
einddatum:
type: string
format: date-time
- description: De einddatum van de geldigheid van de gebeurtenis. OBSOLETE
- deprecated: true
+ description: De einddatum van de geldigheid van de gebeurtenis.
adres:
type: string
format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
+ description: Referentie naar Adres-sleutels in informatiedomein Vastgoed
contextId:
type: string
format: any
- description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc. OBSOLETE
- deprecated: true
+ description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc.
+ gerelateerdeGebeurtenis:
+ allOf:
+ - $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
+ description: Gebeurtenis waarop de gebeurtenis betrekking op heeft. Hiermee kan bijvoorbeeld de relatie worden gelegd tussen een ingetrokken no-show en een no-show.
inschrijving:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
vestiging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. OBSOLETE Referentiedatasoort VESTIGING.
- deprecated: true
- Puntenberekeningbericht:
- allOf:
- - $ref: '#/components/schemas/Puntenberekening'
- - $ref: '#/components/schemas/Bericht-basis'
- Puntenberekening:
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
+ Puntengebeurtenis-sleutels:
type: object
properties:
id:
@@ -5120,40 +5285,7 @@ components:
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort puntenberekening. Bij. Nieuwe inschrijving, Maandelijkse herberekening etc. Referentiedatasoort Puntenberekeningsoort.
- datum:
- type: string
- format: date-time
- description: De datum waarop berekening heeft plaatsgevonden.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van de geldigheid van de berekenis.
- einddatum:
- type: string
- format: date-time
- description: De einddatum van de geldigheid van de berekenis.
- puntenmutaties:
- description: De puntenmutaties die hebben geleid tot een puntenberekening.
- type: array
- items:
- $ref: '#/components/schemas/Puntenmutatie'
- relatie:
- type: string
- format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
- situatiepunten:
- type: number
- format: float
- description: Het aantal punten voor dringende omstandigheden die niet binnen gemeentelijk urgentiebeleid vallen.
- startpunten:
- type: number
- format: float
- description: Het aantal punten dat men krijgt voor voorrang binnen de eigen gemeente.
- zoekpunten:
- type: number
- format: float
- description: Het aantal punten dat aangeeft hoe actief men op zoek is naar een woning.
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. Referentiedatasoort GEBEURTENISSOORT.
Puntenmutatiebericht:
allOf:
- $ref: '#/components/schemas/Puntenmutatie'
@@ -5189,17 +5321,17 @@ components:
description: De gebeurtenissen welke hebben geleid tot de puntenmutatie. OBSOLETE.
type: array
items:
- $ref: '#/components/schemas/Gebeurtenis'
+ $ref: '#/components/schemas/Gebeurtenis-sleutels'
deprecated: true
puntengebeurtenissen:
description: De gebeurtenissen welke hebben geleid tot de puntenmutatie.
type: array
items:
- $ref: '#/components/schemas/Puntengebeurtenis'
+ $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
situatiepunten:
type: number
format: float
@@ -5212,62 +5344,34 @@ components:
type: number
format: float
description: Het aantal punten dat aangeeft hoe actief men op zoek is naar een woning.
- Puntengebeurtenisbericht:
- allOf:
- - $ref: '#/components/schemas/Puntengebeurtenis'
- - $ref: '#/components/schemas/Bericht-basis'
- Puntengebeurtenis:
+ Gebeurtenis-sleutels:
type: object
properties:
id:
type: string
format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn. OBSOLETE
+ deprecated: true
idExtern:
type: string
format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling. OBSOLETE
+ deprecated: true
idGegevensbeheerder:
type: string
format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden. OBSOLETE
+ deprecated: true
soort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. Referentiedatasoort GEBEURTENISSOORT.
- datum:
- type: string
- format: date-time
- description: De datum waarop gebeurtenis heeft plaatsgevonden.
- begindatum:
- type: string
- format: date-time
- description: De begindatum van de geldigheid van de gebeurtenis.
- einddatum:
- type: string
- format: date-time
- description: De einddatum van de geldigheid van de gebeurtenis.
- adres:
- type: string
- format: uri
- description: Referentie naar Adres in informatiedomein Vastgoed
- contextId:
- type: string
- format: any
- description: De id van de context van de gebeurtenis, bijv. een reactie id, een aanbieding id etc.
- gerelateerdeGebeurtenis:
- allOf:
- - $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
- description: Gebeurtenis waarop de gebeurtenis betrekking op heeft. Hiermee kan bijvoorbeeld de relatie worden gelegd tussen een ingetrokken no-show en een no-show.
- inschrijving:
- type: string
- format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
- vestiging:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
- Puntengebeurtenis-sleutels:
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
+ deprecated: true
+ Reactiebericht:
+ allOf:
+ - $ref: '#/components/schemas/Reactie'
+ - $ref: '#/components/schemas/Bericht-basis'
+ Reactie:
type: object
properties:
id:
@@ -5282,10 +5386,62 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
+ type: string
+ format: any
+ description: 'Het soort reactie. Bijvoorbeeld: Optie of belangstelling.'
+ status:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van de reactie. Referentiedatasoort REACTIESTATUS.
+ detailStatus:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De detail status van de reactie. Referentiedatasoort REACTIEDETAILSTATUS.
+ datum:
+ type: string
+ format: date-time
+ description: De datum en het tijdstip waarop de reactie is geplaatst.
+ begeleiderDatum:
+ type: string
+ format: date-time
+ description: De datum en tijd waarop de begeleider namens de woningzoekende een reactie heeft geplaatst.
+ contactmomenten:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
+ overeenkomst:
+ type: string
+ format: uri
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
+ positie:
+ type: integer
+ format: int32
+ description: De positie van de kandidaat ten tijde van de reactie.
+ publicatie:
+ allOf:
+ - $ref: '#/components/schemas/Publicatie-sleutels'
+ description: De publicatie behorend bij de reactie.
+ relaties:
+ type: array
+ items:
+ type: string
+ format: uri
+ description: Referenties naar Relatie-sleutels in informatiedomein Relaties
+ statusToelichting:
+ type: string
+ format: any
+ description: De omschrijving van de status van de reactie in het proces.
+ voorkeur:
+ type: integer
+ format: int32
+ description: De volgorde van reacties op voorkeur van de woningzoekende.
Reclamatiebericht:
allOf:
- $ref: '#/components/schemas/Reclamatie'
@@ -5334,15 +5490,15 @@ components:
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
puntengebeurtenis:
allOf:
- - $ref: '#/components/schemas/Puntengebeurtenis'
+ - $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
description: De gebeurtenis waarover de klacht of het bezwaar is ingediend.
relaties:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Regelingbericht:
allOf:
- $ref: '#/components/schemas/Regeling'
@@ -5378,13 +5534,17 @@ components:
type: string
format: date-time
description: De einddatum die aangeeft tot wanneer men van de regeling gebruik maakt of mag maken.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
gebruiken:
type: boolean
description: De waarde die aangeeft of men gebruik maakt van de regeling.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Sanctiebericht:
allOf:
- $ref: '#/components/schemas/Sanctie'
@@ -5428,17 +5588,17 @@ components:
description: De geberutenissen die hebben geleid tot de sanctie. OBSOLETE.
type: array
items:
- $ref: '#/components/schemas/Gebeurtenis'
+ $ref: '#/components/schemas/Gebeurtenis-sleutels'
deprecated: true
puntengebeurtenissen:
- description: De geberutenissen die hebben geleid tot de sanctie.
+ description: De gebeurtenissen die hebben geleid tot de sanctie.
type: array
items:
- $ref: '#/components/schemas/Puntengebeurtenis'
+ $ref: '#/components/schemas/Puntengebeurtenis-sleutels'
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Toewijzingbericht:
allOf:
- $ref: '#/components/schemas/Toewijzing'
@@ -5468,7 +5628,7 @@ components:
description: De datum waarop de eenheid is toegewezen.
aanbieding:
allOf:
- - $ref: '#/components/schemas/Aanbieding'
+ - $ref: '#/components/schemas/Aanbieding-sleutels'
description: De aanbieding behorend bij de toewijzing.
aanvullendeDoelgroep:
allOf:
@@ -5479,13 +5639,13 @@ components:
items:
type: string
format: uri
- description: Referenties naar Afspraak in informatiedomein Relaties
+ description: Referenties naar Afspraak-sleutels in informatiedomein Relaties
contactmomenten:
type: array
items:
type: string
format: uri
- description: Referenties naar Contactmoment in informatiedomein Relaties
+ description: Referenties naar Contactmoment-sleutels in informatiedomein Relaties
doelgroep:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5493,7 +5653,7 @@ components:
eenheid:
type: string
format: uri
- description: Referentie naar Eenheid in informatiedomein Vastgoed
+ description: Referentie naar Eenheid-sleutels in informatiedomein Vastgoed
huishoudgrootte:
type: integer
format: int32
@@ -5503,12 +5663,12 @@ components:
description: Geeft aan of de kandidaat, of één van diens medebewoners, op 1 januari van het jaar van toewijzen de pensioengerechtigde leeftijd bereikt.
kandidaat:
allOf:
- - $ref: '#/components/schemas/Kandidaat'
+ - $ref: '#/components/schemas/Kandidaat-sleutels'
description: De kandidaat behorende bij de toewijzing.
overeenkomst:
type: string
format: uri
- description: Referentie naar Overeenkomst in informatiedomein Overeenkomsten
+ description: Referentie naar Overeenkomst-sleutels in informatiedomein Overeenkomsten
passendheiddetailsoort:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5519,7 +5679,7 @@ components:
description: De indicatie of de toewijzing passend is volgens de wetgeving of valt binnen de vrij toe te wijzen ruimte. Referentiedatasoort PASSENDHEIDSSOORT.
publicatie:
allOf:
- - $ref: '#/components/schemas/Publicatie'
+ - $ref: '#/components/schemas/Publicatie-sleutels'
description: De publicatie behorende bij de toewijzing.
rekenhuur:
type: number
@@ -5536,12 +5696,31 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
voorrangsregelingen:
description: De voorrangsregeling(en) die van toepassing was of waren voor de toewijzing binnen het woonruimteverdeelproces. Onderdeel van de reden van de toewijzing.
type: array
items:
- $ref: '#/components/schemas/Voorrangsregeling'
+ $ref: '#/components/schemas/Voorrangsregeling-sleutels'
+ Voorrangsregeling-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Voorrangsregelingbericht:
allOf:
- $ref: '#/components/schemas/Voorrangsregeling'
@@ -5585,14 +5764,37 @@ components:
type: string
format: date-time
description: De einddatum tot wanneer men deze voorrang heeft.
+ authentiekGegeven:
+ type: string
+ format: uri
+ description: Referentie naar AuthentiekGegeven-sleutels in informatiedomein Dossier
profiel:
allOf:
- - $ref: '#/components/schemas/VoorrangsregelingProfiel'
+ - $ref: '#/components/schemas/VoorrangsregelingProfiel-sleutels'
description: Het profiel waarop de voorrangsregeling van toepassing is.
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
+ VoorrangsregelingProfiel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
VoorrangsregelingProfielbericht:
allOf:
- $ref: '#/components/schemas/VoorrangsregelingProfiel'
@@ -5621,7 +5823,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Buurt in informatiedomein Vastgoed
+ description: Referenties naar Buurt-sleutels in informatiedomein Vastgoed
eenheidSoorten:
description: De eenheid soorten waar het voorrangsregeling profiel voor geldt. Referentiedatasoort VOORRANGEENHEIDSOORT.
type: array
@@ -5632,7 +5834,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Gemeente in informatiedomein Vastgoed
+ description: Referenties naar Gemeente-sleutels in informatiedomein Vastgoed
huidigeOppervlakte:
type: integer
format: int32
@@ -5669,7 +5871,7 @@ components:
items:
type: string
format: uri
- description: Referenties naar Stadsdeel in informatiedomein Vastgoed
+ description: Referenties naar Stadsdeel-sleutels in informatiedomein Vastgoed
toegankelijkheidslabels:
description: De toegankelijkheidslabels waar het voorrangsregeling profiel voor geldt. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
type: array
@@ -5680,13 +5882,13 @@ components:
items:
type: string
format: uri
- description: Referenties naar Wijk in informatiedomein Vastgoed
+ description: Referenties naar Wijk-sleutels in informatiedomein Vastgoed
woonplaatsen:
type: array
items:
type: string
format: uri
- description: Referenties naar Woonplaats in informatiedomein Vastgoed
+ description: Referenties naar Woonplaats-sleutels in informatiedomein Vastgoed
Zoekprofielbericht:
allOf:
- $ref: '#/components/schemas/Zoekprofiel'
@@ -5748,7 +5950,7 @@ components:
locaties:
type: string
format: uri
- description: Referentie naar Gemeente in informatiedomein Vastgoed
+ description: Referentie naar Gemeente-sleutels in informatiedomein Vastgoed
Publicatiemodellen:
description: Referentiedatasoort PUBLICATIEMODEL.
type: array
@@ -5757,9 +5959,9 @@ components:
relatie:
type: string
format: uri
- description: Referentie naar Relatie in informatiedomein Relaties
+ description: Referentie naar Relatie-sleutels in informatiedomein Relaties
Toegankelijkheid:
- description: Welk niveau van toegankelijkheid men zoekt. Referentiedatasoort TOEGANKELIJKHEIDSLABELS.
+ description: Welk niveau van toegankelijkheid men zoekt. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
diff --git a/docs/Ketenprocessen/BDO.yaml b/docs/Ketenprocessen/BDO.yaml
index bf10924..286ffdc 100644
--- a/docs/Ketenprocessen/BDO.yaml
+++ b/docs/Ketenprocessen/BDO.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Casemanagement
- description: API-specificatie van ketenproces 'Casemanagement'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Casemanagement'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bdo.vera.io:{port}/{basePath}
description: Productieserver
@@ -31,7 +31,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -47,7 +47,7 @@ paths:
get:
tags:
- 'Dossiers'
- description: Ophalen van Dossiers
+ summary: Ophalen van Dossiers
operationId: listDossiers
parameters:
- name: params
@@ -97,7 +97,7 @@ paths:
post:
tags:
- 'Dossiers'
- description: Voegt een nieuw(e) Dossier toe.
+ summary: Voegt een nieuw(e) Dossier toe.
operationId: createDossier
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: |
+ summary: |
Vervangen van een Dossier op basis van overeenkomstige sleutelvelden.
operationId: replaceDossier
parameters:
@@ -172,7 +172,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Dossier. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDossier
@@ -209,7 +209,7 @@ paths:
get:
tags:
- 'Dossiers'
- description: Retourneert een Dossier met de gegeven identifier
+ summary: Retourneert een Dossier met de gegeven identifier
operationId: readDossierById
parameters:
- name: id
@@ -246,7 +246,7 @@ paths:
put:
tags:
- 'Dossiers'
- description: Vervangen van een Dossier
+ summary: Vervangen van een Dossier
operationId: replaceDossierById
parameters:
- name: 'id'
@@ -284,7 +284,7 @@ paths:
patch:
tags:
- 'Dossiers'
- description: Wijzigen van een Dossier
+ summary: Wijzigen van een Dossier
operationId: updateDossierById
parameters:
- name: 'id'
@@ -323,7 +323,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Ophalen van Informatieobjecten
+ summary: Ophalen van Informatieobjecten
operationId: listInformatieobjecten
parameters:
- name: params
@@ -373,7 +373,7 @@ paths:
post:
tags:
- 'Informatieobjecten'
- description: Voegt een nieuw(e) Informatieobject toe.
+ summary: Voegt een nieuw(e) Informatieobject toe.
operationId: createInformatieobject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Vervangen van een Informatieobject op basis van overeenkomstige sleutelvelden.
operationId: replaceInformatieobject
parameters:
@@ -448,7 +448,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Informatieobject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInformatieobject
@@ -485,7 +485,7 @@ paths:
get:
tags:
- 'Informatieobjecten'
- description: Retourneert een Informatieobject met de gegeven identifier
+ summary: Retourneert een Informatieobject met de gegeven identifier
operationId: readInformatieobjectById
parameters:
- name: id
@@ -522,7 +522,7 @@ paths:
put:
tags:
- 'Informatieobjecten'
- description: Vervangen van een Informatieobject
+ summary: Vervangen van een Informatieobject
operationId: replaceInformatieobjectById
parameters:
- name: 'id'
@@ -560,7 +560,7 @@ paths:
patch:
tags:
- 'Informatieobjecten'
- description: Wijzigen van een Informatieobject
+ summary: Wijzigen van een Informatieobject
operationId: updateInformatieobjectById
parameters:
- name: 'id'
@@ -599,7 +599,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Ophalen van Zaken
+ summary: Ophalen van Zaken
operationId: listZaken
parameters:
- name: params
@@ -649,7 +649,7 @@ paths:
post:
tags:
- 'Zaken'
- description: Voegt een nieuw(e) Zaak toe.
+ summary: Voegt een nieuw(e) Zaak toe.
operationId: createZaak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
put:
tags:
- 'Zaken'
- description: |
+ summary: |
Vervangen van een Zaak op basis van overeenkomstige sleutelvelden.
operationId: replaceZaak
parameters:
@@ -724,7 +724,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Zaak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateZaak
@@ -761,7 +761,7 @@ paths:
get:
tags:
- 'Zaken'
- description: Retourneert een Zaak met de gegeven identifier
+ summary: Retourneert een Zaak met de gegeven identifier
operationId: readZaakById
parameters:
- name: id
@@ -798,7 +798,7 @@ paths:
put:
tags:
- 'Zaken'
- description: Vervangen van een Zaak
+ summary: Vervangen van een Zaak
operationId: replaceZaakById
parameters:
- name: 'id'
@@ -836,7 +836,7 @@ paths:
patch:
tags:
- 'Zaken'
- description: Wijzigen van een Zaak
+ summary: Wijzigen van een Zaak
operationId: updateZaakById
parameters:
- name: 'id'
@@ -908,10 +908,22 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BDO.All.Read: alleen lezen van alle resources
+ BDO.All.ReadWrite: lezen en schrijven van alle resources
+ BDO.Dossiers.Read: alleen lezen van Dossiers
+ BDO.Dossiers.ReadWrite: lezen en schrijven van Dossiers
+ BDO.Informatieobjecten.Read: alleen lezen van Informatieobjecten
+ BDO.Informatieobjecten.ReadWrite: lezen en schrijven van Informatieobjecten
+ BDO.Zaken.Read: alleen lezen van Zaken
+ BDO.Zaken.ReadWrite: lezen en schrijven van Zaken
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BDO.All.Read: alleen lezen van alle resources
BDO.All.ReadWrite: lezen en schrijven van alle resources
@@ -1122,31 +1134,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
Dossier-sleutels:
type: object
properties:
@@ -1274,8 +1263,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Proces-sleutels:
type: object
properties:
@@ -1463,7 +1452,58 @@ components:
description: De contactpersonen behorend bij de rechtspersoon.
type: array
items:
- $ref: '#/components/schemas/Dossiers-Relatie'
+ $ref: '#/components/schemas/Relatie-sleutels'
+ Relatie-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ Relatierol-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Dossiers-Relatie-basis:
type: object
properties:
@@ -1987,57 +2027,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Relatie-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
- rollen:
- description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
- type: array
- items:
- $ref: '#/components/schemas/Relatierol-sleutels'
- Relatierol-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
Informatieobjecten-Relatie:
type: object
properties:
diff --git a/docs/Ketenprocessen/BFG.yaml b/docs/Ketenprocessen/BFG.yaml
index 540df2d..202bbf3 100644
--- a/docs/Ketenprocessen/BFG.yaml
+++ b/docs/Ketenprocessen/BFG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Financiele Gegevens
- description: API-specificatie van ketenproces 'Beheer Financiele Gegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Financiele Gegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bfg.vera.io:{port}/{basePath}
description: Productieserver
@@ -29,7 +29,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -45,7 +45,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Ophalen van Boekingen
+ summary: Ophalen van Boekingen
operationId: listBoekingen
parameters:
- name: params
@@ -95,7 +95,7 @@ paths:
post:
tags:
- 'Boekingen'
- description: Voegt een nieuw(e) Boeking toe.
+ summary: Voegt een nieuw(e) Boeking toe.
operationId: createBoeking
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -135,7 +135,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: |
+ summary: |
Vervangen van een Boeking op basis van overeenkomstige sleutelvelden.
operationId: replaceBoeking
parameters:
@@ -170,7 +170,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Boeking. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBoeking
@@ -207,7 +207,7 @@ paths:
get:
tags:
- 'Boekingen'
- description: Retourneert een Boeking met de gegeven identifier
+ summary: Retourneert een Boeking met de gegeven identifier
operationId: readBoekingById
parameters:
- name: id
@@ -244,7 +244,7 @@ paths:
put:
tags:
- 'Boekingen'
- description: Vervangen van een Boeking
+ summary: Vervangen van een Boeking
operationId: replaceBoekingById
parameters:
- name: 'id'
@@ -282,7 +282,7 @@ paths:
patch:
tags:
- 'Boekingen'
- description: Wijzigen van een Boeking
+ summary: Wijzigen van een Boeking
operationId: updateBoekingById
parameters:
- name: 'id'
@@ -321,7 +321,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Ophalen van Debiteuren
+ summary: Ophalen van Debiteuren
operationId: listDebiteuren
parameters:
- name: params
@@ -371,7 +371,7 @@ paths:
post:
tags:
- 'Debiteuren'
- description: Voegt een nieuw(e) Debiteur toe.
+ summary: Voegt een nieuw(e) Debiteur toe.
operationId: createDebiteur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -411,7 +411,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Vervangen van een Debiteur op basis van overeenkomstige sleutelvelden.
operationId: replaceDebiteur
parameters:
@@ -446,7 +446,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Debiteur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateDebiteur
@@ -483,7 +483,7 @@ paths:
get:
tags:
- 'Debiteuren'
- description: Retourneert een Debiteur met de gegeven identifier
+ summary: Retourneert een Debiteur met de gegeven identifier
operationId: readDebiteurById
parameters:
- name: id
@@ -520,7 +520,7 @@ paths:
put:
tags:
- 'Debiteuren'
- description: Vervangen van een Debiteur
+ summary: Vervangen van een Debiteur
operationId: replaceDebiteurById
parameters:
- name: 'id'
@@ -558,7 +558,7 @@ paths:
patch:
tags:
- 'Debiteuren'
- description: Wijzigen van een Debiteur
+ summary: Wijzigen van een Debiteur
operationId: updateDebiteurById
parameters:
- name: 'id'
@@ -630,10 +630,20 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BFG.All.Read: alleen lezen van alle resources
+ BFG.All.ReadWrite: lezen en schrijven van alle resources
+ BFG.Boekingen.Read: alleen lezen van Boekingen
+ BFG.Boekingen.ReadWrite: lezen en schrijven van Boekingen
+ BFG.Debiteuren.Read: alleen lezen van Debiteuren
+ BFG.Debiteuren.ReadWrite: lezen en schrijven van Debiteuren
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BFG.All.Read: alleen lezen van alle resources
BFG.All.ReadWrite: lezen en schrijven van alle resources
@@ -771,40 +781,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -1032,8 +1019,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Boekingen-Boekingdetail:
type: object
properties:
diff --git a/docs/Ketenprocessen/BOG.yaml b/docs/Ketenprocessen/BOG.yaml
index df96736..408baec 100644
--- a/docs/Ketenprocessen/BOG.yaml
+++ b/docs/Ketenprocessen/BOG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Overeenkomstgegevens
- description: API-specificatie van ketenproces 'Beheer Overeenkomstgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Overeenkomstgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bog.vera.io:{port}/{basePath}
description: Productieserver
@@ -29,7 +29,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -45,7 +45,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Ophalen van Overeenkomsten
+ summary: Ophalen van Overeenkomsten
operationId: listOvereenkomsten
parameters:
- name: params
@@ -95,7 +95,7 @@ paths:
post:
tags:
- 'Overeenkomsten'
- description: Voegt een nieuw(e) Overeenkomst toe.
+ summary: Voegt een nieuw(e) Overeenkomst toe.
operationId: createOvereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -135,7 +135,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Vervangen van een Overeenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomst
parameters:
@@ -170,7 +170,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomst
@@ -207,7 +207,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Retourneert een Overeenkomst met de gegeven identifier
+ summary: Retourneert een Overeenkomst met de gegeven identifier
operationId: readOvereenkomstById
parameters:
- name: id
@@ -244,7 +244,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: Vervangen van een Overeenkomst
+ summary: Vervangen van een Overeenkomst
operationId: replaceOvereenkomstById
parameters:
- name: 'id'
@@ -282,7 +282,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: Wijzigen van een Overeenkomst
+ summary: Wijzigen van een Overeenkomst
operationId: updateOvereenkomstById
parameters:
- name: 'id'
@@ -321,7 +321,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Ophalen van Prijscomponenten
+ summary: Ophalen van Prijscomponenten
operationId: listPrijscomponenten
parameters:
- name: params
@@ -371,7 +371,7 @@ paths:
post:
tags:
- 'Prijscomponenten'
- description: Voegt een nieuw(e) Prijscomponent toe.
+ summary: Voegt een nieuw(e) Prijscomponent toe.
operationId: createPrijscomponent
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -411,7 +411,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Vervangen van een Prijscomponent op basis van overeenkomstige sleutelvelden.
operationId: replacePrijscomponent
parameters:
@@ -446,7 +446,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Prijscomponent. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePrijscomponent
@@ -483,7 +483,7 @@ paths:
get:
tags:
- 'Prijscomponenten'
- description: Retourneert een Prijscomponent met de gegeven identifier
+ summary: Retourneert een Prijscomponent met de gegeven identifier
operationId: readPrijscomponentById
parameters:
- name: id
@@ -520,7 +520,7 @@ paths:
put:
tags:
- 'Prijscomponenten'
- description: Vervangen van een Prijscomponent
+ summary: Vervangen van een Prijscomponent
operationId: replacePrijscomponentById
parameters:
- name: 'id'
@@ -558,7 +558,7 @@ paths:
patch:
tags:
- 'Prijscomponenten'
- description: Wijzigen van een Prijscomponent
+ summary: Wijzigen van een Prijscomponent
operationId: updatePrijscomponentById
parameters:
- name: 'id'
@@ -630,10 +630,20 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BOG.All.Read: alleen lezen van alle resources
+ BOG.All.ReadWrite: lezen en schrijven van alle resources
+ BOG.Overeenkomsten.Read: alleen lezen van Overeenkomsten
+ BOG.Overeenkomsten.ReadWrite: lezen en schrijven van Overeenkomsten
+ BOG.Prijscomponenten.Read: alleen lezen van Prijscomponenten
+ BOG.Prijscomponenten.ReadWrite: lezen en schrijven van Prijscomponenten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BOG.All.Read: alleen lezen van alle resources
BOG.All.ReadWrite: lezen en schrijven van alle resources
@@ -767,40 +777,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -1329,8 +1316,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Contactmoment-sleutels:
type: object
properties:
@@ -1352,8 +1339,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort of onderwerp van het contactmoment. VERA zal hiervoor geen lijst leveren. Referentiedatasoort CONTACTMOMENTSOORT.
Eenheid-sleutels:
type: object
properties:
diff --git a/docs/Ketenprocessen/BRG.yaml b/docs/Ketenprocessen/BRG.yaml
index 2e98a02..f1b90d2 100644
--- a/docs/Ketenprocessen/BRG.yaml
+++ b/docs/Ketenprocessen/BRG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Relatiegegevens
- description: API-specificatie van ketenproces 'Beheer Relatiegegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Relatiegegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://brg.vera.io:{port}/{basePath}
description: Productieserver
@@ -33,7 +33,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -49,7 +49,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Ophalen van Betaalgegevens
+ summary: Ophalen van Betaalgegevens
operationId: listBetaalgegevens
parameters:
- name: params
@@ -99,7 +99,7 @@ paths:
post:
tags:
- 'Betaalgegevens'
- description: Voegt een nieuw(e) Betaalgegeven toe.
+ summary: Voegt een nieuw(e) Betaalgegeven toe.
operationId: createBetaalgegeven
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -139,7 +139,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Vervangen van een Betaalgegeven op basis van overeenkomstige sleutelvelden.
operationId: replaceBetaalgegeven
parameters:
@@ -174,7 +174,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betaalgegeven. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetaalgegeven
@@ -211,7 +211,7 @@ paths:
get:
tags:
- 'Betaalgegevens'
- description: Retourneert een Betaalgegeven met de gegeven identifier
+ summary: Retourneert een Betaalgegeven met de gegeven identifier
operationId: readBetaalgegevenById
parameters:
- name: id
@@ -248,7 +248,7 @@ paths:
put:
tags:
- 'Betaalgegevens'
- description: Vervangen van een Betaalgegeven
+ summary: Vervangen van een Betaalgegeven
operationId: replaceBetaalgegevenById
parameters:
- name: 'id'
@@ -286,7 +286,7 @@ paths:
patch:
tags:
- 'Betaalgegevens'
- description: Wijzigen van een Betaalgegeven
+ summary: Wijzigen van een Betaalgegeven
operationId: updateBetaalgegevenById
parameters:
- name: 'id'
@@ -325,7 +325,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Ophalen van Contactmomenten
+ summary: Ophalen van Contactmomenten
operationId: listContactmomenten
parameters:
- name: params
@@ -375,7 +375,7 @@ paths:
post:
tags:
- 'Contactmomenten'
- description: Voegt een nieuw(e) Contactmoment toe.
+ summary: Voegt een nieuw(e) Contactmoment toe.
operationId: createContactmoment
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -415,7 +415,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Vervangen van een Contactmoment op basis van overeenkomstige sleutelvelden.
operationId: replaceContactmoment
parameters:
@@ -450,7 +450,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Contactmoment. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateContactmoment
@@ -487,7 +487,7 @@ paths:
get:
tags:
- 'Contactmomenten'
- description: Retourneert een Contactmoment met de gegeven identifier
+ summary: Retourneert een Contactmoment met de gegeven identifier
operationId: readContactmomentById
parameters:
- name: id
@@ -524,7 +524,7 @@ paths:
put:
tags:
- 'Contactmomenten'
- description: Vervangen van een Contactmoment
+ summary: Vervangen van een Contactmoment
operationId: replaceContactmomentById
parameters:
- name: 'id'
@@ -562,7 +562,7 @@ paths:
patch:
tags:
- 'Contactmomenten'
- description: Wijzigen van een Contactmoment
+ summary: Wijzigen van een Contactmoment
operationId: updateContactmomentById
parameters:
- name: 'id'
@@ -601,7 +601,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Ophalen van Relaties
+ summary: Ophalen van Relaties
operationId: listRelaties
parameters:
- name: params
@@ -651,7 +651,7 @@ paths:
post:
tags:
- 'Relaties'
- description: Voegt een nieuw(e) Relatie toe.
+ summary: Voegt een nieuw(e) Relatie toe.
operationId: createRelatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -691,7 +691,7 @@ paths:
put:
tags:
- 'Relaties'
- description: |
+ summary: |
Vervangen van een Relatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatie
parameters:
@@ -726,7 +726,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatie
@@ -763,7 +763,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Retourneert een Relatie met de gegeven identifier
+ summary: Retourneert een Relatie met de gegeven identifier
operationId: readRelatieById
parameters:
- name: id
@@ -800,7 +800,7 @@ paths:
put:
tags:
- 'Relaties'
- description: Vervangen van een Relatie
+ summary: Vervangen van een Relatie
operationId: replaceRelatieById
parameters:
- name: 'id'
@@ -838,7 +838,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: Wijzigen van een Relatie
+ summary: Wijzigen van een Relatie
operationId: updateRelatieById
parameters:
- name: 'id'
@@ -877,7 +877,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Ophalen van Signaleringen
+ summary: Ophalen van Signaleringen
operationId: listSignaleringen
parameters:
- name: params
@@ -927,7 +927,7 @@ paths:
post:
tags:
- 'Signaleringen'
- description: Voegt een nieuw(e) Signalering toe.
+ summary: Voegt een nieuw(e) Signalering toe.
operationId: createSignalering
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -967,7 +967,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Vervangen van een Signalering op basis van overeenkomstige sleutelvelden.
operationId: replaceSignalering
parameters:
@@ -1002,7 +1002,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Signalering. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSignalering
@@ -1039,7 +1039,7 @@ paths:
get:
tags:
- 'Signaleringen'
- description: Retourneert een Signalering met de gegeven identifier
+ summary: Retourneert een Signalering met de gegeven identifier
operationId: readSignaleringById
parameters:
- name: id
@@ -1076,7 +1076,7 @@ paths:
put:
tags:
- 'Signaleringen'
- description: Vervangen van een Signalering
+ summary: Vervangen van een Signalering
operationId: replaceSignaleringById
parameters:
- name: 'id'
@@ -1114,7 +1114,7 @@ paths:
patch:
tags:
- 'Signaleringen'
- description: Wijzigen van een Signalering
+ summary: Wijzigen van een Signalering
operationId: updateSignaleringById
parameters:
- name: 'id'
@@ -1186,10 +1186,24 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BRG.All.Read: alleen lezen van alle resources
+ BRG.All.ReadWrite: lezen en schrijven van alle resources
+ BRG.Betaalgegevens.Read: alleen lezen van Betaalgegevens
+ BRG.Betaalgegevens.ReadWrite: lezen en schrijven van Betaalgegevens
+ BRG.Contactmomenten.Read: alleen lezen van Contactmomenten
+ BRG.Contactmomenten.ReadWrite: lezen en schrijven van Contactmomenten
+ BRG.Relaties.Read: alleen lezen van Relaties
+ BRG.Relaties.ReadWrite: lezen en schrijven van Relaties
+ BRG.Signaleringen.Read: alleen lezen van Signaleringen
+ BRG.Signaleringen.ReadWrite: lezen en schrijven van Signaleringen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BRG.All.Read: alleen lezen van alle resources
BRG.All.ReadWrite: lezen en schrijven van alle resources
@@ -1328,10 +1342,6 @@ components:
type: string
format: any
description: Het nummer van de machtiging
- rekening:
- allOf:
- - $ref: '#/components/schemas/Betaalgegevens-Betaalgegeven'
- description: De BIC kode van de bank van de debiteur
Betaalgegevens-Overeenkomst:
type: object
properties:
@@ -1395,31 +1405,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Betaalwijze-sleutels:
type: object
properties:
@@ -2465,12 +2452,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
diff --git a/docs/Ketenprocessen/BVG.yaml b/docs/Ketenprocessen/BVG.yaml
index bdb1a11..d248dfa 100644
--- a/docs/Ketenprocessen/BVG.yaml
+++ b/docs/Ketenprocessen/BVG.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Beheer Vastgoedgegevens
- description: API-specificatie van ketenproces 'Beheer Vastgoedgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Beheer Vastgoedgegevens'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://bvg.vera.io:{port}/{basePath}
description: Productieserver
@@ -27,7 +27,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -43,7 +43,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Ophalen van WoningwaarderingResultaten
+ summary: Ophalen van WoningwaarderingResultaten
operationId: listWoningwaarderingResultaten
parameters:
- name: params
@@ -93,7 +93,7 @@ paths:
post:
tags:
- 'WoningwaarderingResultaten'
- description: Voegt een nieuw(e) WoningwaarderingResultaat toe.
+ summary: Voegt een nieuw(e) WoningwaarderingResultaat toe.
operationId: createWoningwaarderingResultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -133,7 +133,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Vervangen van een WoningwaarderingResultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceWoningwaarderingResultaat
parameters:
@@ -168,7 +168,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een WoningwaarderingResultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateWoningwaarderingResultaat
@@ -205,7 +205,7 @@ paths:
get:
tags:
- 'WoningwaarderingResultaten'
- description: Retourneert een WoningwaarderingResultaat met de gegeven identifier
+ summary: Retourneert een WoningwaarderingResultaat met de gegeven identifier
operationId: readWoningwaarderingResultaatById
parameters:
- name: id
@@ -242,7 +242,7 @@ paths:
put:
tags:
- 'WoningwaarderingResultaten'
- description: Vervangen van een WoningwaarderingResultaat
+ summary: Vervangen van een WoningwaarderingResultaat
operationId: replaceWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -280,7 +280,7 @@ paths:
patch:
tags:
- 'WoningwaarderingResultaten'
- description: Wijzigen van een WoningwaarderingResultaat
+ summary: Wijzigen van een WoningwaarderingResultaat
operationId: updateWoningwaarderingResultaatById
parameters:
- name: 'id'
@@ -352,10 +352,18 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ BVG.All.Read: alleen lezen van alle resources
+ BVG.All.ReadWrite: lezen en schrijven van alle resources
+ BVG.WoningwaarderingResultaten.Read: alleen lezen van WoningwaarderingResultaten
+ BVG.WoningwaarderingResultaten.ReadWrite: lezen en schrijven van WoningwaarderingResultaten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
BVG.All.Read: alleen lezen van alle resources
BVG.All.ReadWrite: lezen en schrijven van alle resources
@@ -817,40 +825,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
diff --git a/docs/Ketenprocessen/INC.yaml b/docs/Ketenprocessen/INC.yaml
index d8fdeee..74e1056 100644
--- a/docs/Ketenprocessen/INC.yaml
+++ b/docs/Ketenprocessen/INC.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Incasso
- description: API-specificatie van ketenproces 'Incasso'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Incasso'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://inc.vera.io:{port}/{basePath}
description: Productieserver
@@ -29,7 +29,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -45,7 +45,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Ophalen van Betalingsregelingen
+ summary: Ophalen van Betalingsregelingen
operationId: listBetalingsregelingen
parameters:
- name: params
@@ -95,7 +95,7 @@ paths:
post:
tags:
- 'Betalingsregelingen'
- description: Voegt een nieuw(e) Betalingsregeling toe.
+ summary: Voegt een nieuw(e) Betalingsregeling toe.
operationId: createBetalingsregeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -135,7 +135,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Vervangen van een Betalingsregeling op basis van overeenkomstige sleutelvelden.
operationId: replaceBetalingsregeling
parameters:
@@ -170,7 +170,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Betalingsregeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBetalingsregeling
@@ -207,7 +207,7 @@ paths:
get:
tags:
- 'Betalingsregelingen'
- description: Retourneert een Betalingsregeling met de gegeven identifier
+ summary: Retourneert een Betalingsregeling met de gegeven identifier
operationId: readBetalingsregelingById
parameters:
- name: id
@@ -244,7 +244,7 @@ paths:
put:
tags:
- 'Betalingsregelingen'
- description: Vervangen van een Betalingsregeling
+ summary: Vervangen van een Betalingsregeling
operationId: replaceBetalingsregelingById
parameters:
- name: 'id'
@@ -282,7 +282,7 @@ paths:
patch:
tags:
- 'Betalingsregelingen'
- description: Wijzigen van een Betalingsregeling
+ summary: Wijzigen van een Betalingsregeling
operationId: updateBetalingsregelingById
parameters:
- name: 'id'
@@ -321,7 +321,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Ophalen van ExterneIncassos
+ summary: Ophalen van ExterneIncassos
operationId: listExterneIncassos
parameters:
- name: params
@@ -371,7 +371,7 @@ paths:
post:
tags:
- 'ExterneIncassos'
- description: Voegt een nieuw(e) ExterneIncasso toe.
+ summary: Voegt een nieuw(e) ExterneIncasso toe.
operationId: createExterneIncasso
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -411,7 +411,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Vervangen van een ExterneIncasso op basis van overeenkomstige sleutelvelden.
operationId: replaceExterneIncasso
parameters:
@@ -446,7 +446,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een ExterneIncasso. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateExterneIncasso
@@ -483,7 +483,7 @@ paths:
get:
tags:
- 'ExterneIncassos'
- description: Retourneert een ExterneIncasso met de gegeven identifier
+ summary: Retourneert een ExterneIncasso met de gegeven identifier
operationId: readExterneIncassoById
parameters:
- name: id
@@ -520,7 +520,7 @@ paths:
put:
tags:
- 'ExterneIncassos'
- description: Vervangen van een ExterneIncasso
+ summary: Vervangen van een ExterneIncasso
operationId: replaceExterneIncassoById
parameters:
- name: 'id'
@@ -558,7 +558,7 @@ paths:
patch:
tags:
- 'ExterneIncassos'
- description: Wijzigen van een ExterneIncasso
+ summary: Wijzigen van een ExterneIncasso
operationId: updateExterneIncassoById
parameters:
- name: 'id'
@@ -630,10 +630,20 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ INC.All.Read: alleen lezen van alle resources
+ INC.All.ReadWrite: lezen en schrijven van alle resources
+ INC.Betalingsregelingen.Read: alleen lezen van Betalingsregelingen
+ INC.Betalingsregelingen.ReadWrite: lezen en schrijven van Betalingsregelingen
+ INC.ExterneIncassos.Read: alleen lezen van ExterneIncassos
+ INC.ExterneIncassos.ReadWrite: lezen en schrijven van ExterneIncassos
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
INC.All.Read: alleen lezen van alle resources
INC.All.ReadWrite: lezen en schrijven van alle resources
@@ -767,40 +777,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -857,31 +844,12 @@ components:
description: Het betaalgegeven waarmee de betalingsregeling wordt betaald. Dit kan bijvoorbeeld het rekeningnummer zijn van de relatie.
incassomachtiging:
allOf:
- - $ref: '#/components/schemas/Incassomachtiging-sleutels'
+ - $ref: '#/components/schemas/Betalingsregelingen-Incassomachtiging'
description: De digitale machtiging voor het uitvoeren van de incassoopdrachten. SEPA.
incassomoment:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het moment waarop de incasso wordt gedaan. Referentiedatasoort INCASSOMOMENT.
- Incassomachtiging-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken). In dit geval logisch om het mandaatid hier te gebruiken.
Betalingsregelingen-Betalingsregelingbericht:
allOf:
- $ref: '#/components/schemas/Betalingsregelingen-Betalingsregeling'
@@ -1018,8 +986,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Betalingsregelingen-BetalingsregelingTermijn:
type: object
properties:
diff --git a/docs/Ketenprocessen/KMT.yaml b/docs/Ketenprocessen/KMT.yaml
index ac9720d..4b137f0 100644
--- a/docs/Ketenprocessen/KMT.yaml
+++ b/docs/Ketenprocessen/KMT.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Kwaliteitsmeting
- description: API-specificatie van ketenproces 'Kwaliteitsmeting'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Kwaliteitsmeting'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://kmt.vera.io:{port}/{basePath}
description: Productieserver
@@ -33,7 +33,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -49,7 +49,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Ophalen van Kwaliteitsmetingsresultaten
+ summary: Ophalen van Kwaliteitsmetingsresultaten
operationId: listKwaliteitsmetingsresultaten
parameters:
- name: params
@@ -99,7 +99,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsresultaat toe.
operationId: createKwaliteitsmetingsresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -139,7 +139,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsresultaat
parameters:
@@ -174,7 +174,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsresultaat
@@ -211,7 +211,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsresultaat met de gegeven identifier
operationId: readKwaliteitsmetingsresultaatById
parameters:
- name: id
@@ -248,7 +248,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Vervangen van een Kwaliteitsmetingsresultaat
+ summary: Vervangen van een Kwaliteitsmetingsresultaat
operationId: replaceKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -286,7 +286,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsresultaten'
- description: Wijzigen van een Kwaliteitsmetingsresultaat
+ summary: Wijzigen van een Kwaliteitsmetingsresultaat
operationId: updateKwaliteitsmetingsresultaatById
parameters:
- name: 'id'
@@ -325,7 +325,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Ophalen van Kwaliteitsmetingsverzoeken
+ summary: Ophalen van Kwaliteitsmetingsverzoeken
operationId: listKwaliteitsmetingsverzoeken
parameters:
- name: params
@@ -375,7 +375,7 @@ paths:
post:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
+ summary: Voegt een nieuw(e) Kwaliteitsmetingsverzoek toe.
operationId: createKwaliteitsmetingsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -415,7 +415,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Vervangen van een Kwaliteitsmetingsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceKwaliteitsmetingsverzoek
parameters:
@@ -450,7 +450,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kwaliteitsmetingsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKwaliteitsmetingsverzoek
@@ -487,7 +487,7 @@ paths:
get:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
+ summary: Retourneert een Kwaliteitsmetingsverzoek met de gegeven identifier
operationId: readKwaliteitsmetingsverzoekById
parameters:
- name: id
@@ -524,7 +524,7 @@ paths:
put:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Vervangen van een Kwaliteitsmetingsverzoek
+ summary: Vervangen van een Kwaliteitsmetingsverzoek
operationId: replaceKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -562,7 +562,7 @@ paths:
patch:
tags:
- 'Kwaliteitsmetingsverzoeken'
- description: Wijzigen van een Kwaliteitsmetingsverzoek
+ summary: Wijzigen van een Kwaliteitsmetingsverzoek
operationId: updateKwaliteitsmetingsverzoekById
parameters:
- name: 'id'
@@ -601,7 +601,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Ophalen van Onderzoeksopdrachten
+ summary: Ophalen van Onderzoeksopdrachten
operationId: listOnderzoeksopdrachten
parameters:
- name: params
@@ -651,7 +651,7 @@ paths:
post:
tags:
- 'Onderzoeksopdrachten'
- description: Voegt een nieuw(e) Onderzoeksopdracht toe.
+ summary: Voegt een nieuw(e) Onderzoeksopdracht toe.
operationId: createOnderzoeksopdracht
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -691,7 +691,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Vervangen van een Onderzoeksopdracht op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksopdracht
parameters:
@@ -726,7 +726,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksopdracht. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksopdracht
@@ -763,7 +763,7 @@ paths:
get:
tags:
- 'Onderzoeksopdrachten'
- description: Retourneert een Onderzoeksopdracht met de gegeven identifier
+ summary: Retourneert een Onderzoeksopdracht met de gegeven identifier
operationId: readOnderzoeksopdrachtById
parameters:
- name: id
@@ -800,7 +800,7 @@ paths:
put:
tags:
- 'Onderzoeksopdrachten'
- description: Vervangen van een Onderzoeksopdracht
+ summary: Vervangen van een Onderzoeksopdracht
operationId: replaceOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -838,7 +838,7 @@ paths:
patch:
tags:
- 'Onderzoeksopdrachten'
- description: Wijzigen van een Onderzoeksopdracht
+ summary: Wijzigen van een Onderzoeksopdracht
operationId: updateOnderzoeksopdrachtById
parameters:
- name: 'id'
@@ -877,7 +877,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Ophalen van Onderzoeksresultaten
+ summary: Ophalen van Onderzoeksresultaten
operationId: listOnderzoeksresultaten
parameters:
- name: params
@@ -927,7 +927,7 @@ paths:
post:
tags:
- 'Onderzoeksresultaten'
- description: Voegt een nieuw(e) Onderzoeksresultaat toe.
+ summary: Voegt een nieuw(e) Onderzoeksresultaat toe.
operationId: createOnderzoeksresultaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -967,7 +967,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Vervangen van een Onderzoeksresultaat op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderzoeksresultaat
parameters:
@@ -1002,7 +1002,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderzoeksresultaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderzoeksresultaat
@@ -1039,7 +1039,7 @@ paths:
get:
tags:
- 'Onderzoeksresultaten'
- description: Retourneert een Onderzoeksresultaat met de gegeven identifier
+ summary: Retourneert een Onderzoeksresultaat met de gegeven identifier
operationId: readOnderzoeksresultaatById
parameters:
- name: id
@@ -1076,7 +1076,7 @@ paths:
put:
tags:
- 'Onderzoeksresultaten'
- description: Vervangen van een Onderzoeksresultaat
+ summary: Vervangen van een Onderzoeksresultaat
operationId: replaceOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1114,7 +1114,7 @@ paths:
patch:
tags:
- 'Onderzoeksresultaten'
- description: Wijzigen van een Onderzoeksresultaat
+ summary: Wijzigen van een Onderzoeksresultaat
operationId: updateOnderzoeksresultaatById
parameters:
- name: 'id'
@@ -1186,10 +1186,24 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ KMT.All.Read: alleen lezen van alle resources
+ KMT.All.ReadWrite: lezen en schrijven van alle resources
+ KMT.Kwaliteitsmetingsresultaten.Read: alleen lezen van Kwaliteitsmetingsresultaten
+ KMT.Kwaliteitsmetingsresultaten.ReadWrite: lezen en schrijven van Kwaliteitsmetingsresultaten
+ KMT.Kwaliteitsmetingsverzoeken.Read: alleen lezen van Kwaliteitsmetingsverzoeken
+ KMT.Kwaliteitsmetingsverzoeken.ReadWrite: lezen en schrijven van Kwaliteitsmetingsverzoeken
+ KMT.Onderzoeksopdrachten.Read: alleen lezen van Onderzoeksopdrachten
+ KMT.Onderzoeksopdrachten.ReadWrite: lezen en schrijven van Onderzoeksopdrachten
+ KMT.Onderzoeksresultaten.Read: alleen lezen van Onderzoeksresultaten
+ KMT.Onderzoeksresultaten.ReadWrite: lezen en schrijven van Onderzoeksresultaten
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
KMT.All.Read: alleen lezen van alle resources
KMT.All.ReadWrite: lezen en schrijven van alle resources
@@ -1445,40 +1459,17 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
items:
$ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
Relatierol-sleutels:
type: object
properties:
@@ -1831,8 +1822,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Kwaliteitsmetingsverzoeken-Overeenkomst:
oneOf:
- $ref: '#/components/schemas/Kwaliteitsmetingsverzoeken-Huurovereenkomst'
diff --git a/docs/Ketenprocessen/OHD.yaml b/docs/Ketenprocessen/OHD.yaml
index a112e9a..625601c 100644
--- a/docs/Ketenprocessen/OHD.yaml
+++ b/docs/Ketenprocessen/OHD.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Onderhoud
- description: API-specificatie van ketenproces 'Onderhoud'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Onderhoud'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '2.1.0+230422.8'
+ version: '2.1.1+230512.44'
servers:
- url: https://ohd.vera.io:{port}/{basePath}
description: Productieserver
@@ -43,7 +43,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -59,7 +59,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Ophalen van AfspraakOpties
+ summary: Ophalen van AfspraakOpties
operationId: listAfspraakOpties
parameters:
- name: params
@@ -109,7 +109,7 @@ paths:
post:
tags:
- 'AfspraakOpties'
- description: Voegt een nieuw(e) AfspraakOptie toe.
+ summary: Voegt een nieuw(e) AfspraakOptie toe.
operationId: createAfspraakOptie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -149,7 +149,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Vervangen van een AfspraakOptie op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraakOptie
parameters:
@@ -184,7 +184,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een AfspraakOptie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraakOptie
@@ -221,7 +221,7 @@ paths:
get:
tags:
- 'AfspraakOpties'
- description: Retourneert een AfspraakOptie met de gegeven identifier
+ summary: Retourneert een AfspraakOptie met de gegeven identifier
operationId: readAfspraakOptieById
parameters:
- name: id
@@ -258,7 +258,7 @@ paths:
put:
tags:
- 'AfspraakOpties'
- description: Vervangen van een AfspraakOptie
+ summary: Vervangen van een AfspraakOptie
operationId: replaceAfspraakOptieById
parameters:
- name: 'id'
@@ -296,7 +296,7 @@ paths:
patch:
tags:
- 'AfspraakOpties'
- description: Wijzigen van een AfspraakOptie
+ summary: Wijzigen van een AfspraakOptie
operationId: updateAfspraakOptieById
parameters:
- name: 'id'
@@ -335,7 +335,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Ophalen van Afspraken
+ summary: Ophalen van Afspraken
operationId: listAfspraken
parameters:
- name: params
@@ -385,7 +385,7 @@ paths:
post:
tags:
- 'Afspraken'
- description: Voegt een nieuw(e) Afspraak toe.
+ summary: Voegt een nieuw(e) Afspraak toe.
operationId: createAfspraak
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -425,7 +425,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: |
+ summary: |
Vervangen van een Afspraak op basis van overeenkomstige sleutelvelden.
operationId: replaceAfspraak
parameters:
@@ -460,7 +460,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Afspraak. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAfspraak
@@ -497,7 +497,7 @@ paths:
get:
tags:
- 'Afspraken'
- description: Retourneert een Afspraak met de gegeven identifier
+ summary: Retourneert een Afspraak met de gegeven identifier
operationId: readAfspraakById
parameters:
- name: id
@@ -534,7 +534,7 @@ paths:
put:
tags:
- 'Afspraken'
- description: Vervangen van een Afspraak
+ summary: Vervangen van een Afspraak
operationId: replaceAfspraakById
parameters:
- name: 'id'
@@ -572,7 +572,7 @@ paths:
patch:
tags:
- 'Afspraken'
- description: Wijzigen van een Afspraak
+ summary: Wijzigen van een Afspraak
operationId: updateAfspraakById
parameters:
- name: 'id'
@@ -611,7 +611,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Ophalen van BouwkundigElementen
+ summary: Ophalen van BouwkundigElementen
operationId: listBouwkundigElementen
parameters:
- name: params
@@ -661,7 +661,7 @@ paths:
post:
tags:
- 'BouwkundigElementen'
- description: Voegt een nieuw(e) BouwkundigElement toe.
+ summary: Voegt een nieuw(e) BouwkundigElement toe.
operationId: createBouwkundigElement
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -701,7 +701,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Vervangen van een BouwkundigElement op basis van overeenkomstige sleutelvelden.
operationId: replaceBouwkundigElement
parameters:
@@ -736,7 +736,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een BouwkundigElement. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateBouwkundigElement
@@ -773,7 +773,7 @@ paths:
get:
tags:
- 'BouwkundigElementen'
- description: Retourneert een BouwkundigElement met de gegeven identifier
+ summary: Retourneert een BouwkundigElement met de gegeven identifier
operationId: readBouwkundigElementById
parameters:
- name: id
@@ -810,7 +810,7 @@ paths:
put:
tags:
- 'BouwkundigElementen'
- description: Vervangen van een BouwkundigElement
+ summary: Vervangen van een BouwkundigElement
operationId: replaceBouwkundigElementById
parameters:
- name: 'id'
@@ -848,7 +848,7 @@ paths:
patch:
tags:
- 'BouwkundigElementen'
- description: Wijzigen van een BouwkundigElement
+ summary: Wijzigen van een BouwkundigElement
operationId: updateBouwkundigElementById
parameters:
- name: 'id'
@@ -887,7 +887,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Ophalen van CollectiefObjecten
+ summary: Ophalen van CollectiefObjecten
operationId: listCollectiefObjecten
parameters:
- name: params
@@ -937,7 +937,7 @@ paths:
post:
tags:
- 'CollectiefObjecten'
- description: Voegt een nieuw(e) CollectiefObject toe.
+ summary: Voegt een nieuw(e) CollectiefObject toe.
operationId: createCollectiefObject
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -977,7 +977,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Vervangen van een CollectiefObject op basis van overeenkomstige sleutelvelden.
operationId: replaceCollectiefObject
parameters:
@@ -1012,7 +1012,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een CollectiefObject. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCollectiefObject
@@ -1049,7 +1049,7 @@ paths:
get:
tags:
- 'CollectiefObjecten'
- description: Retourneert een CollectiefObject met de gegeven identifier
+ summary: Retourneert een CollectiefObject met de gegeven identifier
operationId: readCollectiefObjectById
parameters:
- name: id
@@ -1086,7 +1086,7 @@ paths:
put:
tags:
- 'CollectiefObjecten'
- description: Vervangen van een CollectiefObject
+ summary: Vervangen van een CollectiefObject
operationId: replaceCollectiefObjectById
parameters:
- name: 'id'
@@ -1124,7 +1124,7 @@ paths:
patch:
tags:
- 'CollectiefObjecten'
- description: Wijzigen van een CollectiefObject
+ summary: Wijzigen van een CollectiefObject
operationId: updateCollectiefObjectById
parameters:
- name: 'id'
@@ -1163,7 +1163,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Ophalen van Inkoopfacturen
+ summary: Ophalen van Inkoopfacturen
operationId: listInkoopfacturen
parameters:
- name: params
@@ -1213,7 +1213,7 @@ paths:
post:
tags:
- 'Inkoopfacturen'
- description: Voegt een nieuw(e) Inkoopfactuur toe.
+ summary: Voegt een nieuw(e) Inkoopfactuur toe.
operationId: createInkoopfactuur
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1253,7 +1253,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Vervangen van een Inkoopfactuur op basis van overeenkomstige sleutelvelden.
operationId: replaceInkoopfactuur
parameters:
@@ -1288,7 +1288,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inkoopfactuur. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInkoopfactuur
@@ -1325,7 +1325,7 @@ paths:
get:
tags:
- 'Inkoopfacturen'
- description: Retourneert een Inkoopfactuur met de gegeven identifier
+ summary: Retourneert een Inkoopfactuur met de gegeven identifier
operationId: readInkoopfactuurById
parameters:
- name: id
@@ -1362,7 +1362,7 @@ paths:
put:
tags:
- 'Inkoopfacturen'
- description: Vervangen van een Inkoopfactuur
+ summary: Vervangen van een Inkoopfactuur
operationId: replaceInkoopfactuurById
parameters:
- name: 'id'
@@ -1400,7 +1400,7 @@ paths:
patch:
tags:
- 'Inkoopfacturen'
- description: Wijzigen van een Inkoopfactuur
+ summary: Wijzigen van een Inkoopfactuur
operationId: updateInkoopfactuurById
parameters:
- name: 'id'
@@ -1439,7 +1439,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Ophalen van Inspectierapporten
+ summary: Ophalen van Inspectierapporten
operationId: listInspectierapporten
parameters:
- name: params
@@ -1489,7 +1489,7 @@ paths:
post:
tags:
- 'Inspectierapporten'
- description: Voegt een nieuw(e) Inspectierapport toe.
+ summary: Voegt een nieuw(e) Inspectierapport toe.
operationId: createInspectierapport
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1529,7 +1529,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Vervangen van een Inspectierapport op basis van overeenkomstige sleutelvelden.
operationId: replaceInspectierapport
parameters:
@@ -1564,7 +1564,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Inspectierapport. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateInspectierapport
@@ -1601,7 +1601,7 @@ paths:
get:
tags:
- 'Inspectierapporten'
- description: Retourneert een Inspectierapport met de gegeven identifier
+ summary: Retourneert een Inspectierapport met de gegeven identifier
operationId: readInspectierapportById
parameters:
- name: id
@@ -1638,7 +1638,7 @@ paths:
put:
tags:
- 'Inspectierapporten'
- description: Vervangen van een Inspectierapport
+ summary: Vervangen van een Inspectierapport
operationId: replaceInspectierapportById
parameters:
- name: 'id'
@@ -1676,7 +1676,7 @@ paths:
patch:
tags:
- 'Inspectierapporten'
- description: Wijzigen van een Inspectierapport
+ summary: Wijzigen van een Inspectierapport
operationId: updateInspectierapportById
parameters:
- name: 'id'
@@ -1715,7 +1715,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Ophalen van Offertes
+ summary: Ophalen van Offertes
operationId: listOffertes
parameters:
- name: params
@@ -1765,7 +1765,7 @@ paths:
post:
tags:
- 'Offertes'
- description: Voegt een nieuw(e) Offerte toe.
+ summary: Voegt een nieuw(e) Offerte toe.
operationId: createOfferte
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1805,7 +1805,7 @@ paths:
put:
tags:
- 'Offertes'
- description: |
+ summary: |
Vervangen van een Offerte op basis van overeenkomstige sleutelvelden.
operationId: replaceOfferte
parameters:
@@ -1840,7 +1840,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Offerte. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOfferte
@@ -1877,7 +1877,7 @@ paths:
get:
tags:
- 'Offertes'
- description: Retourneert een Offerte met de gegeven identifier
+ summary: Retourneert een Offerte met de gegeven identifier
operationId: readOfferteById
parameters:
- name: id
@@ -1914,7 +1914,7 @@ paths:
put:
tags:
- 'Offertes'
- description: Vervangen van een Offerte
+ summary: Vervangen van een Offerte
operationId: replaceOfferteById
parameters:
- name: 'id'
@@ -1952,7 +1952,7 @@ paths:
patch:
tags:
- 'Offertes'
- description: Wijzigen van een Offerte
+ summary: Wijzigen van een Offerte
operationId: updateOfferteById
parameters:
- name: 'id'
@@ -1991,7 +1991,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Ophalen van Onderhoudsorders
+ summary: Ophalen van Onderhoudsorders
operationId: listOnderhoudsorders
parameters:
- name: params
@@ -2041,7 +2041,7 @@ paths:
post:
tags:
- 'Onderhoudsorders'
- description: Voegt een nieuw(e) Onderhoudsorder toe.
+ summary: Voegt een nieuw(e) Onderhoudsorder toe.
operationId: createOnderhoudsorder
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2081,7 +2081,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Vervangen van een Onderhoudsorder op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsorder
parameters:
@@ -2116,7 +2116,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsorder. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsorder
@@ -2153,7 +2153,7 @@ paths:
get:
tags:
- 'Onderhoudsorders'
- description: Retourneert een Onderhoudsorder met de gegeven identifier
+ summary: Retourneert een Onderhoudsorder met de gegeven identifier
operationId: readOnderhoudsorderById
parameters:
- name: id
@@ -2190,7 +2190,7 @@ paths:
put:
tags:
- 'Onderhoudsorders'
- description: Vervangen van een Onderhoudsorder
+ summary: Vervangen van een Onderhoudsorder
operationId: replaceOnderhoudsorderById
parameters:
- name: 'id'
@@ -2228,7 +2228,7 @@ paths:
patch:
tags:
- 'Onderhoudsorders'
- description: Wijzigen van een Onderhoudsorder
+ summary: Wijzigen van een Onderhoudsorder
operationId: updateOnderhoudsorderById
parameters:
- name: 'id'
@@ -2267,7 +2267,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Ophalen van Onderhoudsverzoeken
+ summary: Ophalen van Onderhoudsverzoeken
operationId: listOnderhoudsverzoeken
parameters:
- name: params
@@ -2317,7 +2317,7 @@ paths:
post:
tags:
- 'Onderhoudsverzoeken'
- description: Voegt een nieuw(e) Onderhoudsverzoek toe.
+ summary: Voegt een nieuw(e) Onderhoudsverzoek toe.
operationId: createOnderhoudsverzoek
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2357,7 +2357,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Vervangen van een Onderhoudsverzoek op basis van overeenkomstige sleutelvelden.
operationId: replaceOnderhoudsverzoek
parameters:
@@ -2392,7 +2392,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Onderhoudsverzoek. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOnderhoudsverzoek
@@ -2429,7 +2429,7 @@ paths:
get:
tags:
- 'Onderhoudsverzoeken'
- description: Retourneert een Onderhoudsverzoek met de gegeven identifier
+ summary: Retourneert een Onderhoudsverzoek met de gegeven identifier
operationId: readOnderhoudsverzoekById
parameters:
- name: id
@@ -2466,7 +2466,7 @@ paths:
put:
tags:
- 'Onderhoudsverzoeken'
- description: Vervangen van een Onderhoudsverzoek
+ summary: Vervangen van een Onderhoudsverzoek
operationId: replaceOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -2504,7 +2504,7 @@ paths:
patch:
tags:
- 'Onderhoudsverzoeken'
- description: Wijzigen van een Onderhoudsverzoek
+ summary: Wijzigen van een Onderhoudsverzoek
operationId: updateOnderhoudsverzoekById
parameters:
- name: 'id'
@@ -2576,10 +2576,34 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ OHD.All.Read: alleen lezen van alle resources
+ OHD.All.ReadWrite: lezen en schrijven van alle resources
+ OHD.AfspraakOpties.Read: alleen lezen van AfspraakOpties
+ OHD.AfspraakOpties.ReadWrite: lezen en schrijven van AfspraakOpties
+ OHD.Afspraken.Read: alleen lezen van Afspraken
+ OHD.Afspraken.ReadWrite: lezen en schrijven van Afspraken
+ OHD.BouwkundigElementen.Read: alleen lezen van BouwkundigElementen
+ OHD.BouwkundigElementen.ReadWrite: lezen en schrijven van BouwkundigElementen
+ OHD.CollectiefObjecten.Read: alleen lezen van CollectiefObjecten
+ OHD.CollectiefObjecten.ReadWrite: lezen en schrijven van CollectiefObjecten
+ OHD.Inkoopfacturen.Read: alleen lezen van Inkoopfacturen
+ OHD.Inkoopfacturen.ReadWrite: lezen en schrijven van Inkoopfacturen
+ OHD.Inspectierapporten.Read: alleen lezen van Inspectierapporten
+ OHD.Inspectierapporten.ReadWrite: lezen en schrijven van Inspectierapporten
+ OHD.Offertes.Read: alleen lezen van Offertes
+ OHD.Offertes.ReadWrite: lezen en schrijven van Offertes
+ OHD.Onderhoudsorders.Read: alleen lezen van Onderhoudsorders
+ OHD.Onderhoudsorders.ReadWrite: lezen en schrijven van Onderhoudsorders
+ OHD.Onderhoudsverzoeken.Read: alleen lezen van Onderhoudsverzoeken
+ OHD.Onderhoudsverzoeken.ReadWrite: lezen en schrijven van Onderhoudsverzoeken
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
OHD.All.Read: alleen lezen van alle resources
OHD.All.ReadWrite: lezen en schrijven van alle resources
@@ -2710,6 +2734,10 @@ components:
type: string
format: date-time
description: De datum en tijd die het eind van een blok markeert waarbinnen de afspraak bij voorkeur start.
+ adres:
+ allOf:
+ - $ref: '#/components/schemas/AfspraakOpties-Adres'
+ description: De locatie waar de afspraak moet plaatsvindt.
afspraak:
allOf:
- $ref: '#/components/schemas/Afspraak-sleutels'
@@ -2721,7 +2749,8 @@ components:
locatie:
allOf:
- $ref: '#/components/schemas/AfspraakOpties-Adres'
- description: De locatie waar de afspraak moet plaatsvindt.
+ description: De locatie waar de afspraak moet plaatsvindt. OBSOLETE
+ deprecated: true
onderhoudsorder:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
@@ -3450,9 +3479,41 @@ components:
type: array
items:
$ref: '#/components/schemas/Afspraken-Contactgegeven'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Afspraken-Relatierol'
Afspraken-Relatie:
oneOf:
- $ref: '#/components/schemas/Afspraken-NatuurlijkPersoon'
+ Afspraken-Relatierol:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort rol van de relatie. Bijvoorbeeld Klant, Prospect, Leverancier, Medewerker, Team etc. Referentiedatasoort RELATIEROLSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van de relatie rol.
Afspraken-Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Afspraken-Contactgegeven-basis'
@@ -3670,31 +3731,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
BouwkundigElementen-Garantie:
type: object
properties:
@@ -3790,12 +3828,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -3882,12 +3920,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
status:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
BouwkundigElementen-Relatie:
oneOf:
- $ref: '#/components/schemas/BouwkundigElementen-Rechtspersoon'
@@ -4304,10 +4342,11 @@ components:
format: any
description: Extern factuurnummer van de factuur.
factuurregels:
- description: De factuurregels behorende bij deze factuur.
+ description: De factuurregels behorende bij deze factuur. OBSOLETE
type: array
items:
$ref: '#/components/schemas/Inkoopfacturen-Factuurregel'
+ deprecated: true
gRekeningbedrag:
type: number
format: float
@@ -4325,6 +4364,11 @@ components:
type: number
format: float
description: Bedrag dat nog openstaat op de factuur.
+ regels:
+ description: De factuurregels behorende bij deze factuur.
+ type: array
+ items:
+ $ref: '#/components/schemas/Inkoopfacturen-Factuurregel'
toeslag:
allOf:
- $ref: '#/components/schemas/Inkoopfacturen-Prijsaanpassing'
@@ -4835,14 +4879,20 @@ components:
format: date
description: Datum waarop de offerte is uitgebracht
offerteregels:
- description: De offerte regels van de offerte.
+ description: De offerte regels van de offerte. OBSOLETE
type: array
items:
$ref: '#/components/schemas/Offertes-Offerteregel'
+ deprecated: true
Onderhoudsorder:
allOf:
- $ref: '#/components/schemas/Onderhoudsorder-sleutels'
description: De onderhoudsorder waarvoor de offerte is opgesteld.
+ regels:
+ description: De offerte regels van de offerte.
+ type: array
+ items:
+ $ref: '#/components/schemas/Offertes-Offerteregel'
relaties:
description: Betrokken relaties bij de offerte. Bijv. de opdrachtgever of de opdrachtnemer.
type: array
@@ -5265,8 +5315,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'soort Geometrie: punt of omtrek'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
Onderhoudsorders-NatuurlijkPersoon:
allOf:
- $ref: '#/components/schemas/Onderhoudsorders-Relatie-basis'
diff --git a/docs/Ketenprocessen/VHE.yaml b/docs/Ketenprocessen/VHE.yaml
index 2dd558a..6316480 100644
--- a/docs/Ketenprocessen/VHE.yaml
+++ b/docs/Ketenprocessen/VHE.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Verhuren Eenheden
- description: API-specificatie van ketenproces 'Verhuren Eenheden'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Verhuren Eenheden'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '1.1.0+230422.8'
+ version: '1.1.1+230512.44'
servers:
- url: https://vhe.vera.io:{port}/{basePath}
description: Productieserver
@@ -31,7 +31,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -47,7 +47,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Ophalen van Clusters
+ summary: Ophalen van Clusters
operationId: listClusters
parameters:
- name: params
@@ -97,7 +97,7 @@ paths:
post:
tags:
- 'Clusters'
- description: Voegt een nieuw(e) Cluster toe.
+ summary: Voegt een nieuw(e) Cluster toe.
operationId: createCluster
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -137,7 +137,7 @@ paths:
put:
tags:
- 'Clusters'
- description: |
+ summary: |
Vervangen van een Cluster op basis van overeenkomstige sleutelvelden.
operationId: replaceCluster
parameters:
@@ -172,7 +172,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Cluster. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateCluster
@@ -209,7 +209,7 @@ paths:
get:
tags:
- 'Clusters'
- description: Retourneert een Cluster met de gegeven identifier
+ summary: Retourneert een Cluster met de gegeven identifier
operationId: readClusterById
parameters:
- name: id
@@ -246,7 +246,7 @@ paths:
put:
tags:
- 'Clusters'
- description: Vervangen van een Cluster
+ summary: Vervangen van een Cluster
operationId: replaceClusterById
parameters:
- name: 'id'
@@ -284,7 +284,7 @@ paths:
patch:
tags:
- 'Clusters'
- description: Wijzigen van een Cluster
+ summary: Wijzigen van een Cluster
operationId: updateClusterById
parameters:
- name: 'id'
@@ -323,7 +323,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Ophalen van Eenheden
+ summary: Ophalen van Eenheden
operationId: listEenheden
parameters:
- name: params
@@ -373,7 +373,7 @@ paths:
post:
tags:
- 'Eenheden'
- description: Voegt een nieuw(e) Eenheid toe.
+ summary: Voegt een nieuw(e) Eenheid toe.
operationId: createEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -413,7 +413,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: |
+ summary: |
Vervangen van een Eenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheid
parameters:
@@ -448,7 +448,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheid
@@ -485,7 +485,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Retourneert een Eenheid met de gegeven identifier
+ summary: Retourneert een Eenheid met de gegeven identifier
operationId: readEenheidById
parameters:
- name: id
@@ -522,7 +522,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: Vervangen van een Eenheid
+ summary: Vervangen van een Eenheid
operationId: replaceEenheidById
parameters:
- name: 'id'
@@ -560,7 +560,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: Wijzigen van een Eenheid
+ summary: Wijzigen van een Eenheid
operationId: updateEenheidById
parameters:
- name: 'id'
@@ -599,7 +599,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Ophalen van Huuropzeggingen
+ summary: Ophalen van Huuropzeggingen
operationId: listHuuropzeggingen
parameters:
- name: params
@@ -649,7 +649,7 @@ paths:
post:
tags:
- 'Huuropzeggingen'
- description: Voegt een nieuw(e) Huuropzegging toe.
+ summary: Voegt een nieuw(e) Huuropzegging toe.
operationId: createHuuropzegging
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -689,7 +689,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Vervangen van een Huuropzegging op basis van overeenkomstige sleutelvelden.
operationId: replaceHuuropzegging
parameters:
@@ -724,7 +724,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Huuropzegging. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateHuuropzegging
@@ -761,7 +761,7 @@ paths:
get:
tags:
- 'Huuropzeggingen'
- description: Retourneert een Huuropzegging met de gegeven identifier
+ summary: Retourneert een Huuropzegging met de gegeven identifier
operationId: readHuuropzeggingById
parameters:
- name: id
@@ -798,7 +798,7 @@ paths:
put:
tags:
- 'Huuropzeggingen'
- description: Vervangen van een Huuropzegging
+ summary: Vervangen van een Huuropzegging
operationId: replaceHuuropzeggingById
parameters:
- name: 'id'
@@ -836,7 +836,7 @@ paths:
patch:
tags:
- 'Huuropzeggingen'
- description: Wijzigen van een Huuropzegging
+ summary: Wijzigen van een Huuropzegging
operationId: updateHuuropzeggingById
parameters:
- name: 'id'
@@ -908,10 +908,22 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ VHE.All.Read: alleen lezen van alle resources
+ VHE.All.ReadWrite: lezen en schrijven van alle resources
+ VHE.Clusters.Read: alleen lezen van Clusters
+ VHE.Clusters.ReadWrite: lezen en schrijven van Clusters
+ VHE.Eenheden.Read: alleen lezen van Eenheden
+ VHE.Eenheden.ReadWrite: lezen en schrijven van Eenheden
+ VHE.Huuropzeggingen.Read: alleen lezen van Huuropzeggingen
+ VHE.Huuropzeggingen.ReadWrite: lezen en schrijven van Huuropzeggingen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
VHE.All.Read: alleen lezen van alle resources
VHE.All.ReadWrite: lezen en schrijven van alle resources
@@ -1069,31 +1081,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
- type: string
- format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
- type: string
- format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Relatie-sleutels:
type: object
properties:
@@ -1115,12 +1104,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -1486,10 +1475,11 @@ components:
format: float
description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
clusters:
description: De clusters waar de eenheid onderdeel van uitmaakt.
type: array
@@ -1569,15 +1559,17 @@ components:
items:
$ref: '#/components/schemas/Referentiedata'
liggingBuitenruimten:
- description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
+ description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. OBSOLETE Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -1618,6 +1610,11 @@ components:
type: array
items:
$ref: '#/components/schemas/Eenheden-Relatie'
+ ruimten:
+ description: De verschillende ruimtes behorend bij de eenheid Bij. 'Achtertuin' of 'Woonkamer'.
+ type: array
+ items:
+ $ref: '#/components/schemas/Eenheden-Ruimte'
sanitair:
description: Sanitaire voorzieningen Referentiedatasoort EENHEIDSANITAIR.
type: array
@@ -1630,7 +1627,7 @@ components:
toegankelijkheidslabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKSHEIDSLABEL.
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
totaleOppervlakte:
type: number
format: float
@@ -1643,10 +1640,11 @@ components:
type: boolean
description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
vertrekken:
- description: De ruimten behorend bij de eenheid.
+ description: De ruimten behorend bij de eenheid. OBSOLETE
type: array
items:
$ref: '#/components/schemas/Eenheden-Vertrek'
+ deprecated: true
vertrekkenAantal:
type: integer
format: int32
@@ -1655,6 +1653,10 @@ components:
type: integer
format: int32
description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
volgnummer:
type: string
format: any
@@ -2042,6 +2044,49 @@ components:
type: string
format: any
description: De naam van de relatie rol.
+ Eenheden-Ruimte:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort ruimte. Ruimtes worden verdeeld in vertrekken die meetellen voor de woningwaardering, buitenruimtes en overige ruimtes. Referentiedatasoort RUIMTESOORT.
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het detailsoort van de ruimte. Bijv. Slaapkamer, Dakteras, Tuin etc. Referentiedatasoort RUIMTEDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De omschrijving van de ruimte.
+ inhoud:
+ type: number
+ format: float
+ description: De inhoud van de ruimte in m3.
+ ligging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
+ oppervlakte:
+ type: number
+ format: float
+ description: De oppervlakte van de ruimte
Eenheden-Stadsdeel:
type: object
properties:
diff --git a/docs/Ketenprocessen/WRV.yaml b/docs/Ketenprocessen/WRV.yaml
index 6fb2b41..ce06189 100644
--- a/docs/Ketenprocessen/WRV.yaml
+++ b/docs/Ketenprocessen/WRV.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: VERA-Woonruimteverdeling
- description: API-specificatie van ketenproces 'Woonruimteverdeling'. Deze specificatie is gebaseerd op VERA versie 4.1.0+230422.8
+ description: API-specificatie van ketenproces 'Woonruimteverdeling'. Deze specificatie is gebaseerd op VERA versie 4.1.1+230512.44
contact:
name: VERA
url: https://cora.wikixl.nl/index.php/VERA_Standaard
@@ -9,7 +9,7 @@ info:
license:
name: "Copyright (c) Aedes vereniging van woningcorporaties"
url: https://raw.githubusercontent.com/Aedes-datastandaarden/vera-openapi/main/LICENSE
- version: '3.1.0+230422.8'
+ version: '3.1.1+230512.44'
servers:
- url: https://wrv.vera.io:{port}/{basePath}
description: Productieserver
@@ -51,7 +51,7 @@ tags:
paths:
/ping:
get:
- description: |
+ summary: |
Een ping wordt beantwoord met response code 200
operationId: ping
responses:
@@ -67,7 +67,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Ophalen van Aanbiedingen
+ summary: Ophalen van Aanbiedingen
operationId: listAanbiedingen
parameters:
- name: params
@@ -117,7 +117,7 @@ paths:
post:
tags:
- 'Aanbiedingen'
- description: Voegt een nieuw(e) Aanbieding toe.
+ summary: Voegt een nieuw(e) Aanbieding toe.
operationId: createAanbieding
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -157,7 +157,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Vervangen van een Aanbieding op basis van overeenkomstige sleutelvelden.
operationId: replaceAanbieding
parameters:
@@ -192,7 +192,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Aanbieding. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateAanbieding
@@ -229,7 +229,7 @@ paths:
get:
tags:
- 'Aanbiedingen'
- description: Retourneert een Aanbieding met de gegeven identifier
+ summary: Retourneert een Aanbieding met de gegeven identifier
operationId: readAanbiedingById
parameters:
- name: id
@@ -266,7 +266,7 @@ paths:
put:
tags:
- 'Aanbiedingen'
- description: Vervangen van een Aanbieding
+ summary: Vervangen van een Aanbieding
operationId: replaceAanbiedingById
parameters:
- name: 'id'
@@ -304,7 +304,7 @@ paths:
patch:
tags:
- 'Aanbiedingen'
- description: Wijzigen van een Aanbieding
+ summary: Wijzigen van een Aanbieding
operationId: updateAanbiedingById
parameters:
- name: 'id'
@@ -343,7 +343,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Ophalen van Eenheden
+ summary: Ophalen van Eenheden
operationId: listEenheden
parameters:
- name: params
@@ -393,7 +393,7 @@ paths:
post:
tags:
- 'Eenheden'
- description: Voegt een nieuw(e) Eenheid toe.
+ summary: Voegt een nieuw(e) Eenheid toe.
operationId: createEenheid
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -433,7 +433,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: |
+ summary: |
Vervangen van een Eenheid op basis van overeenkomstige sleutelvelden.
operationId: replaceEenheid
parameters:
@@ -468,7 +468,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Eenheid. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateEenheid
@@ -505,7 +505,7 @@ paths:
get:
tags:
- 'Eenheden'
- description: Retourneert een Eenheid met de gegeven identifier
+ summary: Retourneert een Eenheid met de gegeven identifier
operationId: readEenheidById
parameters:
- name: id
@@ -542,7 +542,7 @@ paths:
put:
tags:
- 'Eenheden'
- description: Vervangen van een Eenheid
+ summary: Vervangen van een Eenheid
operationId: replaceEenheidById
parameters:
- name: 'id'
@@ -580,7 +580,7 @@ paths:
patch:
tags:
- 'Eenheden'
- description: Wijzigen van een Eenheid
+ summary: Wijzigen van een Eenheid
operationId: updateEenheidById
parameters:
- name: 'id'
@@ -619,7 +619,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Ophalen van Gebeurtenissen
+ summary: Ophalen van Gebeurtenissen
operationId: listGebeurtenissen
parameters:
- name: params
@@ -669,7 +669,7 @@ paths:
post:
tags:
- 'Gebeurtenissen'
- description: Voegt een nieuw(e) Gebeurtenis toe.
+ summary: Voegt een nieuw(e) Gebeurtenis toe.
operationId: createGebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -709,7 +709,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Vervangen van een Gebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replaceGebeurtenis
parameters:
@@ -744,7 +744,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Gebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateGebeurtenis
@@ -781,7 +781,7 @@ paths:
get:
tags:
- 'Gebeurtenissen'
- description: Retourneert een Gebeurtenis met de gegeven identifier
+ summary: Retourneert een Gebeurtenis met de gegeven identifier
operationId: readGebeurtenisById
parameters:
- name: id
@@ -818,7 +818,7 @@ paths:
put:
tags:
- 'Gebeurtenissen'
- description: Vervangen van een Gebeurtenis
+ summary: Vervangen van een Gebeurtenis
operationId: replaceGebeurtenisById
parameters:
- name: 'id'
@@ -856,7 +856,7 @@ paths:
patch:
tags:
- 'Gebeurtenissen'
- description: Wijzigen van een Gebeurtenis
+ summary: Wijzigen van een Gebeurtenis
operationId: updateGebeurtenisById
parameters:
- name: 'id'
@@ -895,7 +895,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Ophalen van Kandidaten
+ summary: Ophalen van Kandidaten
operationId: listKandidaten
parameters:
- name: params
@@ -945,7 +945,7 @@ paths:
post:
tags:
- 'Kandidaten'
- description: Voegt een nieuw(e) Kandidaat toe.
+ summary: Voegt een nieuw(e) Kandidaat toe.
operationId: createKandidaat
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -985,7 +985,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Vervangen van een Kandidaat op basis van overeenkomstige sleutelvelden.
operationId: replaceKandidaat
parameters:
@@ -1020,7 +1020,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Kandidaat. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateKandidaat
@@ -1057,7 +1057,7 @@ paths:
get:
tags:
- 'Kandidaten'
- description: Retourneert een Kandidaat met de gegeven identifier
+ summary: Retourneert een Kandidaat met de gegeven identifier
operationId: readKandidaatById
parameters:
- name: id
@@ -1094,7 +1094,7 @@ paths:
put:
tags:
- 'Kandidaten'
- description: Vervangen van een Kandidaat
+ summary: Vervangen van een Kandidaat
operationId: replaceKandidaatById
parameters:
- name: 'id'
@@ -1132,7 +1132,7 @@ paths:
patch:
tags:
- 'Kandidaten'
- description: Wijzigen van een Kandidaat
+ summary: Wijzigen van een Kandidaat
operationId: updateKandidaatById
parameters:
- name: 'id'
@@ -1171,7 +1171,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Ophalen van Overeenkomsten
+ summary: Ophalen van Overeenkomsten
operationId: listOvereenkomsten
parameters:
- name: params
@@ -1221,7 +1221,7 @@ paths:
post:
tags:
- 'Overeenkomsten'
- description: Voegt een nieuw(e) Overeenkomst toe.
+ summary: Voegt een nieuw(e) Overeenkomst toe.
operationId: createOvereenkomst
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1261,7 +1261,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Vervangen van een Overeenkomst op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomst
parameters:
@@ -1296,7 +1296,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomst. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomst
@@ -1333,7 +1333,7 @@ paths:
get:
tags:
- 'Overeenkomsten'
- description: Retourneert een Overeenkomst met de gegeven identifier
+ summary: Retourneert een Overeenkomst met de gegeven identifier
operationId: readOvereenkomstById
parameters:
- name: id
@@ -1370,7 +1370,7 @@ paths:
put:
tags:
- 'Overeenkomsten'
- description: Vervangen van een Overeenkomst
+ summary: Vervangen van een Overeenkomst
operationId: replaceOvereenkomstById
parameters:
- name: 'id'
@@ -1408,7 +1408,7 @@ paths:
patch:
tags:
- 'Overeenkomsten'
- description: Wijzigen van een Overeenkomst
+ summary: Wijzigen van een Overeenkomst
operationId: updateOvereenkomstById
parameters:
- name: 'id'
@@ -1447,7 +1447,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Ophalen van Overeenkomstkoppelingen
+ summary: Ophalen van Overeenkomstkoppelingen
operationId: listOvereenkomstkoppelingen
parameters:
- name: params
@@ -1497,7 +1497,7 @@ paths:
post:
tags:
- 'Overeenkomstkoppelingen'
- description: Voegt een nieuw(e) Overeenkomstkoppeling toe.
+ summary: Voegt een nieuw(e) Overeenkomstkoppeling toe.
operationId: createOvereenkomstkoppeling
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1537,7 +1537,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Vervangen van een Overeenkomstkoppeling op basis van overeenkomstige sleutelvelden.
operationId: replaceOvereenkomstkoppeling
parameters:
@@ -1572,7 +1572,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Overeenkomstkoppeling. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateOvereenkomstkoppeling
@@ -1609,7 +1609,7 @@ paths:
get:
tags:
- 'Overeenkomstkoppelingen'
- description: Retourneert een Overeenkomstkoppeling met de gegeven identifier
+ summary: Retourneert een Overeenkomstkoppeling met de gegeven identifier
operationId: readOvereenkomstkoppelingById
parameters:
- name: id
@@ -1646,7 +1646,7 @@ paths:
put:
tags:
- 'Overeenkomstkoppelingen'
- description: Vervangen van een Overeenkomstkoppeling
+ summary: Vervangen van een Overeenkomstkoppeling
operationId: replaceOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -1684,7 +1684,7 @@ paths:
patch:
tags:
- 'Overeenkomstkoppelingen'
- description: Wijzigen van een Overeenkomstkoppeling
+ summary: Wijzigen van een Overeenkomstkoppeling
operationId: updateOvereenkomstkoppelingById
parameters:
- name: 'id'
@@ -1723,7 +1723,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Ophalen van Publicaties
+ summary: Ophalen van Publicaties
operationId: listPublicaties
parameters:
- name: params
@@ -1773,7 +1773,7 @@ paths:
post:
tags:
- 'Publicaties'
- description: Voegt een nieuw(e) Publicatie toe.
+ summary: Voegt een nieuw(e) Publicatie toe.
operationId: createPublicatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -1813,7 +1813,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: |
+ summary: |
Vervangen van een Publicatie op basis van overeenkomstige sleutelvelden.
operationId: replacePublicatie
parameters:
@@ -1848,7 +1848,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Publicatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePublicatie
@@ -1885,7 +1885,7 @@ paths:
get:
tags:
- 'Publicaties'
- description: Retourneert een Publicatie met de gegeven identifier
+ summary: Retourneert een Publicatie met de gegeven identifier
operationId: readPublicatieById
parameters:
- name: id
@@ -1922,7 +1922,7 @@ paths:
put:
tags:
- 'Publicaties'
- description: Vervangen van een Publicatie
+ summary: Vervangen van een Publicatie
operationId: replacePublicatieById
parameters:
- name: 'id'
@@ -1960,7 +1960,7 @@ paths:
patch:
tags:
- 'Publicaties'
- description: Wijzigen van een Publicatie
+ summary: Wijzigen van een Publicatie
operationId: updatePublicatieById
parameters:
- name: 'id'
@@ -1999,7 +1999,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Ophalen van Puntenberekeningen
+ summary: Ophalen van Puntenberekeningen
operationId: listPuntenberekeningen
parameters:
- name: params
@@ -2049,7 +2049,7 @@ paths:
post:
tags:
- 'Puntenberekeningen'
- description: Voegt een nieuw(e) Puntenberekening toe.
+ summary: Voegt een nieuw(e) Puntenberekening toe.
operationId: createPuntenberekening
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2089,7 +2089,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Vervangen van een Puntenberekening op basis van overeenkomstige sleutelvelden.
operationId: replacePuntenberekening
parameters:
@@ -2124,7 +2124,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntenberekening. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntenberekening
@@ -2161,7 +2161,7 @@ paths:
get:
tags:
- 'Puntenberekeningen'
- description: Retourneert een Puntenberekening met de gegeven identifier
+ summary: Retourneert een Puntenberekening met de gegeven identifier
operationId: readPuntenberekeningById
parameters:
- name: id
@@ -2198,7 +2198,7 @@ paths:
put:
tags:
- 'Puntenberekeningen'
- description: Vervangen van een Puntenberekening
+ summary: Vervangen van een Puntenberekening
operationId: replacePuntenberekeningById
parameters:
- name: 'id'
@@ -2236,7 +2236,7 @@ paths:
patch:
tags:
- 'Puntenberekeningen'
- description: Wijzigen van een Puntenberekening
+ summary: Wijzigen van een Puntenberekening
operationId: updatePuntenberekeningById
parameters:
- name: 'id'
@@ -2275,7 +2275,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Ophalen van Puntengebeurtenissen
+ summary: Ophalen van Puntengebeurtenissen
operationId: listPuntengebeurtenissen
parameters:
- name: params
@@ -2325,7 +2325,7 @@ paths:
post:
tags:
- 'Puntengebeurtenissen'
- description: Voegt een nieuw(e) Puntengebeurtenis toe.
+ summary: Voegt een nieuw(e) Puntengebeurtenis toe.
operationId: createPuntengebeurtenis
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2365,7 +2365,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Vervangen van een Puntengebeurtenis op basis van overeenkomstige sleutelvelden.
operationId: replacePuntengebeurtenis
parameters:
@@ -2400,7 +2400,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Puntengebeurtenis. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updatePuntengebeurtenis
@@ -2437,7 +2437,7 @@ paths:
get:
tags:
- 'Puntengebeurtenissen'
- description: Retourneert een Puntengebeurtenis met de gegeven identifier
+ summary: Retourneert een Puntengebeurtenis met de gegeven identifier
operationId: readPuntengebeurtenisById
parameters:
- name: id
@@ -2474,7 +2474,7 @@ paths:
put:
tags:
- 'Puntengebeurtenissen'
- description: Vervangen van een Puntengebeurtenis
+ summary: Vervangen van een Puntengebeurtenis
operationId: replacePuntengebeurtenisById
parameters:
- name: 'id'
@@ -2512,7 +2512,7 @@ paths:
patch:
tags:
- 'Puntengebeurtenissen'
- description: Wijzigen van een Puntengebeurtenis
+ summary: Wijzigen van een Puntengebeurtenis
operationId: updatePuntengebeurtenisById
parameters:
- name: 'id'
@@ -2551,7 +2551,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Ophalen van Reclamaties
+ summary: Ophalen van Reclamaties
operationId: listReclamaties
parameters:
- name: params
@@ -2601,7 +2601,7 @@ paths:
post:
tags:
- 'Reclamaties'
- description: Voegt een nieuw(e) Reclamatie toe.
+ summary: Voegt een nieuw(e) Reclamatie toe.
operationId: createReclamatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2641,7 +2641,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Vervangen van een Reclamatie op basis van overeenkomstige sleutelvelden.
operationId: replaceReclamatie
parameters:
@@ -2676,7 +2676,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Reclamatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateReclamatie
@@ -2713,7 +2713,7 @@ paths:
get:
tags:
- 'Reclamaties'
- description: Retourneert een Reclamatie met de gegeven identifier
+ summary: Retourneert een Reclamatie met de gegeven identifier
operationId: readReclamatieById
parameters:
- name: id
@@ -2750,7 +2750,7 @@ paths:
put:
tags:
- 'Reclamaties'
- description: Vervangen van een Reclamatie
+ summary: Vervangen van een Reclamatie
operationId: replaceReclamatieById
parameters:
- name: 'id'
@@ -2788,7 +2788,7 @@ paths:
patch:
tags:
- 'Reclamaties'
- description: Wijzigen van een Reclamatie
+ summary: Wijzigen van een Reclamatie
operationId: updateReclamatieById
parameters:
- name: 'id'
@@ -2827,7 +2827,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Ophalen van Relaties
+ summary: Ophalen van Relaties
operationId: listRelaties
parameters:
- name: params
@@ -2877,7 +2877,7 @@ paths:
post:
tags:
- 'Relaties'
- description: Voegt een nieuw(e) Relatie toe.
+ summary: Voegt een nieuw(e) Relatie toe.
operationId: createRelatie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -2917,7 +2917,7 @@ paths:
put:
tags:
- 'Relaties'
- description: |
+ summary: |
Vervangen van een Relatie op basis van overeenkomstige sleutelvelden.
operationId: replaceRelatie
parameters:
@@ -2952,7 +2952,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Relatie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateRelatie
@@ -2989,7 +2989,7 @@ paths:
get:
tags:
- 'Relaties'
- description: Retourneert een Relatie met de gegeven identifier
+ summary: Retourneert een Relatie met de gegeven identifier
operationId: readRelatieById
parameters:
- name: id
@@ -3026,7 +3026,7 @@ paths:
put:
tags:
- 'Relaties'
- description: Vervangen van een Relatie
+ summary: Vervangen van een Relatie
operationId: replaceRelatieById
parameters:
- name: 'id'
@@ -3064,7 +3064,7 @@ paths:
patch:
tags:
- 'Relaties'
- description: Wijzigen van een Relatie
+ summary: Wijzigen van een Relatie
operationId: updateRelatieById
parameters:
- name: 'id'
@@ -3103,7 +3103,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Ophalen van Sancties
+ summary: Ophalen van Sancties
operationId: listSancties
parameters:
- name: params
@@ -3153,7 +3153,7 @@ paths:
post:
tags:
- 'Sancties'
- description: Voegt een nieuw(e) Sanctie toe.
+ summary: Voegt een nieuw(e) Sanctie toe.
operationId: createSanctie
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3193,7 +3193,7 @@ paths:
put:
tags:
- 'Sancties'
- description: |
+ summary: |
Vervangen van een Sanctie op basis van overeenkomstige sleutelvelden.
operationId: replaceSanctie
parameters:
@@ -3228,7 +3228,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Sanctie. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateSanctie
@@ -3265,7 +3265,7 @@ paths:
get:
tags:
- 'Sancties'
- description: Retourneert een Sanctie met de gegeven identifier
+ summary: Retourneert een Sanctie met de gegeven identifier
operationId: readSanctieById
parameters:
- name: id
@@ -3302,7 +3302,7 @@ paths:
put:
tags:
- 'Sancties'
- description: Vervangen van een Sanctie
+ summary: Vervangen van een Sanctie
operationId: replaceSanctieById
parameters:
- name: 'id'
@@ -3340,7 +3340,7 @@ paths:
patch:
tags:
- 'Sancties'
- description: Wijzigen van een Sanctie
+ summary: Wijzigen van een Sanctie
operationId: updateSanctieById
parameters:
- name: 'id'
@@ -3379,7 +3379,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Ophalen van Toewijzingen
+ summary: Ophalen van Toewijzingen
operationId: listToewijzingen
parameters:
- name: params
@@ -3429,7 +3429,7 @@ paths:
post:
tags:
- 'Toewijzingen'
- description: Voegt een nieuw(e) Toewijzing toe.
+ summary: Voegt een nieuw(e) Toewijzing toe.
operationId: createToewijzing
parameters:
- $ref: '#/components/parameters/StuurgegevensZenderOrganisatie'
@@ -3469,7 +3469,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Vervangen van een Toewijzing op basis van overeenkomstige sleutelvelden.
operationId: replaceToewijzing
parameters:
@@ -3504,7 +3504,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: |
+ summary: |
Wijzigen van afzonderlijke attributen van een Toewijzing. In de meegestuurde entiteit moeten
sleutelvelden aanwezig zijn.
operationId: updateToewijzing
@@ -3541,7 +3541,7 @@ paths:
get:
tags:
- 'Toewijzingen'
- description: Retourneert een Toewijzing met de gegeven identifier
+ summary: Retourneert een Toewijzing met de gegeven identifier
operationId: readToewijzingById
parameters:
- name: id
@@ -3578,7 +3578,7 @@ paths:
put:
tags:
- 'Toewijzingen'
- description: Vervangen van een Toewijzing
+ summary: Vervangen van een Toewijzing
operationId: replaceToewijzingById
parameters:
- name: 'id'
@@ -3616,7 +3616,7 @@ paths:
patch:
tags:
- 'Toewijzingen'
- description: Wijzigen van een Toewijzing
+ summary: Wijzigen van een Toewijzing
operationId: updateToewijzingById
parameters:
- name: 'id'
@@ -3688,10 +3688,42 @@ components:
name: X-API-KEY
OAuth2:
type: oauth2
- description: Deze API gebruikt OAuth2 met 'implicit grant flow'.)
+ description: Deze API ondersteunt OAuth2 met flows Authorization Code en Client Credentials
flows:
- implicit:
- authorizationUrl: https://api.vera.nl/oauth2/authorize
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ scopes:
+ WRV.All.Read: alleen lezen van alle resources
+ WRV.All.ReadWrite: lezen en schrijven van alle resources
+ WRV.Aanbiedingen.Read: alleen lezen van Aanbiedingen
+ WRV.Aanbiedingen.ReadWrite: lezen en schrijven van Aanbiedingen
+ WRV.Eenheden.Read: alleen lezen van Eenheden
+ WRV.Eenheden.ReadWrite: lezen en schrijven van Eenheden
+ WRV.Gebeurtenissen.Read: alleen lezen van Gebeurtenissen
+ WRV.Gebeurtenissen.ReadWrite: lezen en schrijven van Gebeurtenissen
+ WRV.Kandidaten.Read: alleen lezen van Kandidaten
+ WRV.Kandidaten.ReadWrite: lezen en schrijven van Kandidaten
+ WRV.Overeenkomsten.Read: alleen lezen van Overeenkomsten
+ WRV.Overeenkomsten.ReadWrite: lezen en schrijven van Overeenkomsten
+ WRV.Overeenkomstkoppelingen.Read: alleen lezen van Overeenkomstkoppelingen
+ WRV.Overeenkomstkoppelingen.ReadWrite: lezen en schrijven van Overeenkomstkoppelingen
+ WRV.Publicaties.Read: alleen lezen van Publicaties
+ WRV.Publicaties.ReadWrite: lezen en schrijven van Publicaties
+ WRV.Puntenberekeningen.Read: alleen lezen van Puntenberekeningen
+ WRV.Puntenberekeningen.ReadWrite: lezen en schrijven van Puntenberekeningen
+ WRV.Puntengebeurtenissen.Read: alleen lezen van Puntengebeurtenissen
+ WRV.Puntengebeurtenissen.ReadWrite: lezen en schrijven van Puntengebeurtenissen
+ WRV.Reclamaties.Read: alleen lezen van Reclamaties
+ WRV.Reclamaties.ReadWrite: lezen en schrijven van Reclamaties
+ WRV.Relaties.Read: alleen lezen van Relaties
+ WRV.Relaties.ReadWrite: lezen en schrijven van Relaties
+ WRV.Sancties.Read: alleen lezen van Sancties
+ WRV.Sancties.ReadWrite: lezen en schrijven van Sancties
+ WRV.Toewijzingen.Read: alleen lezen van Toewijzingen
+ WRV.Toewijzingen.ReadWrite: lezen en schrijven van Toewijzingen
+ clientCredentials:
+ tokenUrl: /oauth/token
scopes:
WRV.All.Read: alleen lezen van alle resources
WRV.All.ReadWrite: lezen en schrijven van alle resources
@@ -3771,7 +3803,7 @@ components:
description: De publicatie naar aanleiding waarvan de aanbieding is gedaan.
relatie:
allOf:
- - $ref: '#/components/schemas/Relatie-sleutels'
+ - $ref: '#/components/schemas/Aanbiedingen-Relatie'
description: Het huishouden behorend bij de aanbieding.
Referentiedata:
type: object
@@ -3803,7 +3835,7 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Relatie-sleutels:
+ Aanbiedingen-Contactgegeven:
type: object
properties:
id:
@@ -3824,41 +3856,42 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
- rollen:
- description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
- type: array
- items:
- $ref: '#/components/schemas/Relatierol-sleutels'
- Referentiedata-sleutels:
- type: object
- properties:
- id:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
- idExtern:
- type: string
- format: any
- description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
- idGegevensbeheerder:
- type: string
- format: any
- description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- code:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
+ omschrijving:
type: string
format: any
- description: De unieke code (Bijvoorbeeld om te tonen of te zoeken) Bijvoorbeeld NL.
- naam:
+ description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
+ relatie:
+ allOf:
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: De relatie behorend bij het contactgegeven. OBSOLETE
+ deprecated: true
+ relatierol:
+ allOf:
+ - $ref: '#/components/schemas/Aanbiedingen-Relatierol'
+ description: De relatie rol van de relatie behorend bij het contactgegeven.
+ vertrouwelijkheid:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
+ voorkeur:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
+ waarde:
type: string
format: any
- description: De te tonen waarde van het referentiedata item. Bijvoorbeeld Nederlandse.
- Relatierol-sleutels:
+ description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
+ Relatie-sleutels:
type: object
properties:
id:
@@ -3877,7 +3910,20 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- Aanbiedingen-Contactgegeven:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
+ rollen:
+ description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relatierol-sleutels'
+ Relatierol-sleutels:
type: object
properties:
id:
@@ -3896,42 +3942,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- soort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort communicatie. Bijvoorbeeld: Telefoon, E-mail, .Social media etc. Referentiedatasoort CONTACTGEGEVENSOORT.'
- detailSoort:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Het soort detail communicatie. Bijvoorbeeld: Mobiel, privé, werk. Referentiedatasoort CONTACTGEGEVENDETAILSOORT.'
- omschrijving:
- type: string
- format: any
- description: Korte omschrijving van het contactgegeven. Bijv. Telefoonnummer partner.
- status:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De status van het contactgegeven. Bijv. Aangemaakt, Gevalideerd, Ongeldig etc. Referentiedatasoort CONTACTGEGEVENSTATUS.
- relatie:
- allOf:
- - $ref: '#/components/schemas/Aanbiedingen-Relatie'
- description: De relatie behorend bij het contactgegeven.
- relatierol:
- allOf:
- - $ref: '#/components/schemas/Aanbiedingen-Relatierol'
- description: De relatie rol van de relatie behorend bij het contactgegeven.
- vertrouwelijkheid:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: De classificatie van het vertrouwelijkheidsniveau. Referentiedatasoort VERTROUWELIJKHEID.
- voorkeur:
- allOf:
- - $ref: '#/components/schemas/Referentiedata'
- description: 'Voorkeur binnen hetzelfde soort contactgegeven. Bij meerdere emailadressen kan bijvoorbeeld aangegeven worden welk emailadres primair gebruikt moet worden. Bijvoorbeeld: 1e voorkeur, 2e voorkeur. Referentiedatasoort CONTACTGEGEVENVOORKEUR.'
- waarde:
- type: string
- format: any
- description: 'De aard van het contactgegeven. Dit kan de waarde zijn van een telefoonnummer, emailadres, of twitteradres. Bijvoorbeeld: 020-1234563'
Aanbiedingen-Contactmoment:
type: object
properties:
@@ -4323,10 +4333,11 @@ components:
format: float
description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
clusters:
description: De clusters waar de eenheid onderdeel van uitmaakt.
type: array
@@ -4393,15 +4404,17 @@ components:
items:
$ref: '#/components/schemas/Referentiedata'
liggingBuitenruimten:
- description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc.. Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
+ description: De ligging van de buitenruimte. Bijv. zuiden, noorden etc. OBSOLETE Referentiedatasoort EENHEIDLIGGINGBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -4432,7 +4445,7 @@ components:
publicatieLabel:
type: string
format: any
- description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning etc.
+ description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning, Appartement etc.
rekenhuur:
type: number
format: float
@@ -4467,7 +4480,7 @@ components:
toegankelijkheidslabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKSHEIDSLABEL.
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
totaalInhoud:
type: number
format: float
@@ -4497,6 +4510,10 @@ components:
type: integer
format: int32
description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
voorwaarden:
allOf:
- $ref: '#/components/schemas/Eenheden-EenheidVoorwaarden'
@@ -4530,6 +4547,14 @@ components:
- $ref: '#/components/schemas/Eenheden-Adres-basis'
- type: object
properties:
+ buurt:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Buurt'
+ description: De buurt behorend bij het adres.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Gemeente'
+ description: De gemeente behorend bij het adres.
geometrie:
allOf:
- $ref: '#/components/schemas/Eenheden-Geometrie'
@@ -4538,6 +4563,18 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ provincie:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De provincie behorend bij het adres. Referentiedatasoort PROVINCIE.
+ stadsdeel:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Stadsdeel'
+ description: Het stadsdeel behorend bij het adres.
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Eenheden-Wijk'
+ description: De wijk behorend bij het adres.
woonplaats:
allOf:
- $ref: '#/components/schemas/Eenheden-Woonplaats'
@@ -4565,6 +4602,10 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het soort criterium op basis waarvan de woning passend is of waarop men voorang kan krijgen. Referentiedatasoort EENHEIDCRITERIUMDETAILSOORT.
+ naam:
+ type: string
+ format: any
+ description: De naam van het criterium.
aantalBovengrens:
type: number
format: float
@@ -4879,10 +4920,6 @@ components:
type: string
format: any
description: De omschrijving van de ruimte.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Eenheden-Eenheid'
- description: De eenheid behorend bij de ruimte.
inhoud:
type: number
format: float
@@ -4890,11 +4927,22 @@ components:
ligging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De ligging van de ruimte. Referentiedatasoort EENHEIDLIGGINGRUIMTE.
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
oppervlakte:
type: number
format: float
description: De oppervlakte van de ruimte
+ Eenheden-Stadsdeel:
+ type: object
+ properties:
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van het stadsdeel.
Eenheden-Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Eenheden-Contactgegeven-basis'
@@ -5074,8 +5122,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'soort Geometrie: punt of omtrek'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'soort Geometrie: punt of omtrek Referentiedatasoort GEOMETRIESOORT.'
Woonplaats-sleutels:
type: object
properties:
@@ -5291,6 +5339,37 @@ components:
- $ref: '#/components/schemas/Kandidaten-Eenheidadres'
- $ref: '#/components/schemas/Kandidaten-Postadres'
- $ref: '#/components/schemas/Kandidaten-Adres-basis'
+ Kandidaten-AuthentiekGegeven:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft het gegevens type aan. Bijvoorbeeld geregistreerde inkomens, actueel inkomen, woongeschiedenis, naw. Referentiedatasoort AUTHENTIEKGEGEVENSOORT.
+ bron:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Geeft de bron van het gegeven aan. Bijv. MijnOverheid, Qii, IRF etc. Referentiedatasoort AUTHENTIEKGEGEVENBRONSOORT.
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor de gegevens geldig zijn.
+ token:
+ type: string
+ format: any
+ description: Een eigen validatietoken op de gegevens.
Kandidaten-BuitenlandsAdres:
allOf:
- $ref: '#/components/schemas/Kandidaten-Adres-basis'
@@ -5445,14 +5524,22 @@ components:
type: string
format: any
description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
- nettoMaandinkomen:
- type: number
- format: float
- description: Het netto maandinkomen in euro's van de natuurlijk persoon.
- brutoMaandinkomen:
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort inkomen. Bijv. netto of bruto maand of jaarinkomen. Referentiedatasoort INKOMENSSOORT.
+ controledatum:
+ type: string
+ format: date-time
+ description: De datum en tijd waarop de inkomensgegevens zijn gecontroleerd.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
+ bedrag:
type: number
format: float
- description: Het bruto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het bedrag van het inkomen.
bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5460,15 +5547,27 @@ components:
brutoJaarinkomen:
type: number
format: float
- description: Het bruto jaarinkomen in euro's van de natuurlijk persoon.
- controledatum:
- type: string
- format: date-time
- description: De datum en tijd waarop de inkomensgegevens zijn gecontroleerd.
+ description: Het bruto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
+ brutoMaandinkomen:
+ type: number
+ format: float
+ description: Het bruto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
+ jaar:
+ type: integer
+ format: int32
+ description: Het jaar waarvoor het inkomen geldig is.
nettoJaarinkomen:
type: number
format: float
- description: Het netto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het netto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
+ nettoMaandinkomen:
+ type: number
+ format: float
+ description: Het netto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
Kandidaten-Inschrijving:
allOf:
- $ref: '#/components/schemas/Kandidaten-Overeenkomst-basis'
@@ -5625,6 +5724,10 @@ components:
type: string
format: any
description: De tussenvoegsels behorende bij de naam.
+ voorrangsregelingen:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-Voorrangsregeling'
+ description: 'De voorrangsregels waar de natuurlijk persoon gebruik van maakt. Bijvoorbeeld: Bindingen, indicaties, urgenties en overige voorrangsregelingen. De klasse voorrangsregeling bevindt zich in het woonruimteverdeling domein.'
woonsituatie:
allOf:
- $ref: '#/components/schemas/Kandidaten-Woonsituatie'
@@ -5656,6 +5759,10 @@ components:
type: string
format: date
description: De einddatum waarop de studie is beëindigd.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
instelling:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -5907,6 +6014,226 @@ components:
type: string
format: date-time
description: De einddatum van de signalering.
+ Kandidaten-Voorrangsregeling:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ soort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort voorrang. Bijvoorbeeld: Urgentie, binding, indicatie of groep. Referentiedatasoort VOORRANGSOORT.'
+ detailSoort:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail soort voorrang. Bijvoorbeeld: medisch, financieel, economisch, relationeel, huisvesting, gezinssituatie of student. Referentiedatasoort VOORRANGDETAILSOORT.'
+ naam:
+ type: string
+ format: any
+ description: De naam van de specifieke voorrangsregeling
+ begindatum:
+ type: string
+ format: date-time
+ description: De begindatum die aangeeft vanaf wanneer men deze voorrang heeft.
+ einddatum:
+ type: string
+ format: date-time
+ description: De einddatum tot wanneer men deze voorrang heeft.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
+ profiel:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-VoorrangsregelingProfiel'
+ description: Het profiel waarop de voorrang van toepassing is.
+ Kandidaten-VoorrangsregelingProfiel:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ buurten:
+ description: De buurten waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Buurt-sleutels'
+ eenheidSoorten:
+ description: De eenheid soorten waar het voorrangsregeling profiel voor geldt. Referentiedatasoort VOORRANGEENHEIDSOORT.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ gemeenten:
+ description: De gemeenten waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Gemeente-sleutels'
+ huidigeOppervlakte:
+ type: integer
+ format: int32
+ description: De voorrang die wordt gegeven op basis van huidige woonoppervlakte in m2.
+ huidigeVerdieping:
+ type: integer
+ format: int32
+ description: De voorrang die wordt gegeven op basis van huidige verdieping.
+ huurInkomenTabel:
+ type: boolean
+ description: De aanduiding die aangeeft dat er sprake is van voorrang voor eenheden die voldoen aan de huur inkomen tabel.
+ maximumBrutoHuur:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar de bruto huur aan het maximum voldoet.
+ maximumKamers:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar het aantal kamers aan het maximum voldoet.
+ minimumBrutoHuur:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar de bruto huur aan het minimum voldoet.
+ minimumKamers:
+ type: integer
+ format: int32
+ description: De voorrang voor eenheden waar het aantal kamers aan het minimum voldoet.
+ minimumOppervlakte:
+ type: integer
+ format: int32
+ description: De aanduiding die aangeeft dat er is sprake op voorrang voor eenheden die minimaal voldoen aan de aangegeven woonoppervlakte in m2.
+ stadsdelen:
+ description: De stadsdelen waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Stadsdeel-sleutels'
+ toegankelijkheidslabels:
+ description: De toegankelijkheidslabels waar het voorrangsregeling profiel voor geldt. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
+ type: array
+ items:
+ $ref: '#/components/schemas/Referentiedata'
+ wijken:
+ description: De wijken waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Wijk-sleutels'
+ woonplaatsen:
+ description: De woonplaatsen waarop het voorrangsregeling profiel van toepassing is.
+ type: array
+ items:
+ $ref: '#/components/schemas/Woonplaats-sleutels'
+ Buurt-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de buurt.
+ Gemeente-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de gemeente.
+ Stadsdeel-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ Wijk-sleutels:
+ type: object
+ properties:
+ id:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het bronsysteem. Je verstuurt een entiteit altijd met het eigen id. Id kan leeg zijn.
+ idExtern:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven in het doelsysteem. Deze idExtern wisselt om met id afhankelijk van de richting van de gegevensuitwisseling.
+ idGegevensbeheerder:
+ type: string
+ format: any
+ description: De primaire sleutel van het gegeven van de gegevensbeheerder. Bijv. de overheid of andere standaarden.
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van de wijk.
Kandidaten-Woonplaats:
type: object
properties:
@@ -5949,6 +6276,10 @@ components:
type: string
format: date
description: De einddatum waarop de woonsituatie is beëindigd.
+ authentiekGegeven:
+ allOf:
+ - $ref: '#/components/schemas/Kandidaten-AuthentiekGegeven'
+ description: Bewijs van de authenticiteit van de gegevens.
eenheid:
allOf:
- $ref: '#/components/schemas/Kandidaten-Eenheid'
@@ -6374,15 +6705,6 @@ components:
type: string
format: any
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
- buurt:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Buurt'
- gemeente:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Gemeente'
- geometrie:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Geometrie'
huisletter:
type: string
format: any
@@ -6403,12 +6725,6 @@ components:
type: string
format: any
description: De straatnaam behorend bij het adres.
- wijk:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Wijk'
- woonplaats:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Woonplaats'
Publicaties-Adres:
oneOf:
- $ref: '#/components/schemas/Publicaties-Eenheidadres'
@@ -6579,10 +6895,11 @@ components:
format: float
description: De brutohuur in euro's die geregistreerd staat bij de eenheid. De brutohuur is de netto huur (of kale huur) inclusief alle huurcomponenten en inclusief BTW.
buitenruimten:
- description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). Referentiedatasoort EENHEIDBUITENRUIMTE.
+ description: Bij de eenheid kan ook een buitenruimte horen die zelf geen vertrek is (Tuin, terras, etc.). OBSOLETE Referentiedatasoort EENHEIDBUITENRUIMTE.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
clusters:
description: De clusters waar de eenheid onderdeel van uitmaakt.
type: array
@@ -6619,11 +6936,13 @@ components:
inExploitatiedatum:
type: string
format: date
- description: De datum waarop de eenheid in exploitatie is gegaan. We spreken over exploitatie als de eenheid in beheer is met als doel dat er resultaat wordt behaald.
+ description: OBSOLETE
+ deprecated: true
inExploitatieReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het in exploitatie nemen van een eenheid. Bijvoorbeeld: verhuur of beheer namens andere eigenaren. Referentiedatasoort INEXPLOITATIEREDEN.'
+ description: OBSOLETE Referentiedatasoort INEXPLOITATIEREDEN.
+ deprecated: true
interieur:
description: Binnenruimte van de woning zoals gemeubileerd en vloerbedekking in de woonkamer. Referentiedatasoort EENHEIDINTERIEUR.
type: array
@@ -6658,16 +6977,17 @@ components:
items:
$ref: '#/components/schemas/Referentiedata'
liggingTuin:
- description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. Referentiedatasoort EENHEIDLIGGINGTUIN.
+ description: Specifieke aanduiding in welke windrichting de tuin gelegen is ten opzichte van de eenheid. OBSOLETE Referentiedatasoort EENHEIDLIGGINGTUIN.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
+ deprecated: true
maatschappelijkLabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: 'Het label waarmee het maatschappelijk en economisch belang van de dienstverlening wordt aangegeven: behoort de eenheid tot de DAEB-tak of tot de niet-DAEB-tak. Het label op de eenheid kan afwijken van het maatschappelijk label van de huurovereenkomst. Hiermee kan worden aangegeven dat een eenheid die behoort tot de niet-DAEB tak als DAEB-verhuring verantwoord moet worden. Referentiedatasoort MAATSCHAPPELIJKLABEL.'
monumenten:
- description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort MONUMENT.
+ description: De aanduiding die aangeeft of de eenheid een monument is, en ook welke soort monument het is. Bijvoorbeeld rijksmonument, beschermd stadsgezicht etc. Een eenheid kan onder meerdere typen monumenten vallen. Referentiedatasoort EENHEIDMONUMENT.
type: array
items:
$ref: '#/components/schemas/Referentiedata'
@@ -6692,7 +7012,7 @@ components:
publicatieLabel:
type: string
format: any
- description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning etc.
+ description: Het label van de eenheid die kan worden gebruikt voor de publicatie van de eenheid. Bijvoorbeeld Containerwoning, Atelierwoning, Duplexwoning, Appartement etc.
rayon:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -6731,7 +7051,7 @@ components:
toegankelijkheidslabel:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKSHEIDSLABEL.
+ description: Het toegankelijkheidslabel van de eenheid. Bijvoorbeeld, de eenheid is geschikt voor minder validen. Referentiedatasoort TOEGANKELIJKHEIDSLABEL.
totaalInhoud:
type: number
format: float
@@ -6743,11 +7063,13 @@ components:
uitExploitatiedatum:
type: string
format: date
- description: De datum waarop de eenheid uit exploitatie is gegaan, zowel het beheer als andere activiteiten stoppen.
+ description: OBSOLETE
+ deprecated: true
uitExploitatieReden:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: 'De reden voor het uit exploitatie nemen van een eenheid. Voorbeeld: sloop. Referentiedatasoort UITEXPLOITATIEREDEN.'
+ description: OBSOLETE Referentiedatasoort UITEXPLOITATIEREDEN.
+ deprecated: true
verkoop:
type: boolean
description: De waarde die aangeeft of de eenheid beschikbaar is voor de verkoop.
@@ -6765,6 +7087,10 @@ components:
type: integer
format: int32
description: Het aantal verwarmde vertrekken van de eenheid.
+ vestiging:
+ allOf:
+ - $ref: '#/components/schemas/Referentiedata'
+ description: De vestiging van de vastgoedaanbieder die de woning heeft aangeboden. Referentiedatasoort VESTIGING.
voorwaarden:
allOf:
- $ref: '#/components/schemas/Publicaties-EenheidVoorwaarden'
@@ -6798,6 +7124,14 @@ components:
- $ref: '#/components/schemas/Publicaties-Adres-basis'
- type: object
properties:
+ buurt:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Buurt'
+ description: De buurt behorend bij het adres.
+ gemeente:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Gemeente'
+ description: De gemeente behorend bij het adres.
geometrie:
allOf:
- $ref: '#/components/schemas/Publicaties-Geometrie'
@@ -6806,6 +7140,14 @@ components:
allOf:
- $ref: '#/components/schemas/Referentiedata'
description: Het land waarin het adres zich bevindt. Referentiedatasoort LAND.
+ stadsdeel:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Stadsdeel'
+ description: Het stadsdeel behorend bij het adres.
+ wijk:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Wijk'
+ description: De wijk behorend bij het adres.
woonplaats:
allOf:
- $ref: '#/components/schemas/Publicaties-Woonplaats'
@@ -7112,6 +7454,11 @@ components:
format: any
description: De primaire URL waarop de advertentie is te vinden.
cluster:
+ allOf:
+ - $ref: '#/components/schemas/Publicaties-Cluster'
+ description: Het cluster behorend bij de publicatie. OBSOLETE
+ deprecated: true
+ clusters:
allOf:
- $ref: '#/components/schemas/Publicaties-Cluster'
description: Het cluster behorend bij de publicatie.
@@ -7303,10 +7650,6 @@ components:
type: string
format: any
description: De omschrijving van de ruimte.
- eenheid:
- allOf:
- - $ref: '#/components/schemas/Publicaties-Eenheid'
- description: De eenheid behorend bij de ruimte.
inhoud:
type: number
format: float
@@ -7314,11 +7657,22 @@ components:
ligging:
allOf:
- $ref: '#/components/schemas/Referentiedata'
- description: De ligging van de ruimte. Referentiedatasoort EENHEIDLIGGINGRUIMTE.
+ description: De ligging van de ruimte. Referentiedatasoort RUIMTELIGGING.
oppervlakte:
type: number
format: float
description: De oppervlakte van de ruimte
+ Publicaties-Stadsdeel:
+ type: object
+ properties:
+ code:
+ type: string
+ format: any
+ description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
+ naam:
+ type: string
+ format: any
+ description: De naam van het stadsdeel.
Publicaties-Telefoonnummer:
allOf:
- $ref: '#/components/schemas/Publicaties-Contactgegeven-basis'
@@ -7520,8 +7874,8 @@ components:
deprecated: true
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort gebeurtenis. Bijv. Niet aanwezig op bevestige bezichtiging. OBSOLETE Referentiedatasoort GEBEURTENISSOORT.
deprecated: true
Puntenberekeningen-Inschrijving:
allOf:
@@ -8156,8 +8510,8 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn.
+ - $ref: '#/components/schemas/Referentiedata'
+ description: Het soort overeenkomst. Dit kan bijvoorbeeld arbeidsovereenkomst of koopovereenkomst zijn. Referentiedatasoort OVEREENKOMSTSOORT.
Reclamaties-Reclamatiebericht:
allOf:
- $ref: '#/components/schemas/Reclamaties-Reclamatie'
@@ -8834,12 +9188,12 @@ components:
description: De unieke code (Bijvoorbeeld om te tonen of te zoeken)
soort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het soort relatie: NatuurlijkPersoon, Relatiegroep of Rechtspersoon. Referentiedatasoort RELATIESOORT.'
detailSoort:
allOf:
- - $ref: '#/components/schemas/Referentiedata-sleutels'
- description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon.'
+ - $ref: '#/components/schemas/Referentiedata'
+ description: 'Het detail van soort relatie: Bijvoorbeeld Huishouden bij een relatiegroep, of de standaard bedrijfsindeling volgens SBI bij een rechtspersoon. Referentiedatasoort RELATIEDETAILSOORT.'
rollen:
description: 'De rollen behorend bij de relatie. Bijvoorbeeld: Prospect, bewoner.'
type: array
@@ -8953,8 +9307,9 @@ components:
$ref: '#/components/schemas/Relaties-RelatieAdres'
rolRelatie:
allOf:
- - $ref: '#/components/schemas/Relaties-Relatie'
- description: De relatie die aangeeft waar de relatie en rol koppeling van toepassing is. Dit attribuut geeft aan dat de aangegeven relatie de rol binnen bijvoorbeeld een relatiegroep heeft. Het attribuut relatie is dan bijvoorbeeld een persoon uit een huishouden en de rolRelatie is dan bijvoorbeeld de relatiegroep die het huishouden voorstelt.
+ - $ref: '#/components/schemas/Relatie-sleutels'
+ description: OBSOLETE.
+ deprecated: true
Relaties-Woonplaats:
type: object
properties:
@@ -9259,7 +9614,7 @@ components:
- $ref: '#/components/schemas/Sancties-Overeenkomst'
description: De inschrijving waarop de sacntie van toepassing is.
puntengebeurtenissen:
- description: De geberutenissen die hebben geleid tot de sanctie.
+ description: De gebeurtenissen die hebben geleid tot de sanctie.
type: array
items:
$ref: '#/components/schemas/Sancties-Puntengebeurtenis'
@@ -9296,11 +9651,13 @@ components:
nettoMaandinkomen:
type: number
format: float
- description: Het netto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het netto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
brutoMaandinkomen:
type: number
format: float
- description: Het bruto maandinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto maandinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
bron:
allOf:
- $ref: '#/components/schemas/Referentiedata'
@@ -9308,7 +9665,8 @@ components:
brutoJaarinkomen:
type: number
format: float
- description: Het bruto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het bruto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
controledatum:
type: string
format: date-time
@@ -9316,7 +9674,8 @@ components:
nettoJaarinkomen:
type: number
format: float
- description: Het netto jaarinkomen in euro's van de natuurlijk persoon.
+ description: Het netto jaarinkomen in euro's van de natuurlijk persoon. OBSOLETE
+ deprecated: true
Toewijzingen-Kandidaat:
type: object
properties:
diff --git a/docs/bron-referentiedatasoorten.txt b/docs/bron-referentiedatasoorten.txt
index e7dad19..338881e 100644
--- a/docs/bron-referentiedatasoorten.txt
+++ b/docs/bron-referentiedatasoorten.txt
@@ -9,6 +9,9 @@ AFSPRAAKVERZOEKSOORT
AKTESOORT
ARCHIEFNOMINATIE
ARCHIEFSTATUS
+AUTHENTIEKGEGEVENBRONSOORT
+AUTHENTIEKGEGEVENSOORT
+AUTHENTIEKGEGEVENSTATUS
BANKAFSCHRIFTREGELSOORT
BANKAFSCHRIFTSTATUS
BEDRIJFSOORT
@@ -67,7 +70,6 @@ EENHEIDCRITERIUMSOORT
EENHEIDCRITERIUMTOEPASSING
EENHEIDDETAILSOORT
EENHEIDDETAILSTATUS
-EENHEIDLIGGINGRUIMTE
EENHEIDPRIJSCONDITIE
EENHEIDSOORT
EENHEIDSTATUS
@@ -106,6 +108,7 @@ INFORMATIEOBJECTSOORT
INFORMATIEOBJECTSTATUS
INFORMATIEOBJECTSUBONDERWERP
INKOMENSBRON
+INKOMENSSOORT
INKOMENSVERKLARINGSOORT
INKOOPFACTUURSTATUS
INKOOPOPDRACHTREGELSOORT
@@ -200,7 +203,7 @@ RECLAMATIESTATUS
REDENONTBINDING
REDENOPZEGGING
REDENVERNIETIGING
-Referentiedata
+Referentiedata-sleutels
REGELINGSOORT
REGIESOORT
REGISTRATIESTATUS
@@ -212,6 +215,7 @@ RELATIESTATUS
RENTESOORT
RESULTAATREACTIE
RUIMTEDETAILSOORT
+RUIMTELIGGING
RUIMTESOORT
SAMENWERKINGSVERBAND
SANCTIESOORT
@@ -226,7 +230,6 @@ STURINGSLABELSOORT
TAAL
TAXATIESOORT
TOEGANKELIJKHEIDSLABEL
-TOEGANKELIJKSHEIDSLABEL
UITEXPLOITATIEREDEN
UITVOERENDESOORT
VERANTWOORDINGCONSOLIDATIE
diff --git a/docs/brongegevens.xlsx b/docs/brongegevens.xlsx
index f6ad7a9..f7ff866 100644
Binary files a/docs/brongegevens.xlsx and b/docs/brongegevens.xlsx differ
diff --git a/docs/referentiedatacrossreference.html b/docs/referentiedatacrossreference.html
index a063252..71a4340 100644
--- a/docs/referentiedatacrossreference.html
+++ b/docs/referentiedatacrossreference.html
@@ -77,6 +77,11 @@ Gebruik van Referentiedata
| ARCHIEFNOMINATIE | VERA | Dossier | Informatieobject | archiefnominatie |
| ARCHIEFNOMINATIE | VERA | Dossier | Zaak | archiefnominatie |
| ARCHIEFSTATUS | VERA | Dossier | Zaak | archiefstatus |
+| AUTHENTIEKGEGEVENBRONSOORT | VERA | Dossier | AuthentiekGegeven | bron |
+| AUTHENTIEKGEGEVENBRONSOORT | WRV | Kandidaten | AuthentiekGegeven | bron |
+| AUTHENTIEKGEGEVENSOORT | VERA | Dossier | AuthentiekGegeven | soort |
+| AUTHENTIEKGEGEVENSOORT | WRV | Kandidaten | AuthentiekGegeven | soort |
+| AUTHENTIEKGEGEVENSTATUS | VERA | Dossier | AuthentiekGegeven | status |
| BANKAFSCHRIFTREGELSOORT | VERA | Financien | BankafschriftRegel | soort |
| BANKAFSCHRIFTSTATUS | VERA | Financien | Bankafschrift | status |
| BEDRIJFSOORT | VERA | Financien | FinancieelBedrijf | soort |
@@ -353,9 +358,6 @@ Gebruik van Referentiedata
| EENHEIDLIGGINGBUITENRUIMTE | VHE | Eenheden | Eenheid | liggingBuitenruimten |
| EENHEIDLIGGINGBUITENRUIMTE | WRV | Eenheden | Eenheid | liggingBuitenruimten |
| EENHEIDLIGGINGBUITENRUIMTE | WRV | Publicaties | Eenheid | liggingBuitenruimten |
-| EENHEIDLIGGINGRUIMTE | VERA | Vastgoed | Ruimte | ligging |
-| EENHEIDLIGGINGRUIMTE | WRV | Eenheden | Ruimte | ligging |
-| EENHEIDLIGGINGRUIMTE | WRV | Publicaties | Ruimte | ligging |
| EENHEIDLIGGINGTUIN | VERA | Vastgoed | Eenheid | liggingTuin |
| EENHEIDLIGGINGTUIN | VHE | Eenheden | Eenheid | liggingTuin |
| EENHEIDLIGGINGTUIN | WRV | Eenheden | Eenheid | liggingTuin |
@@ -363,6 +365,7 @@ Gebruik van Referentiedata
| EENHEIDMONUMENT | VERA | Vastgoed | Eenheid | monumenten |
| EENHEIDMONUMENT | VHE | Eenheden | Eenheid | monumenten |
| EENHEIDMONUMENT | WRV | Eenheden | Eenheid | monumenten |
+| EENHEIDMONUMENT | WRV | Publicaties | Eenheid | monumenten |
| EENHEIDPRIJSCONDITIE | VERA | Vastgoed | Eenheid | prijsconditie |
| EENHEIDPRIJSCONDITIE | WRV | Eenheden | Eenheid | prijsconditie |
| EENHEIDPRIJSCONDITIE | WRV | Publicaties | Eenheid | prijsconditie |
@@ -497,6 +500,8 @@ Gebruik van Referentiedata
| INKOMENSBRON | WRV | Kandidaten | Inkomen | bron |
| INKOMENSBRON | WRV | Relaties | Inkomen | bron |
| INKOMENSBRON | WRV | Toewijzingen | Inkomen | bron |
+| INKOMENSSOORT | VERA | Relaties | Inkomen | soort |
+| INKOMENSSOORT | WRV | Kandidaten | Inkomen | soort |
| INKOMENSVERKLARINGSOORT | VERA | Relaties | Inkomen | inkomensverklaringsoort |
| INKOMENSVERKLARINGSOORT | WRV | Relaties | Inkomen | inkomensverklaringsoort |
| INKOOPFACTUURSTATUS | OHD | Inkoopfacturen | Factuur | status |
@@ -589,7 +594,6 @@ Gebruik van Referentiedata
| MEETEENHEID | VERA | Onderhoud | Standaardprijs | meeteenheid |
| MEETEENHEID | VERA | Projectontwikkeling | Projectbesteding | meeteenheid |
| MEETEENHEID | VERA | Vastgoed | WoningwaarderingCriterium | meeteenheid |
-| MONUMENT | WRV | Publicaties | Eenheid | monumenten |
| NATIONALITEIT | BDO | Dossiers | NatuurlijkPersoon | nationaliteit |
| NATIONALITEIT | BDO | Zaken | NatuurlijkPersoon | nationaliteit |
| NATIONALITEIT | BRG | Relaties | NatuurlijkPersoon | nationaliteit |
@@ -747,6 +751,7 @@ Gebruik van Referentiedata
| PROVINCIE | VERA | Vastgoed | Eenheidadres | provincie |
| PROVINCIE | VERA | Vastgoed | Gemeente | provincie |
| PROVINCIE | VHE | Eenheden | Gemeente | provincie |
+| PROVINCIE | WRV | Eenheden | Eenheidadres | provincie |
| PROVINCIE | WRV | Kandidaten | Eenheidadres | provincie |
| PROVINCIE | WRV | Relaties | Eenheidadres | provincie |
| PUBLICATIECONTRACTVORM | WRV | Publicaties | Publicatie | contractvorm |
@@ -833,6 +838,7 @@ Gebruik van Referentiedata
| RELATIEROLSOORT | BRG | Relaties | Relatierol | soort |
| RELATIEROLSOORT | KMT | Kwaliteitsmetingsverzoeken | Relatierol | soort |
| RELATIEROLSOORT | OHD | AfspraakOpties | Relatierol | soort |
+| RELATIEROLSOORT | OHD | Afspraken | Relatierol | soort |
| RELATIEROLSOORT | OHD | BouwkundigElementen | Relatierol | soort |
| RELATIEROLSOORT | OHD | Inspectierapporten | Relatierol | soort |
| RELATIEROLSOORT | OHD | Offertes | Relatierol | soort |
@@ -886,13 +892,19 @@ Gebruik van Referentiedata
| RESULTAATREACTIE | VERA | Kwaliteit | Kwaliteitsmetingsresultaat | resultaatReactie |
| RUIMTEDETAILSOORT | VERA | Vastgoed | Ruimte | detailSoort |
| RUIMTEDETAILSOORT | VERA | Vastgoed | Vertrek | detailSoort |
+| RUIMTEDETAILSOORT | VHE | Eenheden | Ruimte | detailSoort |
| RUIMTEDETAILSOORT | VHE | Eenheden | Vertrek | detailSoort |
| RUIMTEDETAILSOORT | WRV | Eenheden | Ruimte | detailSoort |
| RUIMTEDETAILSOORT | WRV | Eenheden | Vertrek | detailSoort |
| RUIMTEDETAILSOORT | WRV | Publicaties | Ruimte | detailSoort |
| RUIMTEDETAILSOORT | WRV | Publicaties | Vertrek | detailSoort |
+| RUIMTELIGGING | VERA | Vastgoed | Ruimte | ligging |
+| RUIMTELIGGING | VHE | Eenheden | Ruimte | ligging |
+| RUIMTELIGGING | WRV | Eenheden | Ruimte | ligging |
+| RUIMTELIGGING | WRV | Publicaties | Ruimte | ligging |
| RUIMTESOORT | VERA | Vastgoed | Ruimte | soort |
| RUIMTESOORT | VERA | Vastgoed | Vertrek | soort |
+| RUIMTESOORT | VHE | Eenheden | Ruimte | soort |
| RUIMTESOORT | VHE | Eenheden | Vertrek | soort |
| RUIMTESOORT | WRV | Eenheden | Ruimte | soort |
| RUIMTESOORT | WRV | Eenheden | Vertrek | soort |
@@ -960,11 +972,12 @@ Gebruik van Referentiedata
| TAXATIESOORT | VERA | Vastgoed | Taxatie | soort |
| TOEGANKELIJKHEIDSLABEL | VERA | Vastgoed | Eenheid | toegankelijkheidslabel |
| TOEGANKELIJKHEIDSLABEL | VERA | Woonruimteverdeling | VoorrangsregelingProfiel | toegankelijkheidslabels |
+| TOEGANKELIJKHEIDSLABEL | VERA | Woonruimteverdeling | Zoekprofiel | Toegankelijkheid |
+| TOEGANKELIJKHEIDSLABEL | VHE | Eenheden | Eenheid | toegankelijkheidslabel |
+| TOEGANKELIJKHEIDSLABEL | WRV | Eenheden | Eenheid | toegankelijkheidslabel |
+| TOEGANKELIJKHEIDSLABEL | WRV | Kandidaten | VoorrangsregelingProfiel | toegankelijkheidslabels |
+| TOEGANKELIJKHEIDSLABEL | WRV | Publicaties | Eenheid | toegankelijkheidslabel |
| TOEGANKELIJKHEIDSLABEL | WRV | Toewijzingen | VoorrangsregelingProfiel | toegankelijkheidslabels |
-| TOEGANKELIJKHEIDSLABELS | VERA | Woonruimteverdeling | Zoekprofiel | Toegankelijkheid |
-| TOEGANKELIJKSHEIDSLABEL | VHE | Eenheden | Eenheid | toegankelijkheidslabel |
-| TOEGANKELIJKSHEIDSLABEL | WRV | Eenheden | Eenheid | toegankelijkheidslabel |
-| TOEGANKELIJKSHEIDSLABEL | WRV | Publicaties | Eenheid | toegankelijkheidslabel |
| UITEXPLOITATIEREDEN | VERA | Vastgoed | Eenheid | uitExploitatieReden |
| UITEXPLOITATIEREDEN | VHE | Eenheden | Eenheid | uitExploitatieReden |
| UITEXPLOITATIEREDEN | WRV | Eenheden | Eenheid | uitExploitatieReden |
@@ -995,10 +1008,14 @@ Gebruik van Referentiedata
| VERTROUWELIJKHEID | WRV | Publicaties | Contactgegeven | vertrouwelijkheid |
| VERTROUWELIJKHEID | WRV | Relaties | Contactgegeven | vertrouwelijkheid |
| VESTIGING | VERA | Relaties | Woonsituatie | vestiging |
+| VESTIGING | VERA | Vastgoed | Eenheid | vestiging |
| VESTIGING | VERA | Woonruimteverdeling | Gebeurtenis | vestiging |
| VESTIGING | VERA | Woonruimteverdeling | Puntengebeurtenis | vestiging |
+| VESTIGING | VHE | Eenheden | Eenheid | vestiging |
+| VESTIGING | WRV | Eenheden | Eenheid | vestiging |
| VESTIGING | WRV | Gebeurtenissen | Gebeurtenis | vestiging |
| VESTIGING | WRV | Kandidaten | Woonsituatie | vestiging |
+| VESTIGING | WRV | Publicaties | Eenheid | vestiging |
| VESTIGING | WRV | Puntenberekeningen | Gebeurtenis | vestiging |
| VESTIGING | WRV | Puntenberekeningen | Puntengebeurtenis | vestiging |
| VESTIGING | WRV | Puntengebeurtenissen | Puntengebeurtenis | vestiging |
@@ -1007,11 +1024,14 @@ Gebruik van Referentiedata
| VESTIGING | WRV | Sancties | Gebeurtenis | vestiging |
| VESTIGING | WRV | Sancties | Puntengebeurtenis | vestiging |
| VOORRANGDETAILSOORT | VERA | Woonruimteverdeling | Voorrangsregeling | detailSoort |
+| VOORRANGDETAILSOORT | WRV | Kandidaten | Voorrangsregeling | detailSoort |
| VOORRANGDETAILSOORT | WRV | Toewijzingen | Voorrangsregeling | detailSoort |
| VOORRANGEENHEIDSOORT | VERA | Woonruimteverdeling | VoorrangsregelingProfiel | eenheidSoorten |
+| VOORRANGEENHEIDSOORT | WRV | Kandidaten | VoorrangsregelingProfiel | eenheidSoorten |
| VOORRANGSCRITERIA | VERA | Vastgoed | EenheidVoorwaarden | voorrangscriteria |
| VOORRANGSCRITERIA | VHE | Eenheden | EenheidVoorwaarden | voorrangscriteria |
| VOORRANGSOORT | VERA | Woonruimteverdeling | Voorrangsregeling | soort |
+| VOORRANGSOORT | WRV | Kandidaten | Voorrangsregeling | soort |
| VOORRANGSOORT | WRV | Toewijzingen | Voorrangsregeling | soort |
| VRAAGSOORT | KMT | Onderzoeksopdrachten | VragenlijstRegel | soort |
| VRAAGSOORT | KMT | Onderzoeksresultaten | VragenlijstRegel | soort |