Ga naar hoofdinhoud

Financial claims information document v4.0.0

Status: review

Omschrijving

Een document type met informatie over financiële verplichtingen van organisatie op burgers.

Structuur

Het Financial claims information document kent de volgende structuur.

FinancialClaimsInformationDocument.drawio

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

AttribuutVerplichtTypeVoorbeeldOmschrijving
typeJastring"FINANCIAL_CLAIMS_INFORMATION_DOCUMENT"Type van het document. Voor dit document de vaste waarde: "FINANCIAL_CLAIMS_INFORMATION_DOCUMENT"
versionJastring"2"Versie nummer (integer) van de gebruikte interface
bodyJaobjectBevat de inhoud van het inancial claims information document. Zie body hieronder voor de specificatie.

body

AttribuutVerplichtTypeVoorbeeldOmschrijving
aangeleverd_doorJastring"00000004000000044000"De OIN van de betrokken organisatie.
document_datumtijdJastring"2022-07-13T18:43:12+00:00"Datum/tijd waarop dit antwoord is aangemaakt.
bsnJastring"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.
beschikbaarheidJaObject(Map) voor elke type financiële verplichtingen van de bronorganisatie met de bijbehorende beschikbaarheid-status.
Zie beschikbaarheid hieronder voor de specificatie.
financiele_zakenNee (0..n)arrayEen 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.
AttribuutVerplichtTypeVoorbeeldOmschrijving
beschikbaarheidJaObject (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:

AttribuutVerplichtTypeVoorbeeldOmschrijving
zaakkenmerkJastring"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.
bsnJastring"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_opgelegdJanumber5500De som van bedragen van alle financiële verplichtingen.
totaal_reeds_betaaldNeenumber2000De som van bedragen van alle betalingen die door de burger zijn gedaan.
saldoJanumber3500Het saldo van totaal_opgelegd minus totaal_reeds_betaald
TODO: Correcties zullen later ook in het saldo worden opgenomen.
saldo_datumtijdJastring"2022-07-13T18:43:12+00:00"Het tijdstip van de laatst meegenomen wijziging in het saldo.
gebeurtenissenJa (0..n)arrayEen lijst van gebeurtenissen die te maken hebben met financiële verplichtingen
Zie gebeurtenissen hieronder voor de specificatie.
achterstandenJa (0..n)arrayEen lijst van kenmerken van betalingsverplichtingen waarvoor een achterstand geconstateerd is.
Zie achterstanden hieronder voor de specificatie.
contact_optiesJa (1..n)arrayEen 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 definitie van elk type staat hieronder:

FinancieleverplichtingOpgelegd

Zie pagina Terminologie voor meer informatie over de financiële verplichting.

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenis_typeJastring"FinancieleVerplichtingOpgelegd"Type-aanduiding van deze gebeurtenis
gebeurtenis_kenmerkJastring"81029991234567891-1"Uniek en constant kenmerk van de gebeurtenis.
datumtijd_gebeurtenisJastring"2022-07-12T00:00:00+00:00"Datum en tijd waarop de gebeurtenis is geregistreerd
datumtijd_opgelegdJastring"2022-07-12T00:00:00+00:00"De datum en tijd waarop de financiële verplichting is opgelegd.
zaakkenmerkJastring"81029991234567891"Het kenmerk van de financiële zaak waar de verplichting onderdeel van is.
beschikkingsnummerNeestring"99999999"Nummer van de beschikking behorend bij de financiële verplichting.
bsnJastring"814859094"Het BSN van de burger voor wie financiële verplichting is opgelegd.
primaire_verplichtingJabooleantrueIs 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.
typeJastring"CJIB_WAHV"Bevat de typecode van de verplichting zoals gespecificeerd in de typenlijst Typen financiële verplichtingen .
categorieJastring"Algemeen"Bevat de categorie van de verplichting. Mogelijke waarden:
- "Algemeen" (voor de primaire verplichting)
- "Administratiekosten"
- "Verhoging"
- "Rente"
bedragJanumber4600Het opgelegde bedrag.
Voor gebeurtenis "FinancieleVerplichtingOpgelegd" is dat een positief bedrag.
omschrijvingJastring (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_omschrijvingJastring"Boete voor te hard rijden Artikel 21 (RVV 1990)"Een leesbare omschrijving van de juridische grondslag van de financiële verplichting
juridische_grondslag_bronNeestring"https://wetten.overheid.nl/jci1.3:c:BWBR0004825&hoofdstuk=II&paragraaf=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_doorJastring"00000004000000044000"OIN van de organisatie die de verplichting heeft opgelegd.
uitgevoerd_doorJastring"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.

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenis_typeJastring"BetalingsverplichtingOpgelegd"Type-aanduiding van deze gebeurtenis
gebeurtenis_kenmerkJastring"81029991234567891-3"Uniek en constant kenmerk van de gebeurtenis.
datumtijd_gebeurtenisJastring"2022-08-12T00:00:00+00:00"Datum en tijd waarop de gebeurtenis is geregistreerd
datumtijd_opgelegdJastring"2022-08-12T00:00:00+00:00"De datum en tijd waarop de betalingsverplichting is opgelegd.
zaakkenmerkJastring"81029991234567891"Het kenmerk van de financiële zaak waar de verplichting onderdeel van is.
bsnJastring"814859094"Het BSN van de burger voor wie betalingsverplichting is opgelegd.
bedragJanumber3500Het opgelegde bedrag. Dit is een positief bedrag.
betaalwijzeJastring"Handmatig"Geeft de betaalwijze aan. Mogelijke waarden:
- "Handmatig"
- "Automatische incasso"
te_betalen_aanJastring"00000004000000044000"OIN van de organisatie waaraan betaald moet worden.
rekeningnummerNeestring"GB33BUKB20201555555555"Het IBAN rekeningnummer waarop betaald moet worden. Verplicht bij betaalwijze "Handmatig"
rekeningnummer_tenaamstellingNeestring"CJIB"De tenaamstelling van het rekeningnummer waarop betaald moet worden. Verplicht bij betaalwijze "Handmatig"
betalingskenmerkNeestring"81029991234567891"Het betalingskenmerk wat gebruikt moet worden bij het doen van de betaling. Verplicht bij betaalwijze "Handmatig".
vervaldatumJastring"2022-09-13T00:00:00+00:00"De uiterste datum waarop de betalingsverplichting voldaan moet zijn.

BetalingsverplichtingIngetrokken

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenis_typeJastring"BetalingsverplichtingIngetrokken"Type-aanduiding van deze gebeurtenis
gebeurtenis_kenmerkJastring"81029991234567891-13"Uniek en constant kenmerk van de gebeurtenis.
datumtijd_gebeurtenisJastring"2022-08-14T00:00:00+00:00"Datum en tijd waarop de gebeurtenis is geregistreerd
ingetrokken_gebeurtenis_kenmerkJastring"81029991234567891-3"Het kenmerk van de ingetrokken betalingsverplichting.

BetalingVerwerkt

Zie pagina Terminologie voor meer informatie over de betaling.

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenis_typeJastring"BetalingVerwerkt"Type-aanduiding van deze gebeurtenis
gebeurtenis_kenmerkJastring"81029991234567891-4"Uniek en constant kenmerk van de gebeurtenis.
datumtijd_gebeurtenisJastring"2022-07-21T00:00:00+00:00"Datum en tijd waarop de gebeurtenis is geregistreerd
datumtijd_verwerktJastring"2022-07-21T00:00:00+00:00"De datum en tijd waarop de betaling is verwerkt.
betalingskenmerkJastring"81029991234567891"Het betalingskenmerk dat gebruikt is bij de betaling.
datumtijd_ontvangenNeestring"2022-07-20T00:00:00+00:00"De datum en tijd waarop de betaling is ontvangen.
ontvangen_doorJastring"00000004000000044000"OIN van de organisatie die de betaling heeft ontvangen.
verwerkt_doorJastring"00000004000000044000"OIN van de organisatie die de betaling heeft verwerkt.
bedragJanumber2000Het bedrag van de betaling. Voor gebeurtenis "BetalingVerwerkt" is dat een positief bedrag.

achterstanden

Het is aan de organisatie om te bepalen of er voor een betalingsverplichting een achterstand geldt.

AttribuutVerplichtTypeVoorbeeldOmschrijving
achterstandenJaarray 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.

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
AttribuutVerplichtTypeVoorbeeldOmschrijving
contact_vormJastring"telefoon"Bevat de categorie van de contact optie. Mogelijke waarden:
- "telefoon"
- "e_mail"
- "persoonlijke_website"
- "publieke_website"
urlJastring"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.
naamJastring(25)"Belastingtelefoon"De naam van de contactoptie zoals gebruikt door bronorganisatie. Deze wordt getoond in de UI.
omschrijvingJastring(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.
prioriteitJanumber1Hiermee kan de voorkeurs volgorde worden aangegeven. Hierbij wordt de optie met prioriteit 1 als eerste getoond, 2 als tweede, etc.

Example

t.b.d.