Ga naar hoofdinhoud

Financial claims information document v3.0.0

Status: accepted

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

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.
financiele_zaken	Nee (0..n)	array		Een lijst van financiële zaken. Zie financiele_zaken hieronder voor de specificatie.

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.
omschrijving	Ja	string	"Verkeersboete"	Omschrijving van de financiële zaak, gelijk aan de omschrijving van de primaire financiële verplichting.
totaal_opgelegd	Ja	number	5500	De som van bedragen van alle financiële verplichtingen.
totaal_reeds_betaald	Nee	number	2000	De som van bedragen van alle betalingen die door de burger zijn gedaan.
saldo	Ja	number	3500	Het saldo van totaal_opgelegd minus totaal_reeds_betaald TODO: Correcties zullen later ook in het saldo worden opgenomen.
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.

gebeurtenissen

De lijst gebeurtenissen bevat meerdere typen gebeurtenis-objecten. Elk object heeft een van de volgende typen:

FinancieleVerplichtingOpgelegd
BetalingsverplichtingOpgelegd
BetalingsverplichtingIngetrokken
BetalingVerwerkt

De definitie 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.
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.

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.

Example

{
    "type": "FINANCIAL_CLAIMS_INFORMATION_DOCUMENT",
    "version": "3.0.0",
    "body": {
        "aangeleverd_door": "00000004000000044000",
        "document_datumtijd": "2022-07-13T18:43:12+00:00",
        "bsn": "814859094", //Voorbeeld uit BSN Testset: Piet Verstraten (814859094)
        "financiele_zaken": [
            { 
                "zaakkenmerk": "81029991234567891",
                "omschrijving": "Verkeersboete",
                "totaal_opgelegd": 5500,
                "totaal_reeds_betaald": 2000,
                "saldo": 3500,
                "saldo_datumtijd": "2022-07-13T18:43:12+00:00",
                "gebeurtenissen": [
                    {
                        "gebeurtenis_type": "FinancieleVerplichtingOpgelegd",
                        "gebeurtenis_kenmerk": "81029991234567891-1",
                        "datumtijd_gebeurtenis": "2022-07-12T00:00:00+00:00",
                        "datumtijd_opgelegd": "2022-07-12T00:00:00+00:00",
                        "zaakkenmerk": "81029991234567891",
                        "beschikkingsnummer": "999999991",
                        "bsn": "814859094",
                        "primaire_verplichting": true,
                        "type": "CJIB_WAHV",
                        "categorie": "Algemeen",
                        "bedrag": 4600,
                        "omschrijving": "Kenteken: a-000-aa; 11 km te hard buiten de bebouwde kom op 1 april 2023",
                        "juridische_grondslag_omschrijving": "Boete voor te hard rijden Artikel 21 (RVV 1990)",
                        "juridische_grondslag_bron": "https://wetten.overheid.nl/jci1.3:c:BWBR0004825&hoofdstuk=II&paragraaf=8&artikel=21&z=2023-01-01&g=2023-01-01",
                        "opgelegd_door": "00000004000000044000",
                        "uitgevoerd_door": "00000004000000044000"
                    },
                    {
                        "gebeurtenis_type": "FinancieleVerplichtingOpgelegd",
                        "gebeurtenis_kenmerk": "81029991234567891-2",
                        "datumtijd_gebeurtenis": "2022-07-12T00:00:00+00:00",
                        "datumtijd_opgelegd": "2022-07-12T00:00:00+00:00",
                        "zaakkenmerk": "81029991234567891",
                        "beschikkingsnummer": "999999992",
                        "bsn": "814859094",
                        "primaire_verplichting": false,
                        "type": "CJIB_ADMINISTRATIEKOSTEN",
                        "categorie": "Administratiekosten", 
                        "bedrag": 900,
                        "omschrijving": "Administratiekosten",
                        "juridische_grondslag_omschrijving": "CJIB mag op grond van Artikel 63d van het Organisatiebesluit Ministerie van Justitie en Veiligheid administratiekosten in rekening brengen",
                        "juridische_grondslag_bron": "https://wetten.overheid.nl/BWBR0045971/2021-12-03/0",
                        "opgelegd_door": "00000004000000044000",
                        "uitgevoerd_door": "00000004000000044000"
                    },
                    {
                        "gebeurtenis_type": "BetalingsVerplichtingOpgelegd",
                        "gebeurtenis_kenmerk": "81029991234567891-3",
                        "datumtijd_gebeurtenis": "2022-08-12T00:00:00+00:00", 
                        "datumtijd_opgelegd": "2022-08-12T00:00:00+00:00", 
                        "zaakkenmerk": "81029991234567891",
                        "bsn": "814859094",
                        "bedrag": 3500,
                        "betaalwijze": "Handmatig",
                        "te_betalen_aan": "00000004000000044000",
                        "rekeningnummer": "GB33BUKB20201555555555", //Uit IBAN testset: https://nl.iban.com/testibans
                        "rekeningnummer_tenaamstelling": "CJIB",
                        "betalingskenmerk": "81029991234567891", //Hoeft niet noodzakelijkerwijs gelijk te zijn aan zaakkenmerk
                        "vervaldatum": "2022-09-13T00:00:00+00:00"
                    },
                    {
                        "gebeurtenis_type": "BetalingVerwerkt",
                        "gebeurtenis_kenmerk": "81029991234567891-4",
                        "datumtijd_verwerkt": "2022-07-21T00:00:00+00:00", 
                        "betalingskenmerk": "81029991234567891",
                        "datumtijd_ontvangen": "2022-07-20T00:00:00+00:00", 
                        "ontvangen_door": "00000004000000044000",
                        "verwerkt_door": "00000004000000044000",
                        "bedrag": 2000
                    }
                ],
                "achterstanden": ["81029991234567891-3"]
            }
        ],
        
    }
}

Omschrijving
Structuur
Example