Financial claims information document vDraft
Status: CONCEPT
Omschrijving
Een document type met informatie over financiële verplichtingen van organisatie op burgers.
⚠️ LET OP: DIT IS EEN CONCEPTVERSIE ⚠️
Structuur
Het Financial claims information document kent de volgende structuur.
Algemene regels
Gebeurtenissen
De entiteiten financiële_verplichting, betalingsverplichting en betalingen kennen gebeurtenissen die het gevolg zijn van handelingen in de werkelijke wereld. De individuele voorkomens van deze gebeurtenissen zijn onveranderlijk (immutable).
Voorbeelden:
- Een correctie op een eerdere financiële verplichting is ook weer een nieuwe gebeurtenis.
- Het intrekken van een betalingsverplichting is ook weer een aparte gebeurtenis.
Zie Gebeurtenissen voor meer informatie over de gebeurtenissen.
Kenmerken
Elke gebeurtenis heeft een eigen kenmerk. Deze kenmerken moeten uniek en consistent zijn. Indien deze waarden niet beschikbaar zijn, dan kan er voor worden gekozen om een deterministische hash te maken van de andere velden. Aangezien de financiële verplichting, de betalingsverplichting en de betaling onveranderbaar zijn, is de hash constant.
Daarnaast zijn er functionele kenmerken (bijv. zaakkenmerk, verplichtingskenmerk, betalingskenmerk) en in sommige gevallen wordt er ook naar kenmerken in gebeurtenissen verwezen (zoals een betalingsverplichting die gerelateerd is aan een financiële verplichting, een achterstand die verwijst naar een betalingsverplichting, of het intrekken of corrigeren van eerdere gebeurtenissen waarbij verwezen wordt naar het kenmerk van de gecorrigeerde of ingetrokken gebeurtenis).
Datum / tijd velden
Datumtijd velden zijn in het RFC3339 formaat inclusief indicatie tijdzone.
Bijvoorbeeld: "saldo_datumtijd": "2022-07-13T18:43:12+00:00"
Zie https://www.rfc-editor.org/rfc/rfc3339 voor meer informatie.
Bedragen
Bedragen zijn altijd in centen en altijd in euros.
Bijvoorbeeld: "bedrag": 1578 is €15,78
OIN (organisatie informatie nummer)
Het Organisatie-identificatienummer (OIN) is een uniek nummer dat Logius kan toekennen aan organisaties om zich te kunnen identificeren, authentiseren en of autoriseren bij digitaal berichtenverkeer binnen en met de overheid. Het OIN is voor organisaties die berichten uitwisselen met de overheid. Dit kunnen publieke en private organisaties zijn.
Zie https://www.logius.nl/domeinen/toegang/organisatie-identificatienummer
Niet verplichte attributen en arrays
Arrays worden altijd verplicht opgenomen in het bericht. De waarde kan ook een lege array zijn.
Indien een attribuut niet verplicht is, dan wordt het attribuut wel opgenomen, maar met een null value.
Financial claims information document
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| type | Ja | string | "FINANCIAL_CLAIMS_INFORMATION_DOCUMENT" | Type van het document. Voor dit document de vaste waarde: "FINANCIAL_CLAIMS_INFORMATION_DOCUMENT" |
| version | Ja | string | "2" | Versie nummer (integer) van de gebruikte interface |
| body | Ja | object | Bevat de inhoud van het inancial claims information document. Zie body hieronder voor de specificatie. |
body
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| aangeleverd_door | Ja | string | "00000004000000044000" | De OIN van de betrokken organisatie. |
| document_datumtijd | Ja | string | "2022-07-13T18:43:12+00:00" | Datum/tijd waarop dit antwoord is aangemaakt. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie dit document is opgesteld. Deze moet gelijk zijn als het BSN in het oorspronkelijke verzoek. Zie pagina Terminologie voor meer informatie over de Burger. |
| beschikbaarheid | Ja | Object | (Map) voor elke type financiële verplichtingen van de bronorganisatie met de bijbehorende beschikbaarheid-status. Zie beschikbaarheid hieronder voor de specificatie. | |
| financiele_zaken | Nee (0..n) | array | Een lijst van financiële zaken. Zie financiele_zaken hieronder voor de specificatie. |
beschikbaarheid
Met de beschikbaarheid wordt per type financiële verplichting een status aangegeven (zie Typen financiële verplichtingen):
- "BESCHIKBAAR" Het type financiële verplichting is beschikbaar en indien de burger een financiële zaak heeft, dan wordt deze aangeleverd aan Vorderingoverzicht Rijk.
- "NIET_BESCHIKBAAR" Het type financiële verplichting is niet beschikbaar via Vorderingenoverzicht rijk. De burger zal zaken van dit type dan ook niet terugzien in Vorderingoverzicht Rijk.
- "STORING" Het type financiële verplichting is door een storing tijdelijk niet beschikbaar. Dit kan een technische storing zijn, maar ook een functionele oorzaak hebben.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| beschikbaarheid | Ja | Object (map) met als key/value pairs <type: string>:<status: string> | { "VO_TYPE1":"BESCHIKBAAR", "VO_TYPE2":"NIET_BESCHIKBAAR", "VO_TYPE3":"STORING" } | Het type financiële verplichting volgens de catalogus. Beschikbaarheid-status van het type financiële verplichting. Mogelijke waarden: - "BESCHIKBAAR" - "NIET BESCHIKBAAR" - "STORING" |
financiele_zaken
De lijst financiele_zaken bevat objecten van het type financiele_zaak. Zie Financiële zaak voor de definitie en meer informatie. Elk object heeft de volgende structuur:
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| zaakkenmerk | Ja | string | "81029991234567891" | Uniek en constant kenmerk van de financiële zaak. Gelijk aan het zaakkenmerk van alle gebeurtenissen. TODO: Nadenken over dit kenmerk als de uitvoering van de zaak wordt overgedragen. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting is opgelegd. Deze moet gelijk zijn als het BSN in het oorspronkelijke verzoek. Zie pagina Terminologie voor meer informatie over de Burger. |
| totaal_financieel_verplicht | Ja | number | 5500 | Som bedragen van de actuele FinancieleverplichtingOpgelegd danwel FinancieleVerplichtingGecorrigeerdminus totaal van FinancieleVerplichtingKwijtgescholdenminus totaal van FinancieelRechtVastgesteld |
| totaal_financieel_vereffend | Ja | number | 2000 | Som van de bedragen van VerrekeningVerwerktplus som bedragen BetalingVerwerktminus som bedragen BedragUitbetaald |
| saldo | Ja | number | 3500 | totaal_financieel_verplicht minus totaal_financieel_vereffend |
| saldo_datumtijd | Ja | string | "2022-07-13T18:43:12+00:00" | Het tijdstip van de laatst meegenomen wijziging in het saldo. |
| gebeurtenissen | Ja (0..n) | array | Een lijst van gebeurtenissen die te maken hebben met financiële verplichtingen Zie gebeurtenissen hieronder voor de specificatie. | |
| achterstanden | Ja (0..n) | array | Een lijst van kenmerken van betalingsverplichtingen waarvoor een achterstand geconstateerd is. Zie achterstanden hieronder voor de specificatie. | |
| contact_opties | Ja (1..n) | array | Een lijst van contact opties die de burger kan gebruiken om contact op te nemen met de betrokken bronorganisatie. Zie contactopties hieronder voor de specificatie. |
gebeurtenissen
De lijst gebeurtenissen bevat meerdere typen gebeurtenis-objecten. Elk object heeft een van de volgende typen:
De uitwerking van elk type staat hieronder:
FinancieleVerplichtingOpgelegd
Zie pagina Terminologie voor meer informatie over de financiële verplichting.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieleVerplichtingOpgelegd" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-1" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| datumtijd_opgelegd | Ja | string | "2022-07-12T00:00:00+00:00" | De datum en tijd waarop de financiële verplichting is opgelegd. |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de verplichting onderdeel van is. |
| beschikkingsnummer | Nee | string | "99999999" | Nummer van de beschikking behorend bij de financiële verplichting. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting is opgelegd. |
| primaire_verplichting | Ja | boolean | true | Is waar als de financiële verplichting de primaire verplichting is. Bijvoorbeeld: de opgelegde boete voor een verkeersovertreding is primair, maar de administratiekosten zijn dat niet. |
| type | Ja | string | "CJIB_WAHV" | Bevat de typecode van de verplichting zoals gespecificeerd in de typenlijst Typen financiële verplichtingen . |
| categorie | Ja | string | "Algemeen" | Bevat de categorie van de verplichting. Mogelijke waarden: - "Algemeen" (voor de primaire verplichting) - "Administratiekosten" - "Verhoging" - "Rente" |
| bedrag | Ja | number | 4600 | Het opgelegde bedrag. Voor gebeurtenis "FinancieleVerplichtingOpgelegd" is dat een positief bedrag. |
| omschrijving | Ja | string (max 120) | "Kenteken: a-000-aa; 11 km te hard buiten de bebouwde kom op 1 april 2023" | Extra informatie over de betreffende financiële verplichting. |
| juridische_grondslag_omschrijving | Ja | string | "Boete voor te hard rijden Artikel 21 (RVV 1990)" | Een leesbare omschrijving van de juridische grondslag van de financiële verplichting |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0004825&hoofdstuk=II¶graaf=8&artikel=21&z=2023-01-01&g=2023-01-01" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| opgelegd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de verplichting heeft opgelegd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de verplichting uitvoert. TODO: deze moet volgens mij op financiële zaak niveau worden gezet. Financiële verplichtingen worden niet individueel uitgevoerd. |
BetalingsverplichtingOpgelegd
Zie pagina Terminologie voor meer informatie over de betalingsverplichting.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "BetalingsverplichtingOpgelegd" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-3" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-08-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| datumtijd_opgelegd | Ja | string | "2022-08-12T00:00:00+00:00" | De datum en tijd waarop de betalingsverplichting is opgelegd. |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de verplichting onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie betalingsverplichting is opgelegd. |
| bedrag | Ja | number | 3500 | Het opgelegde bedrag. Dit is een positief bedrag. |
| omschrijving | Nee | string (max 120) | "Termijn bedrag augustus" | Extra informatie over de betreffende betalingsverplichting, zoals de specifieke termijn. |
| type | Ja | string | "Aanmaning" | Geeft het type van de betalingsverplichting aan. Mogelijke waarden: - "Aanschrijving" - "Herinnering" - "Aanmaning" |
| betaalwijze | Ja | string | "Handmatig" | Geeft de betaalwijze aan. Mogelijke waarden: - "Handmatig" - "Automatische incasso" |
| te_betalen_aan | Ja | string | "00000004000000044000" | OIN van de organisatie waaraan betaald moet worden. |
| rekeningnummer | Nee | string | "GB33BUKB20201555555555" | Het IBAN rekeningnummer waarop betaald moet worden. Verplicht bij betaalwijze "Handmatig" |
| rekeningnummer_tenaamstelling | Nee | string | "CJIB" | De tenaamstelling van het rekeningnummer waarop betaald moet worden. Verplicht bij betaalwijze "Handmatig" |
| betalingskenmerk | Nee | string | "81029991234567891" | Het betalingskenmerk wat gebruikt moet worden bij het doen van de betaling. Verplicht bij betaalwijze "Handmatig". |
| vervaldatum | Ja | string | "2022-09-13T00:00:00+00:00" | De uiterste datum waarop de betalingsverplichting voldaan moet zijn. |
BetalingsverplichtingIngetrokken
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "BetalingsverplichtingIngetrokken" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-13" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-08-14T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| ingetrokken_gebeurtenis_kenmerk | Ja | string | "81029991234567891-3" | Het kenmerk van de ingetrokken betalingsverplichting. |
BetalingVerwerkt
Zie pagina Terminologie voor meer informatie over de betaling.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "BetalingVerwerkt" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-4" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-21T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| datumtijd_verwerkt | Ja | string | "2022-07-21T00:00:00+00:00" | De datum en tijd waarop de betaling is verwerkt. |
| betalingskenmerk | Ja | string | "81029991234567891" | Het betalingskenmerk dat gebruikt is bij de betaling. |
| datumtijd_ontvangen | Nee | string | "2022-07-20T00:00:00+00:00" | De datum en tijd waarop de betaling is ontvangen. |
| ontvangen_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de betaling heeft ontvangen. |
| verwerkt_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de betaling heeft verwerkt. |
| bedrag | Ja | number | 2000 | Het bedrag van de betaling. Voor gebeurtenis "BetalingVerwerkt" is dat een positief bedrag. |
FinancieleVerplichtingKwijtgescholden
Indien er (een deel van) een financiële verplichting is kwijtgescholden, dan kan via deze gebeurtenis het kwijtgescholden bedrag worden meegegeven.
Zie pagina Terminologie voor meer informatie over de kwijtschelding.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieleVerplichtingKwijtgescholden" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-5" | Uniek en constant kenmerk van de gebeurtenis. |
| kenmerk_kwijtgescholden_financiele_verplichting | Ja | string | "81029991234567891-1" | Het kenmerk van de financiële verplichting die (deels) is kwijtgescholden. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting (deels) is kwijtgescholden. |
| bedrag_kwijtschelding | Ja | number | 600 | Het kwijtgescholden bedrag. Een postief bedrag dat is kwijtgescholden. |
| omschrijving | Ja | string (max 120) | "Kwijtgescholden n.a.v. onvoldoende inkomen" | Extra informatie over de betreffende kwijtschelding |
| juridische_grondslag_omschrijving | Ja | string | "Recht op kwijtschelding" | Een leesbare omschrijving van de juridische grondslag van de betreffende kwijtschelding |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0004825&hoofdstuk=II¶graaf=8&artikel=21&z=2023-01-01&g=2023-01-01" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de kwijtschelding uitvoert. |
FinancieleVerplichtingGecorrigeerd
Zie pagina Terminologie voor meer informatie over de correctie.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieleVerplichtingGecorrigeerd" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-6" | Uniek en constant kenmerk van de gebeurtenis. |
| kenmerk_gecorrigeerde_financiele_verplichting | Ja | string | "81029991234567891-1" | Het kenmerk van de financiële verplichting die is gecorrigeerd. Daarmee vervalt deze eerdere opgelegde of gecorrigeerde financiële verplichting |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting is gecorrigeerd. |
| nieuw_opgelegd_bedrag | Ja | number | 500 | Het nieuw opgelegde bedrag na correctie. |
| omschrijving | Ja | string (max 120) | "Correctie n.a.v. nieuwe telling" | Extra informatie over de betreffende correctie. |
| juridische_grondslag_omschrijving | Nee | string | "Definitieve vaststelling aantal" | Een leesbare omschrijving van de juridische grondslag van de correctie |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0004825&hoofdstuk=II¶graaf=8&artikel=21&z=2023-01-01&g=2023-01-01" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de correctie uitvoert. |
FinancieleZaakOvergedragen
Zie pagina Terminologie voor meer informatie over de overdracht.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieleZaakOvergedragen" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-7" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting is overgedragen. |
| saldo_bij_overdracht | Ja | number | 3900 | Het saldo op het moment van overdracht. |
| omschrijving | Ja | string (max 120) | "Deze zaak is overgedragen aan het CJIB." | Extra informatie over de betreffende overdracht. |
| juridische_grondslag_omschrijving | Nee | string | "Recht tot overdracht van uitvoering" | Een leesbare omschrijving van de juridische grondslag van de overdracht |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0022177&artikel=4&z=2007-10-12&g=2007-10-12" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de overdracht heeft uitgevoerd. |
| overgedragen_aan | Ja | string | "00000006000000066000" | OIN van de organisatie die de uitvoering van de financiële zaak overneemt. |
FinancieleZaakOvergenomen
Zie pagina Terminologie voor meer informatie over de overdracht.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieleZaakOvergenomen" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-8" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting is overgedragen. |
| saldo_bij_overdracht | Ja | number | 3900 | Het saldo op het moment van overdracht. |
| omschrijving | Ja | string (max 120) | "Zaak overgenomen van RVO" | Extra informatie over de betreffende de overdracht. |
| juridische_grondslag_omschrijving | Nee | string | "Recht tot overdracht van uitvoering" | Een leesbare omschrijving van de juridische grondslag van de overdracht |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0022177&artikel=4&z=2007-10-12&g=2007-10-12" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000006000000066000" | OIN van de organisatie die de zaak heeft overgenomen. |
| overgenomen_van | Ja | string | "00000004000000044000" | OIN van de organisatie die de overdracht van de financiële zaak heeft geïnitieerd. |
FinancieleZaakOvergedragenAanDeurwaarder
Zie pagina Terminologie voor meer informatie over de overdracht.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieleZaakOvergedragenAanDeurwaarder" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-7" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie financiële verplichting is overgedragen. |
| saldo_bij_overdracht | Ja | number | 3900 | Het saldo op het moment van overdracht. |
| omschrijving | Ja | string (max 120) | "Deze zaak is overgedragen aan de deurwaarder." | Extra informatie over de betreffende de overdracht. |
| juridische_grondslag_omschrijving | Nee | string | "Recht tot overdracht van uitvoering" | Een leesbare omschrijving van de juridische grondslag van de overdracht |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0022177&artikel=4&z=2007-10-12&g=2007-10-12" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de overdracht heeft uitgevoerd. |
| overgedragen_aan | Ja | string | "t.b.d." | KBvG-nummer of KVK-nummer? |
| naam_deurwaarder | Nee | string | "Deurwaarder NL BV" | Naam van de betreffende deurwaarder. |
| telefoonnummer_deurwaarder_url | Nee | string | "tel:+31581111111" | Het telefoonnummer van de betreffende deurwaarder. De scheme voor de URL is "tel:" gevolgd door een telefoonnummer beginnend met een "+" gevolgd door landcode en het specifieke telefoonnummer, zonder streepjes of spaties. |
| email_adres_deurwaarder_url | Nee | string | "mailto:info@deurwaarderbv.nl" | Het e-mail adres van de deurwaarder. URL volgens de W3C standaard. |
⚠️ TODO: KBvG-nummer of KVK-nummer? ⚠️ TODO: contactgegevens als velden toevoegen → nu alleen naam, telefoon en e-mail adres toegevoegd.
FinancieelRechtVastgesteld
Zie pagina Terminologie voor meer informatie over het vaststellen van het financieel recht.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "FinancieelRechtVastgesteld" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-9" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger voor wie het recht is vastgesteld. |
| bedrag | Ja | number | 500 | Het vastgestelde bedrag. Dit is een positief bedrag. |
| omschrijving | Ja | string (max 120) | "Vergoeding bij positieve uitkomst medische keuring" | Extra informatie over de creditering. |
| juridische_grondslag_omschrijving | Ja | string | "Recht op vergoeding bij positieve uitkomst medische keuring" | Een leesbare omschrijving van de juridische grondslag van het financiële recht. |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0022177&artikel=4&z=2007-10-12&g=2007-10-12" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die het recht heeft vastgesteld. |
BedragUitbetaald
Zie pagina Terminologie voor meer informatie over de uitbetaling.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "BedragUitbetaald" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-9" | Uniek en constant kenmerk van de gebeurtenis. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | Het BSN van de burger aan wie de betaling is gedaan. |
| bedrag | Ja | number | 500 | Het uitbetaalde bedrag. Dit is een positief bedrag. |
| rekeningnummer | Ja | string | "GB33BUKB20201555555555" | Het IBAN rekeningnummer waarnaar de betaling is gedaan. |
| omschrijving | Ja | string (max 120) | "Uitbetaald n.a.v. positieve uitkomst medische keuring" | Extra informatie over de betaling. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de overdracht heeft uitgevoerd. |
VerrekeningVerwerkt
Zie pagina Terminologie voor meer informatie over de verrekening.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| gebeurtenis_type | Ja | string | "VerrekeningVerwerkt" | Type-aanduiding van deze gebeurtenis |
| gebeurtenis_kenmerk | Ja | string | "81029991234567891-10" | Uniek en constant kenmerk van de gebeurtenis. |
| kenmerk_financiele_verplichting | Ja | string | "81029991234567891-1" | Het kenmerk van de financiële verplichting waarvoor deze verrekening geldt. |
| datumtijd_gebeurtenis | Ja | string | "2022-07-12T00:00:00+00:00" | Datum en tijd waarop de gebeurtenis is geregistreerd |
| zaakkenmerk | Ja | string | "81029991234567891" | Het kenmerk van de financiële zaak waar de gebeurtenis onderdeel van is. |
| bsn | Ja | string | "814859094" | De verrekening is uitgevoerd. |
| bedrag_verrekening | Ja | number | 600 | Het verrekende bedrag. |
| omschrijving | Ja | string (max 120) | "Verrekening met Europese subsidie." | Extra informatie over de betreffende verrekening |
| juridische_grondslag_omschrijving | Ja | string | "Verrekening met Europese subsidie." | Een leesbare omschrijving van de juridische grondslag van de betreffende verrekening |
| juridische_grondslag_bron | Nee | string | "https://wetten.overheid.nl/jci1.3:c:BWBR0004825&hoofdstuk=II¶graaf=8&artikel=21&z=2023-01-01&g=2023-01-01" | Bij voorkeur een link naar wetten.overheid.nl waar de betreffende juridische grondslag staat genoemd. |
| uitgevoerd_door | Ja | string | "00000004000000044000" | OIN van de organisatie die de kwijtschelding uitvoert. |
TODO: de verrekening heeft idealiter betrekking op twee zaken... het bedrag in de gebeurtenis is dan positief, met omgekeerde werking op de saldi van de twee zaken
achterstanden
Het is aan de organisatie om te bepalen of er voor een betalingsverplichting een achterstand geldt.
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| achterstanden | Ja | array van strings | "81029991234567891-4" | Verwijzing naar de betalingsverplichtingkenmerk waarvoor een achterstand geldt. |
contactopties
De array contactopties bevat 1 of meer contactopties die bij de de financiële zaak worden getoond. Er moet dus minimaal 1 contactoptie worden aangeboden.
Een contactoptie biedt de burger de mogelijkheid om contact op te nemen met de organisatie die de financiële zaak in uitvoering heeft of heeft opgelegd. Er kunnen meerdere opties worden aangeboden. De organisatie kan aangeven wat de voorkeursvolgorde is. Vanuit gebruikersonderzoek wordt onderzocht hoe dit toegepast gaat worden. Verder kan het zijn dat door UI beperkingen niet alle opties in een keer zichtbaar zijn. Dit wordt nog onderzocht.
NB: Bij overdracht naar een deurwaarder wordt contactinformatie van de deurwaarder opgenomen in de gebeurtenis die daar bij hoort.
Er zijn vier categorieën voor contactopties:
-
Telefoonnummer (op een mobiele device als link getoond). De scheme voor de URL is "tel:" gevolgd door een telefoonnummer beginnend met een "+" gevolgd door landcode en het specifieke telefoonnummer, zonder streepjes of spaties. Voorbeeld:
tel:+31581111111 -
e-mail adres waarbij ook het onderwerp van de mail kan worden aangegeven. Hierbij wordt de W3C standaard gevolgd. Voorbeeld:
mailto:service@bronorganisatie.nl?subject=Betreft zaaknummer 123456 -
persoonlijke_website direct naar bijvoorbeeld een mijn-omgeving en direct naar de specifieke financiële zaak. Voorbeeld:
https://mijn.bronorganisatie.nl/zaakinfo?zaaknummer=123456 -
publieke_website naar de algemene website van de organisatie of naar algemene informatie over het specifieke type financiële verplichting. Voorbeeld:
https://www.bronorganisatie.nl/algemeen
| Attribuut | Verplicht | Type | Voorbeeld | Omschrijving |
|---|---|---|---|---|
| contact_vorm | Ja | string | "telefoon" | Bevat de categorie van de contact optie. Mogelijke waarden: - "telefoon" - "e_mail" - "persoonlijke_website" - "publieke_website" |
| url | Ja | string | "tel:+318000543" | De URL van de contactoptie. Per type moet een specifieke "scheme" worden gebruikt: - telefoon: "tel:" gevolgd door de waarde. - e_mail: "mailto:" gevolgd door de waarde. - persoonlijke_website: "https:" gevolgd door de waarde. - publieke_website: "https:" gevolgd door de waarde. Zie hierboven voor de details van de vulling. |
| naam | Ja | string(25) | "Belastingtelefoon" | De naam van de contactoptie zoals gebruikt door bronorganisatie. Deze wordt getoond in de UI. |
| omschrijving | Nee | string(75) | "Voor direct contact over uw zaak" | Een korte omschrijving waat de contactoptie voor bedoeld is. NB: er wordt nog uitgezocht hoe dit getoond gaat worden in de UI. |
| prioriteit | Ja | number | 1 | Hiermee kan de voorkeurs volgorde worden aangegeven. Hierbij wordt de optie met prioriteit 1 als eerste getoond, 2 als tweede, etc. |
Example
t.b.d.